mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
dc815780a6 | ||
|
|
636840a553 | ||
|
|
c65c9e0cae | ||
|
|
95df2396e7 | ||
|
|
f52d81d1f6 |
File diff suppressed because one or more lines are too long
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
go:
|
||||
version: 0.11.14
|
||||
version: 0.15.0
|
||||
additionalDependencies: {}
|
||||
allowUnknownFieldsInWeakUnions: false
|
||||
clientServerStatusCodesAsErrors: true
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.399.2
|
||||
speakeasyVersion: 1.406.0
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,8 +9,8 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:327e4a83099f910e042784ecc571fcbc4c9a6d8ba169b4ba181afb890a9936cc
|
||||
sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
|
||||
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
|
||||
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
|
||||
tags:
|
||||
- latest
|
||||
- main
|
||||
@@ -18,10 +18,10 @@ targets:
|
||||
plexgo:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:327e4a83099f910e042784ecc571fcbc4c9a6d8ba169b4ba181afb890a9936cc
|
||||
sourceBlobDigest: sha256:a652fa39754f0c22a1454f628fe84983b34662ee8a153a3461d50b833f8bc5c2
|
||||
sourceRevisionDigest: sha256:c6ab8f13847c7cdc4ab3752f517164d7da08266726255aa0d614b1eaea66fb0e
|
||||
sourceBlobDigest: sha256:64c7694915a0828aeb256d10d2fa0ea477681785b818916b6681be8cc5ffb93b
|
||||
codeSamplesNamespace: code-samples-go-plexgo
|
||||
codeSamplesRevisionDigest: sha256:4c8c0f04287fab8c7e38d97036bd7445df35a0428b0be13df8fc4f642e87b0ca
|
||||
codeSamplesRevisionDigest: sha256:9ae03dbe12a6438ac7667de48bf864bbeb4b470bd87b38555484879a998889ba
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
181
README.md
181
README.md
@@ -11,6 +11,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] -->
|
||||
@@ -19,7 +44,6 @@ Plex-API: An Open API Spec for interacting with Plex.tv and Plex Media Server
|
||||
* [SDK Installation](#sdk-installation)
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Global Parameters](#global-parameters)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
@@ -54,11 +78,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -103,18 +127,20 @@ func main() {
|
||||
### [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
|
||||
* [GetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [GetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [GetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [GetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [GetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [GetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [GetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
@@ -226,11 +252,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -280,11 +306,11 @@ func main() {
|
||||
RetryConnectionErrors: false,
|
||||
}),
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -303,13 +329,17 @@ func main() {
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
By Default, an API error will return `sdkerrors.SDKError`. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation.
|
||||
|
||||
For example, the `GetServerCapabilities` function may return the following errors:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
|
||||
| sdkerrors.GetServerCapabilitiesBadRequest | 400 | application/json |
|
||||
| sdkerrors.GetServerCapabilitiesUnauthorized | 401 | application/json |
|
||||
| sdkerrors.SDKError | 4xx-5xx | */* |
|
||||
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
|
||||
|
||||
### Example
|
||||
|
||||
@@ -327,11 +357,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -387,11 +417,11 @@ func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithServerIndex(0),
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -429,11 +459,11 @@ func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithServerURL("{protocol}://{ip}:{port}"),
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -464,15 +494,15 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Plex.GetCompanionsData(ctx, operations.WithServerURL("https://plex.tv/api/v2/"))
|
||||
res, err := s.Plex.GetCompanionsData(ctx, operations.WithServerURL("https://plex.tv/api/v2"))
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
@@ -537,11 +567,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
@@ -583,65 +613,6 @@ d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on
|
||||
```
|
||||
<!-- End Special Types [types] -->
|
||||
|
||||
<!-- Start Global Parameters [global-parameters] -->
|
||||
## Global Parameters
|
||||
|
||||
Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.
|
||||
|
||||
For example, you can set `ClientID` to `"gcgzw5rz2xovp84b4vha3a40"` at SDK initialization and then you do not have to pass the same value on calls to operations like `GetServerResources`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
|
||||
|
||||
|
||||
### Available Globals
|
||||
|
||||
The following global parameters are available.
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
| ---- | ---- |:--------:| ----------- |
|
||||
| ClientID | string | | The unique identifier for the client application
|
||||
This is used to track the client application and its usage
|
||||
(UUID, serial number, or other number unique per device)
|
||||
|
|
||||
| ClientName | string | | The ClientName parameter. |
|
||||
| ClientVersion | string | | The ClientVersion parameter. |
|
||||
| ClientPlatform | string | | The ClientPlatform parameter. |
|
||||
| DeviceName | string | | The DeviceName parameter. |
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"github.com/LukeHagar/plexgo"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"log"
|
||||
)
|
||||
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
res, err := s.Plex.GetServerResources(ctx, plexgo.String("gcgzw5rz2xovp84b4vha3a40"), operations.IncludeHTTPSOne.ToPointer(), operations.IncludeRelayOne.ToPointer(), operations.IncludeIPv6One.ToPointer())
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
if res.PlexDevices != nil {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
<!-- End Global Parameters [global-parameters] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
50
RELEASES.md
50
RELEASES.md
@@ -893,3 +893,53 @@ Based on:
|
||||
- [go v0.11.14] .
|
||||
### Releases
|
||||
- [Go v0.11.14] https://github.com/LukeHagar/plexgo/releases/tag/v0.11.14 - .
|
||||
|
||||
## 2024-09-21 00:08:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.12.0] .
|
||||
### Releases
|
||||
- [Go v0.12.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.12.0 - .
|
||||
|
||||
## 2024-09-22 00:09:45
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.401.2 (2.421.3) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.12.1] .
|
||||
### Releases
|
||||
- [Go v0.12.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.12.1 - .
|
||||
|
||||
## 2024-09-26 00:09:00
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.402.14 (2.422.22) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.13.0] .
|
||||
### Releases
|
||||
- [Go v0.13.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.13.0 - .
|
||||
|
||||
## 2024-10-01 00:10:01
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.14.0] .
|
||||
### Releases
|
||||
- [Go v0.14.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.14.0 - .
|
||||
|
||||
## 2024-10-03 00:09:11
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [go v0.15.0] .
|
||||
### Releases
|
||||
- [Go v0.15.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.15.0 - .
|
||||
10
USAGE.md
10
USAGE.md
@@ -11,11 +11,11 @@ import (
|
||||
func main() {
|
||||
s := plexgo.New(
|
||||
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
|
||||
plexgo.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
|
||||
plexgo.WithClientName("Plex Web"),
|
||||
plexgo.WithClientVersion("4.133.0"),
|
||||
plexgo.WithClientPlatform("Chrome"),
|
||||
plexgo.WithDeviceName("Linux"),
|
||||
plexgo.WithClientID("3381b62b-9ab7-4e37-827b-203e9809eb58"),
|
||||
plexgo.WithClientName("Plex for Roku"),
|
||||
plexgo.WithClientVersion("2.4.1"),
|
||||
plexgo.WithPlatform("Roku"),
|
||||
plexgo.WithDeviceNickname("Roku 3"),
|
||||
)
|
||||
|
||||
ctx := context.Background()
|
||||
|
||||
@@ -10,6 +10,7 @@ import (
|
||||
"github.com/LukeHagar/plexgo/internal/utils"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"github.com/LukeHagar/plexgo/models/sdkerrors"
|
||||
"github.com/LukeHagar/plexgo/retry"
|
||||
"github.com/cenkalti/backoff/v4"
|
||||
"io"
|
||||
"net/http"
|
||||
@@ -88,6 +89,16 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -96,11 +107,7 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -334,6 +341,16 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -342,11 +359,7 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
|
||||
@@ -10,6 +10,7 @@ import (
|
||||
"github.com/LukeHagar/plexgo/internal/utils"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"github.com/LukeHagar/plexgo/models/sdkerrors"
|
||||
"github.com/LukeHagar/plexgo/retry"
|
||||
"github.com/cenkalti/backoff/v4"
|
||||
"io"
|
||||
"net/http"
|
||||
@@ -91,6 +92,16 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -99,11 +110,7 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -321,6 +328,16 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -329,11 +346,7 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -547,6 +560,16 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -555,11 +578,7 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -736,7 +755,7 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
|
||||
|
||||
// PostUsersSignInData - Get User Sign In Data
|
||||
// Sign in user with username and password and return user data with Plex authentication token
|
||||
func (s *Authentication) PostUsersSignInData(ctx context.Context, clientID *string, requestBody *operations.PostUsersSignInDataRequestBody, opts ...operations.Option) (*operations.PostUsersSignInDataResponse, error) {
|
||||
func (s *Authentication) PostUsersSignInData(ctx context.Context, request operations.PostUsersSignInDataRequest, opts ...operations.Option) (*operations.PostUsersSignInDataResponse, error) {
|
||||
hookCtx := hooks.HookContext{
|
||||
Context: ctx,
|
||||
OperationID: "post-users-sign-in-data",
|
||||
@@ -744,13 +763,12 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, clientID *stri
|
||||
SecuritySource: nil,
|
||||
}
|
||||
|
||||
request := operations.PostUsersSignInDataRequest{
|
||||
ClientID: clientID,
|
||||
RequestBody: requestBody,
|
||||
}
|
||||
|
||||
globals := operations.PostUsersSignInDataGlobals{
|
||||
ClientID: s.sdkConfiguration.Globals.ClientID,
|
||||
ClientName: s.sdkConfiguration.Globals.ClientName,
|
||||
DeviceNickname: s.sdkConfiguration.Globals.DeviceNickname,
|
||||
ClientVersion: s.sdkConfiguration.Globals.ClientVersion,
|
||||
Platform: s.sdkConfiguration.Globals.Platform,
|
||||
}
|
||||
|
||||
o := operations.Options{}
|
||||
@@ -800,15 +818,23 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, clientID *stri
|
||||
req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent)
|
||||
req.Header.Set("Content-Type", reqContentType)
|
||||
|
||||
if err := utils.PopulateQueryParams(ctx, req, request, globals); err != nil {
|
||||
return nil, fmt.Errorf("error populating query params: %w", err)
|
||||
}
|
||||
utils.PopulateHeaders(ctx, req, request, globals)
|
||||
|
||||
globalRetryConfig := s.sdkConfiguration.RetryConfig
|
||||
retryConfig := o.Retries
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -817,11 +843,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, clientID *stri
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
|
||||
81
butler.go
81
butler.go
@@ -10,6 +10,7 @@ import (
|
||||
"github.com/LukeHagar/plexgo/internal/utils"
|
||||
"github.com/LukeHagar/plexgo/models/operations"
|
||||
"github.com/LukeHagar/plexgo/models/sdkerrors"
|
||||
"github.com/LukeHagar/plexgo/retry"
|
||||
"github.com/cenkalti/backoff/v4"
|
||||
"io"
|
||||
"net/http"
|
||||
@@ -82,6 +83,16 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -90,11 +101,7 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -328,6 +335,16 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -336,11 +353,7 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -549,6 +562,16 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -557,11 +580,7 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -778,6 +797,16 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -786,11 +815,7 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
@@ -1005,6 +1030,16 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
|
||||
if retryConfig == nil {
|
||||
if globalRetryConfig != nil {
|
||||
retryConfig = globalRetryConfig
|
||||
} else {
|
||||
retryConfig = &retry.Config{
|
||||
Strategy: "backoff", Backoff: &retry.BackoffStrategy{
|
||||
InitialInterval: 500,
|
||||
MaxInterval: 60000,
|
||||
Exponent: 1.5,
|
||||
MaxElapsedTime: 3600000,
|
||||
},
|
||||
RetryConnectionErrors: true,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1013,11 +1048,7 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
|
||||
httpRes, err = utils.Retry(ctx, utils.Retries{
|
||||
Config: retryConfig,
|
||||
StatusCodes: []string{
|
||||
"429",
|
||||
"500",
|
||||
"502",
|
||||
"503",
|
||||
"504",
|
||||
"5XX",
|
||||
},
|
||||
}, func() (*http.Response, error) {
|
||||
if req.Body != nil {
|
||||
|
||||
887
codeSamples.yaml
887
codeSamples.yaml
File diff suppressed because it is too large
Load Diff
9
docs/models/operations/action.md
Normal file
9
docs/models/operations/action.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Action
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
|
||||
| `ID` | *string* | :heavy_check_mark: | N/A | addToContinueWatching |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /actions/addToContinueWatching |
|
||||
12
docs/models/operations/activedirection.md
Normal file
12
docs/models/operations/activedirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# ActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `ActiveDirectionAscending` | asc |
|
||||
| `ActiveDirectionDescending` | desc |
|
||||
@@ -6,6 +6,6 @@ The auto-select subtitle mode (0 = Manually selected, 1 = Shown with foreign aud
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------ | ------------------------ |
|
||||
| `AutoSelectSubtitleZero` | 0 |
|
||||
| `AutoSelectSubtitleOne` | 1 |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `AutoSelectSubtitleDisable` | 0 |
|
||||
| `AutoSelectSubtitleEnable` | 1 |
|
||||
8
docs/models/operations/collection.md
Normal file
8
docs/models/operations/collection.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Collection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
@@ -3,12 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Protocol` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Address` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Port` | *float64* | :heavy_check_mark: | N/A |
|
||||
| `URI` | *string* | :heavy_check_mark: | N/A |
|
||||
| `Local` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `Relay` | *bool* | :heavy_check_mark: | N/A |
|
||||
| `IPv6` | *bool* | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `Protocol` | [operations.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` | *bool* | :heavy_check_mark: | If the connection is local address | |
|
||||
| `Relay` | *bool* | :heavy_check_mark: | If the connection is relayed through plex.direct | |
|
||||
| `IPv6` | *bool* | :heavy_check_mark: | If the connection is using IPv6 | |
|
||||
12
docs/models/operations/defaultdirection.md
Normal file
12
docs/models/operations/defaultdirection.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# DefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------- | ---------------------------- |
|
||||
| `DefaultDirectionAscending` | asc |
|
||||
| `DefaultDirectionDescending` | desc |
|
||||
@@ -1,11 +1,11 @@
|
||||
# DefaultSubtitleAccessibility
|
||||
|
||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only shown non-SDH subtitles)
|
||||
The subtitles for the deaf or hard-of-hearing (SDH) searches mode (0 = Prefer non-SDH subtitles, 1 = Prefer SDH subtitles, 2 = Only show SDH subtitles, 3 = Only show non-SDH subtitles)
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------- | ---------------------------------- |
|
||||
| `DefaultSubtitleAccessibilityZero` | 0 |
|
||||
| `DefaultSubtitleAccessibilityOne` | 1 |
|
||||
| ------------------------------------- | ------------------------------------- |
|
||||
| `DefaultSubtitleAccessibilityDisable` | 0 |
|
||||
| `DefaultSubtitleAccessibilityEnable` | 1 |
|
||||
@@ -6,6 +6,6 @@ The forced subtitles searches mode (0 = Prefer non-forced subtitles, 1 = Prefer
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `DefaultSubtitleForcedZero` | 0 |
|
||||
| `DefaultSubtitleForcedOne` | 1 |
|
||||
| ------------------------------ | ------------------------------ |
|
||||
| `DefaultSubtitleForcedDisable` | 0 |
|
||||
| `DefaultSubtitleForcedEnable` | 1 |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Peyton Reed |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
@@ -3,8 +3,12 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A |
|
||||
| `Directory` | [][operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md) | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | |
|
||||
| `Flavor` | **string* | :heavy_minus_sign: | N/A | global |
|
||||
| `ScrobbleKey` | **string* | :heavy_minus_sign: | N/A | /:/scrobble/new |
|
||||
| `UnscrobbleKey` | **string* | :heavy_minus_sign: | N/A | /:/unscrobble/new |
|
||||
| `Directory` | [][operations.GetMediaProvidersDirectory](../../models/operations/getmediaprovidersdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Action` | [][operations.Action](../../models/operations/action.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,66 +0,0 @@
|
||||
# Features
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------------- | --------------------------------------------- |
|
||||
| `FeaturesAndroidDolbyVision` | Android - Dolby Vision |
|
||||
| `FeaturesAndroidPiP` | Android - PiP |
|
||||
| `FeaturesCuSunset` | CU Sunset |
|
||||
| `FeaturesHrkEnableEur` | HRK_enable_EUR |
|
||||
| `FeaturesTrebleShowFeatures` | TREBLE-show-features |
|
||||
| `FeaturesAdCountdownTimer` | ad-countdown-timer |
|
||||
| `FeaturesAdaptiveBitrate` | adaptive_bitrate |
|
||||
| `FeaturesAmazonLoopDebug` | amazon-loop-debug |
|
||||
| `FeaturesAvodAdAnalysis` | avod-ad-analysis |
|
||||
| `FeaturesAvodNewMedia` | avod-new-media |
|
||||
| `FeaturesBlacklistGetSignin` | blacklist_get_signin |
|
||||
| `FeaturesClientRadioStations` | client-radio-stations |
|
||||
| `FeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
|
||||
| `FeaturesCollections` | collections |
|
||||
| `FeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
|
||||
| `FeaturesCommunityAccessPlexTv` | community_access_plex_tv |
|
||||
| `FeaturesCompanionsSonos` | companions_sonos |
|
||||
| `FeaturesCustomHomeRemoval` | custom-home-removal |
|
||||
| `FeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
|
||||
| `FeaturesDisableSharingFriendships` | disable_sharing_friendships |
|
||||
| `FeaturesDrmSupport` | drm_support |
|
||||
| `FeaturesExcludeRestrictions` | exclude restrictions |
|
||||
| `FeaturesFederatedAuth` | federated-auth |
|
||||
| `FeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
|
||||
| `FeaturesGuidedUpgrade` | guided-upgrade |
|
||||
| `FeaturesHome` | home |
|
||||
| `FeaturesIncreasePasswordComplexity` | increase-password-complexity |
|
||||
| `FeaturesIos14PrivacyBanner` | ios14-privacy-banner |
|
||||
| `FeaturesIterableNotificationTokens` | iterable-notification-tokens |
|
||||
| `FeaturesKeepPaymentMethod` | keep-payment-method |
|
||||
| `FeaturesKevinBacon` | kevin-bacon |
|
||||
| `FeaturesKoreaConsent` | korea-consent |
|
||||
| `FeaturesLeIsrgRootX1` | le_isrg_root_x1 |
|
||||
| `FeaturesLetsEncrypt` | lets_encrypt |
|
||||
| `FeaturesLightningDvrPivot` | lightning-dvr-pivot |
|
||||
| `FeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
|
||||
| `FeaturesLivetv` | livetv |
|
||||
| `FeaturesMetadataSearch` | metadata_search |
|
||||
| `FeaturesNewPlexPassPrices` | new_plex_pass_prices |
|
||||
| `FeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
|
||||
| `FeaturesPhotosFavorites` | photos-favorites |
|
||||
| `FeaturesPhotosMetadataEdition` | photos-metadata-edition |
|
||||
| `FeaturesPmsHealth` | pms_health |
|
||||
| `FeaturesRadio` | radio |
|
||||
| `FeaturesRateLimitClientToken` | rate-limit-client-token |
|
||||
| `FeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
|
||||
| `FeaturesSharedServerNotification` | shared_server_notification |
|
||||
| `FeaturesSharedSourceNotification` | shared_source_notification |
|
||||
| `FeaturesSigninWithApple` | signin_with_apple |
|
||||
| `FeaturesSpringServeAdProvider` | spring_serve_ad_provider |
|
||||
| `FeaturesTranscoderCache` | transcoder_cache |
|
||||
| `FeaturesTunerSharing` | tuner-sharing |
|
||||
| `FeaturesTwoFactorAuthentication` | two-factor-authentication |
|
||||
| `FeaturesUnsupportedtuners` | unsupportedtuners |
|
||||
| `FeaturesUpgrade3ds2` | upgrade-3ds2 |
|
||||
| `FeaturesVodSchema` | vod-schema |
|
||||
| `FeaturesVodCloudflare` | vod_cloudflare |
|
||||
| `FeaturesWatchTogetherInvite` | watch-together-invite |
|
||||
| `FeaturesWebServerDashboard` | web_server_dashboard |
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | label |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Label |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | tag |
|
||||
| `SubType` | **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` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | resolution |
|
||||
| `Operator` | [][operations.Operator](../../models/operations/operator.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `Operator` | [][operations.Operator](../../models/operations/operator.md) | :heavy_check_mark: | N/A | |
|
||||
9
docs/models/operations/flattenseasons.md
Normal file
9
docs/models/operations/flattenseasons.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# FlattenSeasons
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------- | --------------------- |
|
||||
| `FlattenSeasonsFalse` | 0 |
|
||||
| `FlattenSeasonsTrue` | 1 |
|
||||
@@ -5,4 +5,4 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Comedy |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
@@ -4,25 +4,25 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Composite` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `Filters` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Refreshing` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `Agent` | **string* | :heavy_minus_sign: | N/A | tv.plex.agents.movie |
|
||||
| `Scanner` | **string* | :heavy_minus_sign: | N/A | Plex Movie |
|
||||
| `Language` | **string* | :heavy_minus_sign: | N/A | en-US |
|
||||
| `UUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `CreatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `ScannedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime | 1556281940 |
|
||||
| `Content` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Directory` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `ContentChangedAt` | **int* | :heavy_minus_sign: | N/A | 3192854 |
|
||||
| `Hidden` | **int* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_minus_sign: | N/A | |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `Filters` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Refreshing` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `Agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `Scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `Language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||
| `UUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `UpdatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `CreatedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `ScannedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Content` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Directory` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `ContentChangedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `Hidden` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `Location` | [][operations.GetAllLibrariesLocation](../../models/operations/getalllibrarieslocation.md) | :heavy_check_mark: | N/A | |
|
||||
9
docs/models/operations/getalllibrarieslocation.md
Normal file
9
docs/models/operations/getalllibrarieslocation.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetAllLibrariesLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `Path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||
@@ -8,4 +8,4 @@
|
||||
| `Size` | *int* | :heavy_check_mark: | N/A | 5 |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||
| `Directory` | [][operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Directory` | [][operations.GetAllLibrariesDirectory](../../models/operations/getalllibrariesdirectory.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -6,5 +6,5 @@ The libraries available on the Server
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [*operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `MediaContainer` | [operations.GetAllLibrariesMediaContainer](../../models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |
|
||||
@@ -10,4 +10,4 @@
|
||||
| `Height` | *int64* | :heavy_check_mark: | N/A | 396 |
|
||||
| `MinSize` | *int64* | :heavy_check_mark: | N/A | 1 |
|
||||
| `Upscale` | *int64* | :heavy_check_mark: | N/A | 1 |
|
||||
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| `XPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
11
docs/models/operations/getlibrarydetailsfield.md
Normal file
11
docs/models/operations/getlibrarydetailsfield.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryDetailsField
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | label |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Label |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | tag |
|
||||
| `SubType` | **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` | **string* | :heavy_minus_sign: | N/A | resolution |
|
||||
| `Operator` | [][operations.GetLibraryDetailsOperator](../../models/operations/getlibrarydetailsoperator.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -19,4 +19,4 @@
|
||||
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `Directory` | [][operations.GetLibraryDetailsDirectory](../../models/operations/getlibrarydetailsdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Type` | [][operations.GetLibraryDetailsType](../../models/operations/getlibrarydetailstype.md) | :heavy_minus_sign: | N/A | |
|
||||
| `FieldType` | [][operations.FieldType](../../models/operations/fieldtype.md) | :heavy_minus_sign: | N/A | |
|
||||
| `FieldType` | [][operations.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` | **string* | :heavy_minus_sign: | N/A | = |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | is |
|
||||
@@ -5,5 +5,5 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `IncludeDetails` | [*operations.IncludeDetails](../../models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
13
docs/models/operations/getlibrarydetailssort.md
Normal file
13
docs/models/operations/getlibrarydetailssort.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetLibraryDetailsSort
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `DefaultDirection` | **string* | :heavy_minus_sign: | N/A | desc |
|
||||
| `DescKey` | **string* | :heavy_minus_sign: | N/A | random:desc |
|
||||
| `FirstCharacterKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/1/firstCharacter |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | random |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Randomly |
|
||||
@@ -10,5 +10,5 @@
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Filter` | [][operations.GetLibraryDetailsFilter](../../models/operations/getlibrarydetailsfilter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Sort` | [][operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Field` | [][operations.Field](../../models/operations/field.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Sort` | [][operations.GetLibraryDetailsSort](../../models/operations/getlibrarydetailssort.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Field` | [][operations.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 |
|
||||
| ------------------------------------------ | ------------------------------------------ |
|
||||
| `GetLibraryItemsActiveDirectionAscending` | asc |
|
||||
| `GetLibraryItemsActiveDirectionDescending` | 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` | **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 |
|
||||
| ------------------------------------------- | ------------------------------------------- |
|
||||
| `GetLibraryItemsDefaultDirectionAscending` | asc |
|
||||
| `GetLibraryItemsDefaultDirectionDescending` | desc |
|
||||
11
docs/models/operations/getlibraryitemsfield.md
Normal file
11
docs/models/operations/getlibraryitemsfield.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryItemsField
|
||||
|
||||
|
||||
## 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` | **string* | :heavy_minus_sign: | N/A | rating |
|
||||
9
docs/models/operations/getlibraryitemsfieldtype.md
Normal file
9
docs/models/operations/getlibraryitemsfieldtype.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetLibraryItemsFieldType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `Operator` | [][operations.GetLibraryItemsOperator](../../models/operations/getlibraryitemsoperator.md) | :heavy_check_mark: | N/A | |
|
||||
12
docs/models/operations/getlibraryitemsfilter.md
Normal file
12
docs/models/operations/getlibraryitemsfilter.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# GetLibraryItemsFilter
|
||||
|
||||
|
||||
## 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/getlibraryitemsflattenseasons.md
Normal file
9
docs/models/operations/getlibraryitemsflattenseasons.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetLibraryItemsFlattenSeasons
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------------ | ------------------------------------ |
|
||||
| `GetLibraryItemsFlattenSeasonsFalse` | 0 |
|
||||
| `GetLibraryItemsFlattenSeasonsTrue` | 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 |
|
||||
| ---------------------------------- | ---------------------------------- |
|
||||
| `GetLibraryItemsHasThumbnailFalse` | 0 |
|
||||
| `GetLibraryItemsHasThumbnailTrue` | 1 |
|
||||
10
docs/models/operations/getlibraryitemsimage.md
Normal file
10
docs/models/operations/getlibraryitemsimage.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsImage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `Type` | [operations.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 |
|
||||
| ------------------------------------------------- | ------------------------------------------------- |
|
||||
| `GetLibraryItemsLibraryActiveDirectionAscending` | asc |
|
||||
| `GetLibraryItemsLibraryActiveDirectionDescending` | desc |
|
||||
@@ -0,0 +1,12 @@
|
||||
# GetLibraryItemsLibraryDefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------------------------------------------- | -------------------------------------------------- |
|
||||
| `GetLibraryItemsLibraryDefaultDirectionAscending` | asc |
|
||||
| `GetLibraryItemsLibraryDefaultDirectionDescending` | 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` | **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` | [][operations.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 |
|
||||
| -------------------------------------------------- | -------------------------------------------------- |
|
||||
| `GetLibraryItemsLibraryResponse200TypeCoverPoster` | coverPoster |
|
||||
| `GetLibraryItemsLibraryResponse200TypeBackground` | background |
|
||||
| `GetLibraryItemsLibraryResponse200TypeSnapshot` | snapshot |
|
||||
| `GetLibraryItemsLibraryResponse200TypeClearLogo` | clearLogo |
|
||||
14
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
14
docs/models/operations/getlibraryitemslibraryresponsetype.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsLibraryResponseType
|
||||
|
||||
|
||||
## 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` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Filter` | [][operations.GetLibraryItemsLibraryFilter](../../models/operations/getlibraryitemslibraryfilter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Sort` | [][operations.GetLibraryItemsLibrarySort](../../models/operations/getlibraryitemslibrarysort.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Field` | [][operations.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` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `ActiveDirection` | [*operations.GetLibraryItemsLibraryActiveDirection](../../models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `DefaultDirection` | [*operations.GetLibraryItemsLibraryDefaultDirection](../../models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `DescKey` | **string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `FirstCharacterKey` | **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/getlibraryitemslibrarytype.md
Normal file
14
docs/models/operations/getlibraryitemslibrarytype.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsLibraryType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------------------- | ----------------------------------- |
|
||||
| `GetLibraryItemsLibraryTypeMovie` | movie |
|
||||
| `GetLibraryItemsLibraryTypeTvShow` | show |
|
||||
| `GetLibraryItemsLibraryTypeSeason` | season |
|
||||
| `GetLibraryItemsLibraryTypeEpisode` | episode |
|
||||
8
docs/models/operations/getlibraryitemslocation.md
Normal file
8
docs/models/operations/getlibraryitemslocation.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsLocation
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Path` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
@@ -4,18 +4,22 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 119534 |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `Height` | **int* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `AudioChannels` | **int* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `VideoResolution` | **string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `Container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `Part` | [][operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md) | :heavy_minus_sign: | N/A | |
|
||||
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `OptimizedForStreaming` | [*operations.GetLibraryItemsOptimizedForStreaming](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Part` | [][operations.GetLibraryItemsPart](../../models/operations/getlibraryitemspart.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -1,23 +1,33 @@
|
||||
# GetLibraryItemsMediaContainer
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `Size` | **int* | :heavy_minus_sign: | N/A | 70 |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `LibrarySectionID` | [*operations.LibrarySectionID](../../models/operations/librarysectionid.md) | :heavy_minus_sign: | N/A | |
|
||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `MediaTagVersion` | **int* | :heavy_minus_sign: | N/A | 1701731894 |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /:/resources/movie.png |
|
||||
| `Title1` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `Title2` | **string* | :heavy_minus_sign: | N/A | Recently Released |
|
||||
| `ViewGroup` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `Type` | [][operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md) | :heavy_minus_sign: | N/A | |
|
||||
| `FieldType` | [][operations.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 |
|
||||
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `Nocache` | **bool* | :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` | *int64* | :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/ |
|
||||
| `MediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
|
||||
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `Title1` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `Title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
|
||||
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `ViewMode` | **int* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_check_mark: | N/A | |
|
||||
| `Meta` | [*operations.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` | [][operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_minus_sign: | N/A |
|
||||
| `FieldType` | [][operations.GetLibraryItemsLibraryFieldType](../../models/operations/getlibraryitemslibraryfieldtype.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -5,24 +5,33 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `RatingKey` | **string* | :heavy_minus_sign: | N/A | 58683 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683 |
|
||||
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `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` | **string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Avatar: The Way of Water |
|
||||
| `SkipChildren` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `LibrarySectionID` | **int64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `LibrarySectionKey` | **string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `Type` | [operations.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` | **string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `Summary` | **string* | :heavy_minus_sign: | 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. |
|
||||
| `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` | **float64* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `Year` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `SeasonCount` | **int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `FlattenSeasons` | [*operations.GetLibraryItemsFlattenSeasons](../../models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ShowOrdering` | [*operations.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` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `Banner` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `OriginallyAvailableAt` | [*types.Date](../../types/date.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `AddedAt` | **int* | :heavy_minus_sign: | N/A | 1680457607 |
|
||||
| `UpdatedAt` | **int* | :heavy_minus_sign: | N/A | 1703239236 |
|
||||
| `AddedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `UpdatedAt` | **int64* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
@@ -32,14 +41,22 @@
|
||||
| `GrandparentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `GrandparentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `GrandparentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `ParentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `GrandparentSlug` | **string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `GrandparentArt` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `GrandparentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Media` | [][operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md) | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `Genre` | [][operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Country` | [][operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Director` | [][operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | [][operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Collection` | [][operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Location` | [][operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MediaGUID` | [][operations.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` | [*operations.GetLibraryItemsUltraBlurColors](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `MetaDataRating` | [][operations.GetLibraryItemsMetaDataRating](../../models/operations/getlibraryitemsmetadatarating.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Image` | [][operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md) | :heavy_minus_sign: | N/A | |
|
||||
| `TitleSort` | **string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LastViewedAt` | **int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
@@ -53,7 +70,7 @@
|
||||
| `ChildCount` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `HasPremiumExtras` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `HasPremiumPrimaryExtra` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `ParentRatingKey` | **string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `ParentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `ParentStudio` | **string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
|
||||
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` | *float32* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `Type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
9
docs/models/operations/getlibraryitemsoperator.md
Normal file
9
docs/models/operations/getlibraryitemsoperator.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# GetLibraryItemsOperator
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | = |
|
||||
| `Title` | *string* | :heavy_check_mark: | N/A | is |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetLibraryItemsOptimizedForStreaming
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------------------------- | --------------------------------------------- |
|
||||
| `GetLibraryItemsOptimizedForStreamingDisable` | 0 |
|
||||
| `GetLibraryItemsOptimizedForStreamingEnable` | 1 |
|
||||
@@ -5,10 +5,16 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 119542 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `Size` | **int64* | :heavy_minus_sign: | N/A | 36158371307 |
|
||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `File` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `Size` | *int64* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `Container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `AudioProfile` | **string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `HasThumbnail` | [*operations.GetLibraryItemsHasThumbnail](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Stream` | [][operations.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 |
|
||||
| --------------------------------------------- | --------------------------------------------- |
|
||||
| `GetLibraryItemsQueryParamIncludeMetaDisable` | 0 |
|
||||
| `GetLibraryItemsQueryParamIncludeMetaEnable` | 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 |
|
||||
| -------------------------------------- | -------------------------------------- |
|
||||
| `GetLibraryItemsQueryParamTypeMovie` | 1 |
|
||||
| `GetLibraryItemsQueryParamTypeTvShow` | 2 |
|
||||
| `GetLibraryItemsQueryParamTypeSeason` | 3 |
|
||||
| `GetLibraryItemsQueryParamTypeEpisode` | 4 |
|
||||
@@ -5,10 +5,10 @@
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `Tag` | [operations.Tag](../../models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
|
||||
| `IncludeGuids` | [*operations.IncludeGuids](../../models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
|
||||
| `IncludeMeta` | [*operations.IncludeMeta](../../models/operations/includemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `Type` | [operations.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 |
|
||||
| `Type` | [*operations.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 |
|
||||
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `IncludeMeta` | [*operations.GetLibraryItemsQueryParamIncludeMeta](../../models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `XPlexContainerStart` | **int* | :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` | **int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
@@ -4,5 +4,10 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | N/A | Sigourney Weaver |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `ID` | **int64* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `Filter` | **string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `Tag` | **string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `TagKey` | **string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `Role` | **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 |
|
||||
| --------------------------------------- | --------------------------------------- |
|
||||
| `GetLibraryItemsShowOrderingNone` | None |
|
||||
| `GetLibraryItemsShowOrderingTmdbAiring` | tmdbAiring |
|
||||
| `GetLibraryItemsShowOrderingAired` | aired |
|
||||
| `GetLibraryItemsShowOrderingDvd` | dvd |
|
||||
| `GetLibraryItemsShowOrderingAbsolute` | absolute |
|
||||
15
docs/models/operations/getlibraryitemssort.md
Normal file
15
docs/models/operations/getlibraryitemssort.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetLibraryItemsSort
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `Default` | **string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `Active` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `ActiveDirection` | [*operations.GetLibraryItemsActiveDirection](../../models/operations/getlibraryitemsactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `DefaultDirection` | [*operations.GetLibraryItemsDefaultDirection](../../models/operations/getlibraryitemsdefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `DescKey` | **string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `FirstCharacterKey` | **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` | *int64* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `StreamType` | *int64* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `Default` | **bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `Selected` | **bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `Index` | *int64* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `Bitrate` | **int64* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `ColorSpace` | **string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `ColorTrc` | **string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `BitDepth` | **int64* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `StreamIdentifier` | **string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `CodedHeight` | **int64* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `CodedWidth` | **int64* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `FrameRate` | **float64* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `HearingImpaired` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `ClosedCaptions` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `EmbeddedInVideo` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Height` | **int64* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `Level` | **int64* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `RefFrames` | **int64* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `ScanType` | **string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `Width` | **int64* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `DisplayTitle` | **string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `Channels` | **int64* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `Language` | **string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `AudioChannelLayout` | **string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `SamplingRate` | **int64* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `Title` | **string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `CanAutoSync` | **bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
14
docs/models/operations/getlibraryitemstype.md
Normal file
14
docs/models/operations/getlibraryitemstype.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# GetLibraryItemsType
|
||||
|
||||
|
||||
## 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` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `Filter` | [][operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Sort` | [][operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Field` | [][operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md) | :heavy_minus_sign: | N/A | |
|
||||
11
docs/models/operations/getlibraryitemsultrablurcolors.md
Normal file
11
docs/models/operations/getlibraryitemsultrablurcolors.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetLibraryItemsUltraBlurColors
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `TopLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `TopRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `BottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `BottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
@@ -4,5 +4,5 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
|
||||
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
|
||||
| `XPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |
|
||||
@@ -4,7 +4,7 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `ID` | **int* | :heavy_minus_sign: | N/A | 15 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 |
|
||||
| `Duration` | **int* | :heavy_minus_sign: | N/A | 141417 |
|
||||
@@ -15,4 +15,4 @@
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
|
||||
| `Stream` | [][operations.Stream](../../models/operations/stream.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Stream` | [][operations.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` | **int* | :heavy_minus_sign: | N/A | 29 |
|
||||
| `StreamType` | **int* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `Default` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Codec` | **string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `Index` | **int* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `Bitrate` | **int* | :heavy_minus_sign: | N/A | 128 |
|
||||
| `BitDepth` | **int* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `ChromaLocation` | **string* | :heavy_minus_sign: | N/A | left |
|
||||
| `ChromaSubsampling` | **string* | :heavy_minus_sign: | N/A | 14520 |
|
||||
| `CodedHeight` | **int* | :heavy_minus_sign: | N/A | 816 |
|
||||
| `CodedWidth` | **int* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `ColorPrimaries` | **string* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `ColorRange` | **string* | :heavy_minus_sign: | N/A | tv |
|
||||
| `ColorSpace` | **string* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `ColorTrc` | **string* | :heavy_minus_sign: | N/A | bt709 |
|
||||
| `FrameRate` | **int* | :heavy_minus_sign: | N/A | 24 |
|
||||
| `HasScalingMatrix` | **bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `Height` | **int* | :heavy_minus_sign: | N/A | 814 |
|
||||
| `Level` | **int* | :heavy_minus_sign: | N/A | 40 |
|
||||
| `Profile` | **string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `RefFrames` | **int* | :heavy_minus_sign: | N/A | 4 |
|
||||
| `ScanType` | **string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `StreamIdentifier` | **string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `Width` | **int* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `DisplayTitle` | **string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||
| `ExtendedDisplayTitle` | **string* | :heavy_minus_sign: | N/A | English (AAC Stereo) |
|
||||
| `Selected` | **bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `Channels` | **int* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `Language` | **string* | :heavy_minus_sign: | N/A | English |
|
||||
| `LanguageTag` | **string* | :heavy_minus_sign: | N/A | en |
|
||||
| `LanguageCode` | **string* | :heavy_minus_sign: | N/A | eng |
|
||||
| `SamplingRate` | **int* | :heavy_minus_sign: | N/A | 44100 |
|
||||
@@ -15,7 +15,7 @@
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||
| `ParentKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/30072 |
|
||||
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Reacher |
|
||||
| `Summary` | **string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge. |
|
||||
| `Summary` | **string* | :heavy_minus_sign: | N/A | Based on"Bad Luck and Trouble," when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind-revenge. |
|
||||
| `Index` | **int* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `ParentIndex` | **int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ViewCount` | **int* | :heavy_minus_sign: | N/A | 11 |
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ClientID` | **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` | **string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `ClientID` | **string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `ClientName` | **string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `DeviceNickname` | **string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `ClientVersion` | **string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `Platform` | **string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -4,10 +4,10 @@
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `Strong` | **bool* | :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` | **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` | **string* | :heavy_minus_sign: | N/A | Plex Web |
|
||||
| `DeviceName` | **string* | :heavy_minus_sign: | N/A | Linux |
|
||||
| `ClientVersion` | **string* | :heavy_minus_sign: | N/A | 4.133.0 |
|
||||
| `ClientPlatform` | **string* | :heavy_minus_sign: | N/A | Chrome |
|
||||
| `ClientID` | **string* | :heavy_minus_sign: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
|
||||
| `ClientName` | **string* | :heavy_minus_sign: | The name of the client application. (Plex Web, Plex Media Server, etc.) | Plex for Roku |
|
||||
| `DeviceNickname` | **string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
||||
| `ClientVersion` | **string* | :heavy_minus_sign: | The version of the client application. | 2.4.1 |
|
||||
| `Platform` | **string* | :heavy_minus_sign: | The platform of the client application. | Roku |
|
||||
@@ -12,8 +12,8 @@ E.g. A movie library will not return anything with type 3 as there are no season
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------------- | ---------------------------------------- |
|
||||
| `GetPlaylistContentsQueryParamTypeOne` | 1 |
|
||||
| `GetPlaylistContentsQueryParamTypeTwo` | 2 |
|
||||
| `GetPlaylistContentsQueryParamTypeThree` | 3 |
|
||||
| `GetPlaylistContentsQueryParamTypeFour` | 4 |
|
||||
| ------------------------------------------ | ------------------------------------------ |
|
||||
| `GetPlaylistContentsQueryParamTypeMovie` | 1 |
|
||||
| `GetPlaylistContentsQueryParamTypeTvShow` | 2 |
|
||||
| `GetPlaylistContentsQueryParamTypeSeason` | 3 |
|
||||
| `GetPlaylistContentsQueryParamTypeEpisode` | 4 |
|
||||
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 |
|
||||
| ------------------------------------------- | ------------------------------------------- |
|
||||
| `GetRecentlyAddedActiveDirectionAscending` | asc |
|
||||
| `GetRecentlyAddedActiveDirectionDescending` | 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 |
|
||||
| -------------------------------------------- | -------------------------------------------- |
|
||||
| `GetRecentlyAddedDefaultDirectionAscending` | asc |
|
||||
| `GetRecentlyAddedDefaultDirectionDescending` | 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` | **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` | [][operations.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 |
|
||||
| --------------------------------------------- | --------------------------------------------- |
|
||||
| `GetRecentlyAddedHubsResponseTypeCoverPoster` | coverPoster |
|
||||
| `GetRecentlyAddedHubsResponseTypeBackground` | background |
|
||||
| `GetRecentlyAddedHubsResponseTypeSnapshot` | snapshot |
|
||||
| `GetRecentlyAddedHubsResponseTypeClearLogo` | 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 |
|
||||
| --------------------------------- | --------------------------------- |
|
||||
| `GetRecentlyAddedHubsTypeMovie` | movie |
|
||||
| `GetRecentlyAddedHubsTypeTvShow` | show |
|
||||
| `GetRecentlyAddedHubsTypeSeason` | season |
|
||||
| `GetRecentlyAddedHubsTypeEpisode` | 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` | [operations.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` | **string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
@@ -0,0 +1,8 @@
|
||||
# GetRecentlyAddedLibraryDirector
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `Tag` | **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` | **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` | **float64* | :heavy_minus_sign: | N/A | 120345 |
|
||||
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 7474422 |
|
||||
| `Bitrate` | **float64* | :heavy_minus_sign: | N/A | 3623 |
|
||||
| `Width` | **float64* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `Height` | **float64* | :heavy_minus_sign: | N/A | 804 |
|
||||
| `AspectRatio` | **float64* | :heavy_minus_sign: | N/A | 2.35 |
|
||||
| `AudioChannels` | **float64* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `AudioCodec` | **string* | :heavy_minus_sign: | N/A | ac3 |
|
||||
| `VideoCodec` | **string* | :heavy_minus_sign: | N/A | h264 |
|
||||
| `VideoResolution` | **float64* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `OptimizedForStreaming` | **float64* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | high |
|
||||
| `Part` | [][operations.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` | [][operations.GetRecentlyAddedLibraryType](../../models/operations/getrecentlyaddedlibrarytype.md) | :heavy_minus_sign: | N/A | |
|
||||
| `FieldType` | [][operations.FieldType](../../models/operations/fieldtype.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Size` | **float64* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `AllowSync` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `Identifier` | **string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `MediaTagPrefix` | **string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `MediaTagVersion` | **float64* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||
| `MixedParents` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `Metadata` | [][operations.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` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `LibrarySectionID` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `LibrarySectionTitle` | **string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `LibrarySectionUUID` | **string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `RatingKey` | **float64* | :heavy_minus_sign: | N/A | 59398 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59398 |
|
||||
| `GUID` | **string* | :heavy_minus_sign: | N/A | plex://movie/5e161a83bea6ac004126e148 |
|
||||
| `Studio` | **string* | :heavy_minus_sign: | N/A | Marvel Studios |
|
||||
| `Type` | **string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `Title` | **string* | :heavy_minus_sign: | N/A | Ant-Man and the Wasp: Quantumania |
|
||||
| `ContentRating` | **string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `Summary` | **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` | **float64* | :heavy_minus_sign: | N/A | 4.7 |
|
||||
| `AudienceRating` | **float64* | :heavy_minus_sign: | N/A | 8.3 |
|
||||
| `Year` | **float64* | :heavy_minus_sign: | N/A | 2023 |
|
||||
| `Tagline` | **string* | :heavy_minus_sign: | N/A | Witness the beginning of a new dynasty. |
|
||||
| `Thumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59398/thumb/1681888010 |
|
||||
| `Art` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59398/art/1681888010 |
|
||||
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 7474422 |
|
||||
| `OriginallyAvailableAt` | [*time.Time](https://pkg.go.dev/time#Time) | :heavy_minus_sign: | N/A | 2023-02-15 00:00:00 +0000 UTC |
|
||||
| `AddedAt` | **float64* | :heavy_minus_sign: | N/A | 1681803215 |
|
||||
| `UpdatedAt` | **float64* | :heavy_minus_sign: | N/A | 1681888010 |
|
||||
| `AudienceRatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `ChapterSource` | **string* | :heavy_minus_sign: | N/A | media |
|
||||
| `PrimaryExtraKey` | **string* | :heavy_minus_sign: | N/A | /library/metadata/59399 |
|
||||
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.rotten |
|
||||
| `Media` | [][operations.GetRecentlyAddedLibraryMedia](../../models/operations/getrecentlyaddedlibrarymedia.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Genre` | [][operations.GetRecentlyAddedLibraryGenre](../../models/operations/getrecentlyaddedlibrarygenre.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Director` | [][operations.GetRecentlyAddedLibraryDirector](../../models/operations/getrecentlyaddedlibrarydirector.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Writer` | [][operations.GetRecentlyAddedLibraryWriter](../../models/operations/getrecentlyaddedlibrarywriter.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Country` | [][operations.GetRecentlyAddedLibraryCountry](../../models/operations/getrecentlyaddedlibrarycountry.md) | :heavy_minus_sign: | N/A | |
|
||||
| `Role` | [][operations.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` | **float64* | :heavy_minus_sign: | N/A | 120353 |
|
||||
| `Key` | **string* | :heavy_minus_sign: | N/A | /library/parts/120353/1681803203/file.mp4 |
|
||||
| `Duration` | **float64* | :heavy_minus_sign: | N/A | 7474422 |
|
||||
| `File` | **string* | :heavy_minus_sign: | N/A | /movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4 |
|
||||
| `Size` | **float64* | :heavy_minus_sign: | N/A | 3395307162 |
|
||||
| `Container` | **string* | :heavy_minus_sign: | N/A | mp4 |
|
||||
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `HasThumbnail` | **float64* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `OptimizedForStreaming` | **bool* | :heavy_minus_sign: | N/A | |
|
||||
| `VideoProfile` | **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` | **int64* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `PinnedContentDirectoryID` | []*int64* | :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` | **int64* | :heavy_minus_sign: | The library section ID for filtering content. | 2 |
|
||||
| `Type` | [operations.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` | [*operations.QueryParamIncludeMeta](../../models/operations/queryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `XPlexContainerStart` | **int* | :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` | **int* | :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` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `Object` | [*operations.GetRecentlyAddedLibraryResponseBody](../../models/operations/getrecentlyaddedlibraryresponsebody.md) | :heavy_minus_sign: | The recently added content |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user