Compare commits

..

4 Commits

Author SHA1 Message Date
speakeasybot
da5491e935 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.438.1 2024-11-12 00:10:16 +00:00
speakeasybot
aeebf438e1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-04 00:10:38 +00:00
speakeasybot
dc815780a6 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.406.0 2024-10-03 00:10:47 +00:00
speakeasybot
636840a553 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-10-01 00:11:35 +00:00
149 changed files with 5249 additions and 4252 deletions

File diff suppressed because one or more lines are too long

View File

@@ -11,11 +11,13 @@ generation:
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
go:
version: 0.13.0
version: 0.16.0
additionalDependencies: {}
allowUnknownFieldsInWeakUnions: false
clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError
flattenGlobalSecurity: true
imports:
option: openapi

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.402.14
speakeasyVersion: 1.438.1
sources:
my-source:
sourceNamespace: my-source
@@ -9,8 +9,8 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
tags:
- latest
- main
@@ -18,10 +18,10 @@ targets:
plexgo:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:b7081644a59eca24a22b8009506fcf459bf18b07dce0462b39bc36c40d94862e
sourceBlobDigest: sha256:6b822f23afbc630bbc0fc12299316ea03d3671a2c2a81241ad4caa49022b430e
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f
codeSamplesNamespace: code-samples-go-plexgo
codeSamplesRevisionDigest: sha256:77cf87f3a1619a7cf598f60cf04a2f82dd0809dd1d449c2a1f67a63729f5726a
codeSamplesRevisionDigest: sha256:7a02eff4211d44db5a95061e3af9e7151629b6539d0898b2f9aa2f9785268505
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest

235
README.md
View File

@@ -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()
@@ -116,6 +140,7 @@ func main() {
* [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
@@ -227,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()
@@ -281,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()
@@ -304,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 |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| sdkerrors.GetServerCapabilitiesBadRequest | 400 | application/json |
| sdkerrors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
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 | \*/\* |
### Example
@@ -328,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()
@@ -365,58 +394,16 @@ func main() {
<!-- Start Server Selection [server] -->
## Server Selection
### Select Server by Index
### Server Variables
You can override the default server globally using the `WithServerIndex` option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
#### Example
```go
package main
import (
"context"
"github.com/LukeHagar/plexgo"
"log"
)
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"),
)
ctx := context.Background()
res, err := s.Server.GetServerCapabilities(ctx)
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:
* `WithProtocol plexgo.ServerProtocol`
* `WithIP string`
* `WithPort string`
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following options are available when initializing the SDK client instance:
* `WithProtocol(protocol ServerProtocol)`
* `WithIP(ip string)`
* `WithPort(port string)`
### Override Server URL Per-Client
The default server can also be overridden globally using the `WithServerURL` option when initializing the SDK client instance. For example:
The default server can also be overridden globally using the `WithServerURL(serverURL string)` option when initializing the SDK client instance. For example:
```go
package main
@@ -428,13 +415,13 @@ import (
func main() {
s := plexgo.New(
plexgo.WithServerURL("{protocol}://{ip}:{port}"),
plexgo.WithServerURL("https://10.10.10.47:32400"),
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()
@@ -465,15 +452,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)
}
@@ -521,9 +508,9 @@ This can be a convenient way to configure timeouts, cookies, proxies, custom hea
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `AccessToken` | apiKey | API key |
| Name | Type | Scheme |
| ------------- | ------ | ------- |
| `AccessToken` | apiKey | API key |
You can configure it using the `WithSecurity` option when initializing the SDK client instance. For example:
```go
@@ -538,11 +525,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()
@@ -584,64 +571,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 `GetPin`. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
### Available Globals
The following global parameters are available.
| Name | Type | Required | Description |
| ---- | ---- |:--------:| ----------- |
| ClientID | 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.WithClientID("gcgzw5rz2xovp84b4vha3a40"),
plexgo.WithClientName("Plex Web"),
plexgo.WithClientVersion("4.133.0"),
plexgo.WithClientPlatform("Chrome"),
plexgo.WithDeviceName("Linux"),
)
ctx := context.Background()
res, err := s.Plex.GetPin(ctx, operations.GetPinRequest{})
if err != nil {
log.Fatal(err)
}
if res.AuthPinContainer != nil {
// handle response
}
}
```
<!-- End Global Parameters [global-parameters] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# Development

View File

@@ -922,4 +922,44 @@ Based on:
### Generated
- [go v0.13.0] .
### Releases
- [Go v0.13.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.13.0 - .
- [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 - .
## 2024-10-04 00:09:04
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.406.0 (2.429.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [go v0.15.1] .
### Releases
- [Go v0.15.1] https://github.com/LukeHagar/plexgo/releases/tag/v0.15.1 - .
## 2024-11-12 00:08:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [go v0.16.0] .
### Releases
- [Go v0.16.0] https://github.com/LukeHagar/plexgo/releases/tag/v0.16.0 - .

View File

@@ -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()

View File

@@ -11,7 +11,6 @@ import (
"github.com/LukeHagar/plexgo/models/operations"
"github.com/LukeHagar/plexgo/models/sdkerrors"
"github.com/cenkalti/backoff/v4"
"io"
"net/http"
"net/url"
)
@@ -174,21 +173,11 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -200,17 +189,16 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
res.Object = &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -223,17 +211,16 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -246,28 +233,25 @@ func (s *Activities) GetServerActivities(ctx context.Context, opts ...operations
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -420,22 +404,12 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -448,17 +422,16 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -471,28 +444,25 @@ func (s *Activities) CancelServerActivities(ctx context.Context, activityUUID st
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}

View File

@@ -11,7 +11,6 @@ import (
"github.com/LukeHagar/plexgo/models/operations"
"github.com/LukeHagar/plexgo/models/sdkerrors"
"github.com/cenkalti/backoff/v4"
"io"
"net/http"
"net/url"
)
@@ -177,22 +176,12 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -205,17 +194,16 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -228,28 +216,25 @@ func (s *Authentication) GetTransientToken(ctx context.Context, type_ operations
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -407,22 +392,12 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -435,17 +410,16 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -458,28 +432,25 @@ func (s *Authentication) GetSourceConnectionInformation(ctx context.Context, sou
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -633,21 +604,11 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -659,17 +620,16 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
res.UserPlexAccount = &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -682,17 +642,16 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -705,28 +664,25 @@ func (s *Authentication) GetTokenDetails(ctx context.Context, opts ...operations
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -747,9 +703,9 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, request operat
globals := operations.PostUsersSignInDataGlobals{
ClientID: s.sdkConfiguration.Globals.ClientID,
ClientName: s.sdkConfiguration.Globals.ClientName,
DeviceName: s.sdkConfiguration.Globals.DeviceName,
DeviceNickname: s.sdkConfiguration.Globals.DeviceNickname,
ClientVersion: s.sdkConfiguration.Globals.ClientVersion,
ClientPlatform: s.sdkConfiguration.Globals.ClientPlatform,
Platform: s.sdkConfiguration.Globals.Platform,
}
o := operations.Options{}
@@ -799,9 +755,7 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, request operat
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
@@ -894,21 +848,11 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, request operat
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 201:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -920,17 +864,16 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, request operat
res.UserPlexAccount = &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -943,17 +886,16 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, request operat
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -966,28 +908,25 @@ func (s *Authentication) PostUsersSignInData(ctx context.Context, request operat
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}

136
butler.go
View File

@@ -11,7 +11,6 @@ import (
"github.com/LukeHagar/plexgo/models/operations"
"github.com/LukeHagar/plexgo/models/sdkerrors"
"github.com/cenkalti/backoff/v4"
"io"
"net/http"
"net/url"
)
@@ -168,21 +167,11 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -194,17 +183,16 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
res.Object = &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -217,17 +205,16 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -240,28 +227,25 @@ func (s *Butler) GetButlerTasks(ctx context.Context, opts ...operations.Option)
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -414,22 +398,12 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -442,17 +416,16 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -465,28 +438,25 @@ func (s *Butler) StartAllTasks(ctx context.Context, opts ...operations.Option) (
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -635,22 +605,12 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -663,17 +623,16 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -686,28 +645,25 @@ func (s *Butler) StopAllTasks(ctx context.Context, opts ...operations.Option) (*
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -864,16 +820,6 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
fallthrough
@@ -881,7 +827,7 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -894,17 +840,16 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -917,28 +862,25 @@ func (s *Butler) StartTask(ctx context.Context, taskName operations.TaskName, op
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}
@@ -1091,22 +1033,12 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
RawResponse: httpRes,
}
getRawBody := func() ([]byte, error) {
rawBody, err := io.ReadAll(httpRes.Body)
if err != nil {
return nil, fmt.Errorf("error reading response body: %w", err)
}
httpRes.Body.Close()
httpRes.Body = io.NopCloser(bytes.NewBuffer(rawBody))
return rawBody, nil
}
switch {
case httpRes.StatusCode == 200:
case httpRes.StatusCode == 400:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -1119,17 +1051,16 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 401:
switch {
case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`):
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
@@ -1142,11 +1073,10 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
out.RawResponse = httpRes
return nil, &out
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes)
}
case httpRes.StatusCode == 404:
@@ -1154,18 +1084,16 @@ func (s *Butler) StopTask(ctx context.Context, taskName operations.PathParamTask
case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500:
fallthrough
case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes)
default:
rawBody, err := getRawBody()
rawBody, err := utils.ConsumeRawBody(httpRes)
if err != nil {
return nil, err
}
return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes)
}

File diff suppressed because it is too large Load Diff

View File

@@ -3,12 +3,12 @@
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- |
| `Protocol` | [operations.Protocol](../../models/operations/protocol.md) | :heavy_check_mark: | The protocol used for the connection (http, https, etc) |
| `Address` | *string* | :heavy_check_mark: | The (ip) address or domain name used for the connection |
| `Port` | *int* | :heavy_check_mark: | The port used for the connection |
| `URI` | *string* | :heavy_check_mark: | The full URI of the connection |
| `Local` | *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 |
| 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 | |

View File

@@ -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 |

View File

@@ -3,26 +3,26 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `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.Location](../../models/operations/location.md) | :heavy_check_mark: | N/A | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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 | |

View 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 |

View File

@@ -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 |

View File

@@ -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/> | |
| `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 |

View File

@@ -0,0 +1,8 @@
# GetLibraryItemsLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Path` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |

View File

@@ -6,19 +6,19 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `Bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
| `Width` | *int* | :heavy_check_mark: | N/A | 3840 |
| `Height` | *int* | :heavy_check_mark: | N/A | 2072 |
| `AspectRatio` | *float64* | :heavy_check_mark: | N/A | 1.85 |
| `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_check_mark: | N/A | 6 |
| `AudioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
| `VideoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
| `VideoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
| `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_check_mark: | N/A | mkv |
| `VideoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
| `VideoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
| `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 |

View File

@@ -29,5 +29,5 @@ The Meta object is only included in the response if the `includeMeta` parameter
| `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_check_mark: | N/A | |
| `Metadata` | [][operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md) | :heavy_minus_sign: | 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/> | |

View File

@@ -52,6 +52,7 @@
| `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 | |

View File

@@ -7,14 +7,14 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
| `File` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `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_check_mark: | N/A | main 10 |
| `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 | |

View File

@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `GetLibraryItemsQueryParamTypeMovie` | 1 |
| `GetLibraryItemsQueryParamTypeTvShow` | 2 |
| `GetLibraryItemsQueryParamTypeSeason` | 3 |
| `GetLibraryItemsQueryParamTypeEpisode` | 4 |
| `GetLibraryItemsQueryParamTypeEpisode` | 4 |
| `GetLibraryItemsQueryParamTypeAudio` | 8 |

View File

@@ -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 |
| `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 |

View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| Field | Type | Required | Description | Example |
| ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
| `XPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

View File

@@ -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 mindrevenge. |
| `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 |

View File

@@ -3,10 +3,10 @@
## 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 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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 |

View File

@@ -3,11 +3,11 @@
## 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 |
| 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: | 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 |

View File

@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `GetPlaylistContentsQueryParamTypeMovie` | 1 |
| `GetPlaylistContentsQueryParamTypeTvShow` | 2 |
| `GetPlaylistContentsQueryParamTypeSeason` | 3 |
| `GetPlaylistContentsQueryParamTypeEpisode` | 4 |
| `GetPlaylistContentsQueryParamTypeEpisode` | 4 |
| `GetPlaylistContentsQueryParamTypeAudio` | 8 |

View File

@@ -52,6 +52,7 @@
| `Writer` | [][operations.Writer](../../models/operations/writer.md) | :heavy_minus_sign: | N/A | |
| `Collection` | [][operations.Collection](../../models/operations/collection.md) | :heavy_minus_sign: | N/A | |
| `Role` | [][operations.Role](../../models/operations/role.md) | :heavy_minus_sign: | N/A | |
| `Location` | [][operations.Location](../../models/operations/location.md) | :heavy_minus_sign: | N/A | |
| `MediaGUID` | [][operations.MediaGUID](../../models/operations/mediaguid.md) | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `UltraBlurColors` | [*operations.UltraBlurColors](../../models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `MetaDataRating` | [][operations.MetaDataRating](../../models/operations/metadatarating.md) | :heavy_minus_sign: | N/A | |

View File

@@ -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 |
| `Force` | [*operations.Force](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `Force` | [*operations.Force](../../models/operations/force.md) | :heavy_minus_sign: | Force the refresh even if the library is already being refreshed. | 0 |
| `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 |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesCollection
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | **string* | :heavy_minus_sign: | N/A | Working NL Subs |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesCountry
## Fields
| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `Tag` | **string* | :heavy_minus_sign: | N/A | United States of America |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesDirector
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | **string* | :heavy_minus_sign: | N/A | James Cameron |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesFlattenSeasons
## Values
| Name | Value |
| ------------------------------------------ | ------------------------------------------ |
| `GetSearchAllLibrariesFlattenSeasonsFalse` | 0 |
| `GetSearchAllLibrariesFlattenSeasonsTrue` | 1 |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesGenre
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | **string* | :heavy_minus_sign: | N/A | Adventure |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesGlobals
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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 |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesHasThumbnail
## Values
| Name | Value |
| ---------------------------------------- | ---------------------------------------- |
| `GetSearchAllLibrariesHasThumbnailFalse` | 0 |
| `GetSearchAllLibrariesHasThumbnailTrue` | 1 |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesImage
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
| `Type` | [operations.GetSearchAllLibrariesLibraryType](../../models/operations/getsearchalllibrarieslibrarytype.md) | :heavy_check_mark: | N/A | background |
| `URL` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesLibraryType
## Values
| Name | Value |
| --------------------------------------------- | --------------------------------------------- |
| `GetSearchAllLibrariesLibraryTypeCoverPoster` | coverPoster |
| `GetSearchAllLibrariesLibraryTypeBackground` | background |
| `GetSearchAllLibrariesLibraryTypeSnapshot` | snapshot |
| `GetSearchAllLibrariesLibraryTypeClearLogo` | clearLogo |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesLocation
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Path` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |

View File

@@ -0,0 +1,25 @@
# GetSearchAllLibrariesMedia
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `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_check_mark: | N/A | mkv |
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
| `OptimizedForStreaming` | [*operations.GetSearchAllLibrariesOptimizedForStreaming](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |
| `Part` | [][operations.GetSearchAllLibrariesPart](../../models/operations/getsearchalllibrariespart.md) | :heavy_check_mark: | N/A | |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesMediaContainer
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `Size` | *float64* | :heavy_check_mark: | N/A |
| `SearchResult` | [][operations.SearchResult](../../models/operations/searchresult.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesMediaGUID
## 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 |

View File

@@ -0,0 +1,81 @@
# GetSearchAllLibrariesMetadata
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
| `GUID` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
| `Studio` | **string* | :heavy_minus_sign: | N/A | 20th Century Studios |
| `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.GetSearchAllLibrariesType](../../models/operations/getsearchalllibrariestype.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_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.GetSearchAllLibrariesFlattenSeasons](../../models/operations/getsearchalllibrariesflattenseasons.md) | :heavy_minus_sign: | N/A | 1 |
| `ShowOrdering` | [*operations.GetSearchAllLibrariesShowOrdering](../../models/operations/getsearchalllibrariesshowordering.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` | *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 |
| `RatingImage` | **string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `GrandparentRatingKey` | **string* | :heavy_minus_sign: | N/A | 66 |
| `GrandparentGUID` | **string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
| `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.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md) | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
| `Genre` | [][operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md) | :heavy_minus_sign: | N/A | |
| `Country` | [][operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md) | :heavy_minus_sign: | N/A | |
| `Director` | [][operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md) | :heavy_minus_sign: | N/A | |
| `Writer` | [][operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md) | :heavy_minus_sign: | N/A | |
| `Collection` | [][operations.GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md) | :heavy_minus_sign: | N/A | |
| `Role` | [][operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md) | :heavy_minus_sign: | N/A | |
| `Location` | [][operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md) | :heavy_minus_sign: | N/A | |
| `MediaGUID` | [][operations.GetSearchAllLibrariesMediaGUID](../../models/operations/getsearchalllibrariesmediaguid.md) | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `UltraBlurColors` | [*operations.GetSearchAllLibrariesUltraBlurColors](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `MetaDataRating` | [][operations.GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md) | :heavy_minus_sign: | N/A | |
| `Image` | [][operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.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 |
| `OriginalTitle` | **string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
| `ViewOffset` | **int* | :heavy_minus_sign: | N/A | 5222500 |
| `SkipCount` | **int* | :heavy_minus_sign: | N/A | 1 |
| `Index` | **int* | :heavy_minus_sign: | N/A | 1 |
| `Theme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
| `LeafCount` | **int* | :heavy_minus_sign: | N/A | 14 |
| `ViewedLeafCount` | **int* | :heavy_minus_sign: | N/A | 0 |
| `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: | 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 |
| `ParentTitle` | **string* | :heavy_minus_sign: | N/A | Caprica |
| `ParentIndex` | **int* | :heavy_minus_sign: | N/A | 1 |
| `ParentYear` | **int* | :heavy_minus_sign: | N/A | 2010 |
| `ParentThumb` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
| `ParentTheme` | **string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesMetaDataRating
## 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 |

View File

@@ -0,0 +1,9 @@
# GetSearchAllLibrariesOptimizedForStreaming
## Values
| Name | Value |
| --------------------------------------------------- | --------------------------------------------------- |
| `GetSearchAllLibrariesOptimizedForStreamingDisable` | 0 |
| `GetSearchAllLibrariesOptimizedForStreamingEnable` | 1 |

View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesPart
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `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_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.GetSearchAllLibrariesHasThumbnail](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `Stream` | [][operations.GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md) | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesRequest
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `Query` | *string* | :heavy_check_mark: | The search query term. | |
| `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 |
| `Limit` | **int64* | :heavy_minus_sign: | Limit the number of results returned. | |
| `SearchTypes` | [][operations.SearchTypes](../../models/operations/searchtypes.md) | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `IncludeCollections` | [*operations.QueryParamIncludeCollections](../../models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `IncludeExternalMedia` | [*operations.QueryParamIncludeExternalMedia](../../models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesResponse
## 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.GetSearchAllLibrariesResponseBody](../../models/operations/getsearchalllibrariesresponsebody.md) | :heavy_minus_sign: | The libraries available on the Server |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesResponseBody
The libraries available on the Server
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `MediaContainer` | [operations.GetSearchAllLibrariesMediaContainer](../../models/operations/getsearchalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,13 @@
# GetSearchAllLibrariesRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `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 |

View File

@@ -0,0 +1,20 @@
# GetSearchAllLibrariesShowOrdering
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 |
| --------------------------------------------- | --------------------------------------------- |
| `GetSearchAllLibrariesShowOrderingNone` | None |
| `GetSearchAllLibrariesShowOrderingTmdbAiring` | tmdbAiring |
| `GetSearchAllLibrariesShowOrderingAired` | aired |
| `GetSearchAllLibrariesShowOrderingDvd` | dvd |
| `GetSearchAllLibrariesShowOrderingAbsolute` | absolute |

View File

@@ -0,0 +1,45 @@
# GetSearchAllLibrariesStream
## 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 |

View File

@@ -0,0 +1,14 @@
# GetSearchAllLibrariesType
The type of media content
## Values
| Name | Value |
| ---------------------------------- | ---------------------------------- |
| `GetSearchAllLibrariesTypeMovie` | movie |
| `GetSearchAllLibrariesTypeTvShow` | show |
| `GetSearchAllLibrariesTypeSeason` | season |
| `GetSearchAllLibrariesTypeEpisode` | episode |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesUltraBlurColors
## 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 |

View File

@@ -0,0 +1,8 @@
# GetSearchAllLibrariesWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | **string* | :heavy_minus_sign: | N/A | James Cameron |

View File

@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `GetSearchLibraryQueryParamTypeMovie` | 1 |
| `GetSearchLibraryQueryParamTypeTvShow` | 2 |
| `GetSearchLibraryQueryParamTypeSeason` | 3 |
| `GetSearchLibraryQueryParamTypeEpisode` | 4 |
| `GetSearchLibraryQueryParamTypeEpisode` | 4 |
| `GetSearchLibraryQueryParamTypeAudio` | 8 |

View File

@@ -0,0 +1,8 @@
# GetServerResourcesGlobals
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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 |

View File

@@ -7,4 +7,5 @@
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `IncludeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `IncludeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `IncludeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `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 |

View File

@@ -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 |

View File

@@ -0,0 +1,12 @@
# GetTokenByPinIDGlobals
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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 |

View File

@@ -3,6 +3,11 @@
## Fields
| Field | Type | Required | Description |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `PinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for | |
| `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 |

View File

@@ -1,66 +0,0 @@
# GetTokenDetailsFeatures
## Values
| Name | Value |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| `GetTokenDetailsFeaturesAndroidDolbyVision` | Android - Dolby Vision |
| `GetTokenDetailsFeaturesAndroidPiP` | Android - PiP |
| `GetTokenDetailsFeaturesCuSunset` | CU Sunset |
| `GetTokenDetailsFeaturesHrkEnableEur` | HRK_enable_EUR |
| `GetTokenDetailsFeaturesTrebleShowFeatures` | TREBLE-show-features |
| `GetTokenDetailsFeaturesAdCountdownTimer` | ad-countdown-timer |
| `GetTokenDetailsFeaturesAdaptiveBitrate` | adaptive_bitrate |
| `GetTokenDetailsFeaturesAmazonLoopDebug` | amazon-loop-debug |
| `GetTokenDetailsFeaturesAvodAdAnalysis` | avod-ad-analysis |
| `GetTokenDetailsFeaturesAvodNewMedia` | avod-new-media |
| `GetTokenDetailsFeaturesBlacklistGetSignin` | blacklist_get_signin |
| `GetTokenDetailsFeaturesClientRadioStations` | client-radio-stations |
| `GetTokenDetailsFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
| `GetTokenDetailsFeaturesCollections` | collections |
| `GetTokenDetailsFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
| `GetTokenDetailsFeaturesCommunityAccessPlexTv` | community_access_plex_tv |
| `GetTokenDetailsFeaturesCompanionsSonos` | companions_sonos |
| `GetTokenDetailsFeaturesCustomHomeRemoval` | custom-home-removal |
| `GetTokenDetailsFeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
| `GetTokenDetailsFeaturesDisableSharingFriendships` | disable_sharing_friendships |
| `GetTokenDetailsFeaturesDrmSupport` | drm_support |
| `GetTokenDetailsFeaturesExcludeRestrictions` | exclude restrictions |
| `GetTokenDetailsFeaturesFederatedAuth` | federated-auth |
| `GetTokenDetailsFeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
| `GetTokenDetailsFeaturesGuidedUpgrade` | guided-upgrade |
| `GetTokenDetailsFeaturesHome` | home |
| `GetTokenDetailsFeaturesIncreasePasswordComplexity` | increase-password-complexity |
| `GetTokenDetailsFeaturesIos14PrivacyBanner` | ios14-privacy-banner |
| `GetTokenDetailsFeaturesIterableNotificationTokens` | iterable-notification-tokens |
| `GetTokenDetailsFeaturesKeepPaymentMethod` | keep-payment-method |
| `GetTokenDetailsFeaturesKevinBacon` | kevin-bacon |
| `GetTokenDetailsFeaturesKoreaConsent` | korea-consent |
| `GetTokenDetailsFeaturesLeIsrgRootX1` | le_isrg_root_x1 |
| `GetTokenDetailsFeaturesLetsEncrypt` | lets_encrypt |
| `GetTokenDetailsFeaturesLightningDvrPivot` | lightning-dvr-pivot |
| `GetTokenDetailsFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
| `GetTokenDetailsFeaturesLivetv` | livetv |
| `GetTokenDetailsFeaturesMetadataSearch` | metadata_search |
| `GetTokenDetailsFeaturesNewPlexPassPrices` | new_plex_pass_prices |
| `GetTokenDetailsFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
| `GetTokenDetailsFeaturesPhotosFavorites` | photos-favorites |
| `GetTokenDetailsFeaturesPhotosMetadataEdition` | photos-metadata-edition |
| `GetTokenDetailsFeaturesPmsHealth` | pms_health |
| `GetTokenDetailsFeaturesRadio` | radio |
| `GetTokenDetailsFeaturesRateLimitClientToken` | rate-limit-client-token |
| `GetTokenDetailsFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
| `GetTokenDetailsFeaturesSharedServerNotification` | shared_server_notification |
| `GetTokenDetailsFeaturesSharedSourceNotification` | shared_source_notification |
| `GetTokenDetailsFeaturesSigninWithApple` | signin_with_apple |
| `GetTokenDetailsFeaturesSpringServeAdProvider` | spring_serve_ad_provider |
| `GetTokenDetailsFeaturesTranscoderCache` | transcoder_cache |
| `GetTokenDetailsFeaturesTunerSharing` | tuner-sharing |
| `GetTokenDetailsFeaturesTwoFactorAuthentication` | two-factor-authentication |
| `GetTokenDetailsFeaturesUnsupportedtuners` | unsupportedtuners |
| `GetTokenDetailsFeaturesUpgrade3ds2` | upgrade-3ds2 |
| `GetTokenDetailsFeaturesVodSchema` | vod-schema |
| `GetTokenDetailsFeaturesVodCloudflare` | vod_cloudflare |
| `GetTokenDetailsFeaturesWatchTogetherInvite` | watch-together-invite |
| `GetTokenDetailsFeaturesWebServerDashboard` | web_server_dashboard |

File diff suppressed because one or more lines are too long

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `Features` | [][operations.GetTokenDetailsFeatures](../../models/operations/gettokendetailsfeatures.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Features` | []*string* | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [*operations.GetTokenDetailsAuthenticationResponseStatus](../../models/operations/gettokendetailsauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -8,8 +8,8 @@ Logged in user details
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AdsConsent` | *bool* | :heavy_check_mark: | Unknown | |
| `AdsConsentReminderAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Unknown | |
| `AdsConsentSetAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Unknown | |
| `AdsConsentReminderAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
| `AdsConsentSetAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
| `Anonymous` | **bool* | :heavy_minus_sign: | Unknown | |
| `AuthToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `BackupCodesCreated` | **bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
@@ -29,7 +29,7 @@ Logged in user details
| `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
| `MailingListActive` | **bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `MailingListStatus` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `MailingListStatus` | [operations.MailingListStatus](../../models/operations/mailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `MaxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`Pin`~~ | **string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `Profile` | [operations.UserProfile](../../models/operations/userprofile.md) | :heavy_check_mark: | N/A | |

View File

@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `GetTopWatchedContentQueryParamTypeMovie` | 1 |
| `GetTopWatchedContentQueryParamTypeTvShow` | 2 |
| `GetTopWatchedContentQueryParamTypeSeason` | 3 |
| `GetTopWatchedContentQueryParamTypeEpisode` | 4 |
| `GetTopWatchedContentQueryParamTypeEpisode` | 4 |
| `GetTopWatchedContentQueryParamTypeAudio` | 8 |

View File

@@ -5,5 +5,5 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.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 |
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `IncludeGuids` | **int64* | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `Type` | [operations.GetTopWatchedContentQueryParamType](../../models/operations/gettopwatchedcontentqueryparamtype.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 |

View File

@@ -13,4 +13,4 @@
| `IncludeExternalMedia` | [*operations.IncludeExternalMedia](../../models/operations/includeexternalmedia.md) | :heavy_minus_sign: | include external media in the results<br/> | |
| `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 |
| `XPlexToken` | *string* | :heavy_check_mark: | Plex Authentication Token | CV5xoxjTpFKUzBTShsaf |
| `XPlexToken` | *string* | :heavy_check_mark: | An authentication token, obtained from plex.tv | CV5xoxjTpFKUzBTShsaf |

View File

@@ -5,5 +5,4 @@
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `ID` | *int* | :heavy_check_mark: | N/A | 1 |
| `Path` | *string* | :heavy_check_mark: | N/A | /movies |
| `Path` | **string* | :heavy_minus_sign: | N/A | /TV Shows/House |

View File

@@ -1,6 +1,6 @@
# MailingListStatus
Your current mailing list status
Your current mailing list status (active or unsubscribed)
## Values

View File

@@ -6,19 +6,19 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `ID` | *int* | :heavy_check_mark: | N/A | 119534 |
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `Bitrate` | *int* | :heavy_check_mark: | N/A | 25025 |
| `Width` | *int* | :heavy_check_mark: | N/A | 3840 |
| `Height` | *int* | :heavy_check_mark: | N/A | 2072 |
| `AspectRatio` | *float64* | :heavy_check_mark: | N/A | 1.85 |
| `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_check_mark: | N/A | 6 |
| `AudioCodec` | *string* | :heavy_check_mark: | N/A | eac3 |
| `VideoCodec` | *string* | :heavy_check_mark: | N/A | hevc |
| `VideoResolution` | *string* | :heavy_check_mark: | N/A | 4k |
| `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_check_mark: | N/A | mkv |
| `VideoFrameRate` | *string* | :heavy_check_mark: | N/A | 24p |
| `VideoProfile` | *string* | :heavy_check_mark: | N/A | main 10 |
| `VideoFrameRate` | **string* | :heavy_minus_sign: | N/A | 24p |
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
| `HasVoiceActivity` | **bool* | :heavy_minus_sign: | N/A | false |
| `OptimizedForStreaming` | [*operations.OptimizedForStreaming](../../models/operations/optimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
| `Has64bitOffsets` | **bool* | :heavy_minus_sign: | N/A | false |

View File

@@ -7,14 +7,14 @@
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ID` | *int* | :heavy_check_mark: | N/A | 119542 |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
| `Duration` | *int* | :heavy_check_mark: | N/A | 11558112 |
| `Duration` | **int* | :heavy_minus_sign: | N/A | 11558112 |
| `File` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
| `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_check_mark: | N/A | main 10 |
| `VideoProfile` | **string* | :heavy_minus_sign: | N/A | main 10 |
| `Indexes` | **string* | :heavy_minus_sign: | N/A | sd |
| `HasThumbnail` | [*operations.HasThumbnail](../../models/operations/hasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `Stream` | [][operations.Stream](../../models/operations/stream.md) | :heavy_minus_sign: | N/A | |

View File

@@ -1,66 +0,0 @@
# PostUsersSignInDataAuthenticationFeatures
## Values
| Name | Value |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `PostUsersSignInDataAuthenticationFeaturesAndroidDolbyVision` | Android - Dolby Vision |
| `PostUsersSignInDataAuthenticationFeaturesAndroidPiP` | Android - PiP |
| `PostUsersSignInDataAuthenticationFeaturesCuSunset` | CU Sunset |
| `PostUsersSignInDataAuthenticationFeaturesHrkEnableEur` | HRK_enable_EUR |
| `PostUsersSignInDataAuthenticationFeaturesTrebleShowFeatures` | TREBLE-show-features |
| `PostUsersSignInDataAuthenticationFeaturesAdCountdownTimer` | ad-countdown-timer |
| `PostUsersSignInDataAuthenticationFeaturesAdaptiveBitrate` | adaptive_bitrate |
| `PostUsersSignInDataAuthenticationFeaturesAmazonLoopDebug` | amazon-loop-debug |
| `PostUsersSignInDataAuthenticationFeaturesAvodAdAnalysis` | avod-ad-analysis |
| `PostUsersSignInDataAuthenticationFeaturesAvodNewMedia` | avod-new-media |
| `PostUsersSignInDataAuthenticationFeaturesBlacklistGetSignin` | blacklist_get_signin |
| `PostUsersSignInDataAuthenticationFeaturesClientRadioStations` | client-radio-stations |
| `PostUsersSignInDataAuthenticationFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
| `PostUsersSignInDataAuthenticationFeaturesCollections` | collections |
| `PostUsersSignInDataAuthenticationFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
| `PostUsersSignInDataAuthenticationFeaturesCommunityAccessPlexTv` | community_access_plex_tv |
| `PostUsersSignInDataAuthenticationFeaturesCompanionsSonos` | companions_sonos |
| `PostUsersSignInDataAuthenticationFeaturesCustomHomeRemoval` | custom-home-removal |
| `PostUsersSignInDataAuthenticationFeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
| `PostUsersSignInDataAuthenticationFeaturesDisableSharingFriendships` | disable_sharing_friendships |
| `PostUsersSignInDataAuthenticationFeaturesDrmSupport` | drm_support |
| `PostUsersSignInDataAuthenticationFeaturesExcludeRestrictions` | exclude restrictions |
| `PostUsersSignInDataAuthenticationFeaturesFederatedAuth` | federated-auth |
| `PostUsersSignInDataAuthenticationFeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
| `PostUsersSignInDataAuthenticationFeaturesGuidedUpgrade` | guided-upgrade |
| `PostUsersSignInDataAuthenticationFeaturesHome` | home |
| `PostUsersSignInDataAuthenticationFeaturesIncreasePasswordComplexity` | increase-password-complexity |
| `PostUsersSignInDataAuthenticationFeaturesIos14PrivacyBanner` | ios14-privacy-banner |
| `PostUsersSignInDataAuthenticationFeaturesIterableNotificationTokens` | iterable-notification-tokens |
| `PostUsersSignInDataAuthenticationFeaturesKeepPaymentMethod` | keep-payment-method |
| `PostUsersSignInDataAuthenticationFeaturesKevinBacon` | kevin-bacon |
| `PostUsersSignInDataAuthenticationFeaturesKoreaConsent` | korea-consent |
| `PostUsersSignInDataAuthenticationFeaturesLeIsrgRootX1` | le_isrg_root_x1 |
| `PostUsersSignInDataAuthenticationFeaturesLetsEncrypt` | lets_encrypt |
| `PostUsersSignInDataAuthenticationFeaturesLightningDvrPivot` | lightning-dvr-pivot |
| `PostUsersSignInDataAuthenticationFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
| `PostUsersSignInDataAuthenticationFeaturesLivetv` | livetv |
| `PostUsersSignInDataAuthenticationFeaturesMetadataSearch` | metadata_search |
| `PostUsersSignInDataAuthenticationFeaturesNewPlexPassPrices` | new_plex_pass_prices |
| `PostUsersSignInDataAuthenticationFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
| `PostUsersSignInDataAuthenticationFeaturesPhotosFavorites` | photos-favorites |
| `PostUsersSignInDataAuthenticationFeaturesPhotosMetadataEdition` | photos-metadata-edition |
| `PostUsersSignInDataAuthenticationFeaturesPmsHealth` | pms_health |
| `PostUsersSignInDataAuthenticationFeaturesRadio` | radio |
| `PostUsersSignInDataAuthenticationFeaturesRateLimitClientToken` | rate-limit-client-token |
| `PostUsersSignInDataAuthenticationFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
| `PostUsersSignInDataAuthenticationFeaturesSharedServerNotification` | shared_server_notification |
| `PostUsersSignInDataAuthenticationFeaturesSharedSourceNotification` | shared_source_notification |
| `PostUsersSignInDataAuthenticationFeaturesSigninWithApple` | signin_with_apple |
| `PostUsersSignInDataAuthenticationFeaturesSpringServeAdProvider` | spring_serve_ad_provider |
| `PostUsersSignInDataAuthenticationFeaturesTranscoderCache` | transcoder_cache |
| `PostUsersSignInDataAuthenticationFeaturesTunerSharing` | tuner-sharing |
| `PostUsersSignInDataAuthenticationFeaturesTwoFactorAuthentication` | two-factor-authentication |
| `PostUsersSignInDataAuthenticationFeaturesUnsupportedtuners` | unsupportedtuners |
| `PostUsersSignInDataAuthenticationFeaturesUpgrade3ds2` | upgrade-3ds2 |
| `PostUsersSignInDataAuthenticationFeaturesVodSchema` | vod-schema |
| `PostUsersSignInDataAuthenticationFeaturesVodCloudflare` | vod_cloudflare |
| `PostUsersSignInDataAuthenticationFeaturesWatchTogetherInvite` | watch-together-invite |
| `PostUsersSignInDataAuthenticationFeaturesWebServerDashboard` | web_server_dashboard |

View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `Features` | [][operations.PostUsersSignInDataAuthenticationFeatures](../../models/operations/postuserssignindataauthenticationfeatures.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Features` | []*string* | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [*operations.PostUsersSignInDataAuthenticationResponseStatus](../../models/operations/postuserssignindataauthenticationresponsestatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -1,66 +0,0 @@
# PostUsersSignInDataFeatures
## Values
| Name | Value |
| ---------------------------------------------------------------- | ---------------------------------------------------------------- |
| `PostUsersSignInDataFeaturesAndroidDolbyVision` | Android - Dolby Vision |
| `PostUsersSignInDataFeaturesAndroidPiP` | Android - PiP |
| `PostUsersSignInDataFeaturesCuSunset` | CU Sunset |
| `PostUsersSignInDataFeaturesHrkEnableEur` | HRK_enable_EUR |
| `PostUsersSignInDataFeaturesTrebleShowFeatures` | TREBLE-show-features |
| `PostUsersSignInDataFeaturesAdCountdownTimer` | ad-countdown-timer |
| `PostUsersSignInDataFeaturesAdaptiveBitrate` | adaptive_bitrate |
| `PostUsersSignInDataFeaturesAmazonLoopDebug` | amazon-loop-debug |
| `PostUsersSignInDataFeaturesAvodAdAnalysis` | avod-ad-analysis |
| `PostUsersSignInDataFeaturesAvodNewMedia` | avod-new-media |
| `PostUsersSignInDataFeaturesBlacklistGetSignin` | blacklist_get_signin |
| `PostUsersSignInDataFeaturesClientRadioStations` | client-radio-stations |
| `PostUsersSignInDataFeaturesCloudflareTurnstileRequired` | cloudflare-turnstile-required |
| `PostUsersSignInDataFeaturesCollections` | collections |
| `PostUsersSignInDataFeaturesCommentsAndRepliesPushNotifications` | comments_and_replies_push_notifications |
| `PostUsersSignInDataFeaturesCommunityAccessPlexTv` | community_access_plex_tv |
| `PostUsersSignInDataFeaturesCompanionsSonos` | companions_sonos |
| `PostUsersSignInDataFeaturesCustomHomeRemoval` | custom-home-removal |
| `PostUsersSignInDataFeaturesDisableHomeUserFriendships` | disable_home_user_friendships |
| `PostUsersSignInDataFeaturesDisableSharingFriendships` | disable_sharing_friendships |
| `PostUsersSignInDataFeaturesDrmSupport` | drm_support |
| `PostUsersSignInDataFeaturesExcludeRestrictions` | exclude restrictions |
| `PostUsersSignInDataFeaturesFederatedAuth` | federated-auth |
| `PostUsersSignInDataFeaturesFriendRequestPushNotifications` | friend_request_push_notifications |
| `PostUsersSignInDataFeaturesGuidedUpgrade` | guided-upgrade |
| `PostUsersSignInDataFeaturesHome` | home |
| `PostUsersSignInDataFeaturesIncreasePasswordComplexity` | increase-password-complexity |
| `PostUsersSignInDataFeaturesIos14PrivacyBanner` | ios14-privacy-banner |
| `PostUsersSignInDataFeaturesIterableNotificationTokens` | iterable-notification-tokens |
| `PostUsersSignInDataFeaturesKeepPaymentMethod` | keep-payment-method |
| `PostUsersSignInDataFeaturesKevinBacon` | kevin-bacon |
| `PostUsersSignInDataFeaturesKoreaConsent` | korea-consent |
| `PostUsersSignInDataFeaturesLeIsrgRootX1` | le_isrg_root_x1 |
| `PostUsersSignInDataFeaturesLetsEncrypt` | lets_encrypt |
| `PostUsersSignInDataFeaturesLightningDvrPivot` | lightning-dvr-pivot |
| `PostUsersSignInDataFeaturesLiveTvSupportIncompleteSegments` | live-tv-support-incomplete-segments |
| `PostUsersSignInDataFeaturesLivetv` | livetv |
| `PostUsersSignInDataFeaturesMetadataSearch` | metadata_search |
| `PostUsersSignInDataFeaturesNewPlexPassPrices` | new_plex_pass_prices |
| `PostUsersSignInDataFeaturesNewsProviderSunsetModal` | news-provider-sunset-modal |
| `PostUsersSignInDataFeaturesPhotosFavorites` | photos-favorites |
| `PostUsersSignInDataFeaturesPhotosMetadataEdition` | photos-metadata-edition |
| `PostUsersSignInDataFeaturesPmsHealth` | pms_health |
| `PostUsersSignInDataFeaturesRadio` | radio |
| `PostUsersSignInDataFeaturesRateLimitClientToken` | rate-limit-client-token |
| `PostUsersSignInDataFeaturesScrobblingServicePlexTv` | scrobbling-service-plex-tv |
| `PostUsersSignInDataFeaturesSharedServerNotification` | shared_server_notification |
| `PostUsersSignInDataFeaturesSharedSourceNotification` | shared_source_notification |
| `PostUsersSignInDataFeaturesSigninWithApple` | signin_with_apple |
| `PostUsersSignInDataFeaturesSpringServeAdProvider` | spring_serve_ad_provider |
| `PostUsersSignInDataFeaturesTranscoderCache` | transcoder_cache |
| `PostUsersSignInDataFeaturesTunerSharing` | tuner-sharing |
| `PostUsersSignInDataFeaturesTwoFactorAuthentication` | two-factor-authentication |
| `PostUsersSignInDataFeaturesUnsupportedtuners` | unsupportedtuners |
| `PostUsersSignInDataFeaturesUpgrade3ds2` | upgrade-3ds2 |
| `PostUsersSignInDataFeaturesVodSchema` | vod-schema |
| `PostUsersSignInDataFeaturesVodCloudflare` | vod_cloudflare |
| `PostUsersSignInDataFeaturesWatchTogetherInvite` | watch-together-invite |
| `PostUsersSignInDataFeaturesWebServerDashboard` | web_server_dashboard |

View File

@@ -3,10 +3,10 @@
## 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 |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `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 |

View File

@@ -1,6 +1,6 @@
# PostUsersSignInDataMailingListStatus
Your current mailing list status
Your current mailing list status (active or unsubscribed)
## Values

View File

@@ -3,11 +3,11 @@
## 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 |
| `RequestBody` | [*operations.PostUsersSignInDataRequestBody](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `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 |
| `RequestBody` | [*operations.PostUsersSignInDataRequestBody](../../models/operations/postuserssignindatarequestbody.md) | :heavy_minus_sign: | Login credentials | |

File diff suppressed because one or more lines are too long

View File

@@ -7,7 +7,7 @@ If the accounts Plex Pass subscription is active
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `Features` | [][operations.PostUsersSignInDataFeatures](../../models/operations/postuserssignindatafeatures.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Features` | []*string* | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [*operations.PostUsersSignInDataAuthenticationStatus](../../models/operations/postuserssignindataauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -8,8 +8,8 @@ Returns the user account data with a valid auth token
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AdsConsent` | *bool* | :heavy_check_mark: | Unknown | |
| `AdsConsentReminderAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Unknown | |
| `AdsConsentSetAt` | [time.Time](https://pkg.go.dev/time#Time) | :heavy_check_mark: | Unknown | |
| `AdsConsentReminderAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
| `AdsConsentSetAt` | *int64* | :heavy_check_mark: | N/A | 1556281940 |
| `Anonymous` | **bool* | :heavy_minus_sign: | Unknown | |
| `AuthToken` | *string* | :heavy_check_mark: | The account token | CxoUzBTSV5hsxjTpFKaf |
| `BackupCodesCreated` | **bool* | :heavy_minus_sign: | If the two-factor authentication backup codes have been created | |
@@ -29,7 +29,7 @@ Returns the user account data with a valid auth token
| `JoinedAt` | *int64* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `Locale` | *string* | :heavy_check_mark: | The account locale | |
| `MailingListActive` | **bool* | :heavy_minus_sign: | If you are subscribed to the Plex newsletter | |
| `MailingListStatus` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status | |
| `MailingListStatus` | [operations.PostUsersSignInDataMailingListStatus](../../models/operations/postuserssignindatamailingliststatus.md) | :heavy_check_mark: | Your current mailing list status (active or unsubscribed) | active |
| `MaxHomeSize` | *int* | :heavy_check_mark: | The maximum number of accounts allowed in the Plex Home | 15 |
| ~~`Pin`~~ | **string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.<br/><br/>[Might be removed] The hashed Plex Home PIN | |
| `Profile` | [operations.PostUsersSignInDataUserProfile](../../models/operations/postuserssignindatauserprofile.md) | :heavy_check_mark: | N/A | |

View File

@@ -0,0 +1,11 @@
# QueryParamIncludeCollections
Whether to include collections in the search results.
## Values
| Name | Value |
| ------------------------------------- | ------------------------------------- |
| `QueryParamIncludeCollectionsDisable` | 0 |
| `QueryParamIncludeCollectionsEnable` | 1 |

View File

@@ -0,0 +1,11 @@
# QueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values
| Name | Value |
| --------------------------------------- | --------------------------------------- |
| `QueryParamIncludeExternalMediaDisable` | 0 |
| `QueryParamIncludeExternalMediaEnable` | 1 |

View File

@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `QueryParamTypeMovie` | 1 |
| `QueryParamTypeTvShow` | 2 |
| `QueryParamTypeSeason` | 3 |
| `QueryParamTypeEpisode` | 4 |
| `QueryParamTypeEpisode` | 4 |
| `QueryParamTypeAudio` | 8 |

View File

@@ -0,0 +1,9 @@
# SearchResult
## Fields
| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| `Score` | *float32* | :heavy_check_mark: | N/A |
| `Metadata` | [operations.GetSearchAllLibrariesMetadata](../../models/operations/getsearchalllibrariesmetadata.md) | :heavy_check_mark: | N/A |

View File

@@ -0,0 +1,12 @@
# SearchTypes
## Values
| Name | Value |
| ------------------------ | ------------------------ |
| `SearchTypesMovies` | movies |
| `SearchTypesMusic` | music |
| `SearchTypesOtherVideos` | otherVideos |
| `SearchTypesPeople` | people |
| `SearchTypesTv` | tv |

View File

@@ -7,7 +7,7 @@ If the accounts Plex Pass subscription is active
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `Features` | [][operations.Features](../../models/operations/features.md) | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Features` | []*string* | :heavy_minus_sign: | List of features allowed on your Plex Pass subscription | |
| `Active` | **bool* | :heavy_minus_sign: | If the account's Plex Pass subscription is active | true |
| `SubscribedAt` | **string* | :heavy_minus_sign: | Date the account subscribed to Plex Pass | 2021-04-12T18:21:12Z |
| `Status` | [*operations.GetTokenDetailsAuthenticationStatus](../../models/operations/gettokendetailsauthenticationstatus.md) | :heavy_minus_sign: | String representation of subscriptionActive | Inactive |

View File

@@ -16,4 +16,5 @@ E.g. A movie library will not return anything with type 3 as there are no season
| `TypeMovie` | 1 |
| `TypeTvShow` | 2 |
| `TypeSeason` | 3 |
| `TypeEpisode` | 4 |
| `TypeEpisode` | 4 |
| `TypeAudio` | 8 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
| `Errors` | [][sdkerrors.GetSearchAllLibrariesErrors](../../models/sdkerrors/getsearchalllibrarieserrors.md) | :heavy_minus_sign: | N/A |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesErrors
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `Code` | **int* | :heavy_minus_sign: | N/A | 1000 |
| `Message` | **string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `Status` | **int* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,10 @@
# GetSearchAllLibrariesLibraryErrors
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `Code` | **int* | :heavy_minus_sign: | N/A | 1001 |
| `Message` | **string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `Status` | **int* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `Errors` | [][sdkerrors.GetSearchAllLibrariesLibraryErrors](../../models/sdkerrors/getsearchalllibrarieslibraryerrors.md) | :heavy_minus_sign: | N/A |
| `RawResponse` | [*http.Response](https://pkg.go.dev/net/http#Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -35,11 +35,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()
@@ -66,12 +66,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetServerActivitiesBadRequest | 400 | application/json |
| sdkerrors.GetServerActivitiesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## CancelServerActivities
@@ -91,11 +90,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()
@@ -123,8 +122,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| sdkerrors.CancelServerActivitiesBadRequest | 400 | application/json |
| sdkerrors.CancelServerActivitiesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

View File

@@ -33,11 +33,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()
@@ -66,12 +66,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetTransientTokenBadRequest | 400 | application/json |
| sdkerrors.GetTransientTokenUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSourceConnectionInformation
@@ -93,11 +92,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()
@@ -125,12 +124,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| sdkerrors.GetSourceConnectionInformationBadRequest | 400 | application/json |
| sdkerrors.GetSourceConnectionInformationUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTokenDetails
@@ -150,11 +148,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()
@@ -181,12 +179,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetTokenDetailsBadRequest | 400 | application/json |
| sdkerrors.GetTokenDetailsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## PostUsersSignInData
@@ -206,11 +203,11 @@ import(
func main() {
s := plexgo.New(
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()
@@ -244,8 +241,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.PostUsersSignInDataBadRequest | 400 | application/json |
| sdkerrors.PostUsersSignInDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

View File

@@ -32,11 +32,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()
@@ -63,12 +63,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetButlerTasksBadRequest | 400 | application/json |
| sdkerrors.GetButlerTasksUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StartAllTasks
@@ -93,11 +92,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()
@@ -124,12 +123,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.StartAllTasksBadRequest | 400 | application/json |
| sdkerrors.StartAllTasksUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StopAllTasks
@@ -150,11 +148,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()
@@ -181,12 +179,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.StopAllTasksBadRequest | 400 | application/json |
| sdkerrors.StopAllTasksUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StartTask
@@ -212,11 +209,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()
@@ -244,12 +241,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| sdkerrors.StartTaskBadRequest | 400 | application/json |
| sdkerrors.StartTaskUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## StopTask
@@ -271,11 +267,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()
@@ -303,8 +299,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------ | ------------------------------ | ------------------------------ |
| sdkerrors.StopTaskBadRequest | 400 | application/json |
| sdkerrors.StopTaskUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

View File

@@ -30,11 +30,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()
@@ -63,12 +63,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.GetGlobalHubsBadRequest | 400 | application/json |
| sdkerrors.GetGlobalHubsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRecentlyAdded
@@ -90,11 +89,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()
@@ -129,10 +128,9 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------ | ------------------ | ------------------ |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetLibraryHubs
@@ -153,11 +151,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()
@@ -187,8 +185,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetLibraryHubsBadRequest | 400 | application/json |
| sdkerrors.GetLibraryHubsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

View File

@@ -16,6 +16,7 @@ API Calls interacting with Plex Media Server Libraries
* [GetLibraryItems](#getlibraryitems) - Get Library Items
* [GetRefreshLibraryMetadata](#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [GetSearchLibrary](#getsearchlibrary) - Search Library
* [GetSearchAllLibraries](#getsearchalllibraries) - Search All Libraries
* [GetMetaDataByRatingKey](#getmetadatabyratingkey) - Get Metadata by RatingKey
* [GetMetadataChildren](#getmetadatachildren) - Get Items Children
* [GetTopWatchedContent](#gettopwatchedcontent) - Get Top Watched Content
@@ -39,11 +40,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()
@@ -72,12 +73,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetFileHashBadRequest | 400 | application/json |
| sdkerrors.GetFileHashUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRecentlyAddedLibrary
@@ -99,11 +99,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()
@@ -152,12 +152,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| sdkerrors.GetRecentlyAddedLibraryBadRequest | 400 | application/json |
| sdkerrors.GetRecentlyAddedLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetAllLibraries
@@ -183,11 +182,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()
@@ -214,12 +213,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetAllLibrariesBadRequest | 400 | application/json |
| sdkerrors.GetAllLibrariesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetLibraryDetails
@@ -278,11 +276,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()
@@ -311,12 +309,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetLibraryDetailsBadRequest | 400 | application/json |
| sdkerrors.GetLibraryDetailsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## DeleteLibrary
@@ -336,11 +333,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()
@@ -368,12 +365,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.DeleteLibraryBadRequest | 400 | application/json |
| sdkerrors.DeleteLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetLibraryItems
@@ -414,19 +410,19 @@ 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.Library.GetLibraryItems(ctx, operations.GetLibraryItemsRequest{
SectionKey: 9518,
Tag: operations.TagEdition,
IncludeGuids: operations.IncludeGuidsEnable.ToPointer(),
Type: operations.GetLibraryItemsQueryParamTypeTvShow.ToPointer(),
SectionKey: 9518,
IncludeMeta: operations.GetLibraryItemsQueryParamIncludeMetaEnable.ToPointer(),
XPlexContainerStart: plexgo.Int(0),
XPlexContainerSize: plexgo.Int(50),
@@ -454,12 +450,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetLibraryItemsBadRequest | 400 | application/json |
| sdkerrors.GetLibraryItemsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetRefreshLibraryMetadata
@@ -481,11 +476,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()
@@ -514,12 +509,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| sdkerrors.GetRefreshLibraryMetadataBadRequest | 400 | application/json |
| sdkerrors.GetRefreshLibraryMetadataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSearchLibrary
@@ -558,11 +552,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()
@@ -591,12 +585,76 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| sdkerrors.GetSearchLibraryBadRequest | 400 | application/json |
| sdkerrors.GetSearchLibraryUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetSearchAllLibraries
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
### Example Usage
```go
package main
import(
"github.com/LukeHagar/plexgo"
"context"
"github.com/LukeHagar/plexgo/models/operations"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
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.Library.GetSearchAllLibraries(ctx, operations.GetSearchAllLibrariesRequest{
Query: "<value>",
SearchTypes: []operations.SearchTypes{
operations.SearchTypesPeople,
},
IncludeCollections: operations.QueryParamIncludeCollectionsEnable.ToPointer(),
IncludeExternalMedia: operations.QueryParamIncludeExternalMediaEnable.ToPointer(),
})
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
| `request` | [operations.GetSearchAllLibrariesRequest](../../models/operations/getsearchalllibrariesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. |
### Response
**[*operations.GetSearchAllLibrariesResponse](../../models/operations/getsearchalllibrariesresponse.md), error**
### Errors
| Error Type | Status Code | Content Type |
| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
| sdkerrors.GetSearchAllLibrariesBadRequest | 400 | application/json |
| sdkerrors.GetSearchAllLibrariesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetMetaDataByRatingKey
@@ -617,11 +675,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()
@@ -649,12 +707,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| sdkerrors.GetMetaDataByRatingKeyBadRequest | 400 | application/json |
| sdkerrors.GetMetaDataByRatingKeyUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetMetadataChildren
@@ -675,11 +732,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()
@@ -708,12 +765,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- |
| sdkerrors.GetMetadataChildrenBadRequest | 400 | application/json |
| sdkerrors.GetMetadataChildrenUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTopWatchedContent
@@ -735,11 +791,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()
@@ -768,12 +824,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| sdkerrors.GetTopWatchedContentBadRequest | 400 | application/json |
| sdkerrors.GetTopWatchedContentUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetOnDeck
@@ -794,11 +849,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()
@@ -825,8 +880,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------- | ------------------------------- | ------------------------------- |
| sdkerrors.GetOnDeckBadRequest | 400 | application/json |
| sdkerrors.GetOnDeckUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

View File

@@ -32,11 +32,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()
@@ -66,12 +66,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------- | ----------------------------- | ----------------------------- |
| sdkerrors.LogLineBadRequest | 400 | application/json |
| sdkerrors.LogLineUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## LogMultiLine
@@ -112,11 +111,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()
@@ -146,12 +145,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.LogMultiLineBadRequest | 400 | application/json |
| sdkerrors.LogMultiLineUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## EnablePaperTrail
@@ -172,11 +170,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()
@@ -203,8 +201,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
| sdkerrors.EnablePaperTrailBadRequest | 400 | application/json |
| sdkerrors.EnablePaperTrailUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

View File

@@ -32,11 +32,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()
@@ -64,12 +64,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| sdkerrors.MarkPlayedBadRequest | 400 | application/json |
| sdkerrors.MarkPlayedUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## MarkUnplayed
@@ -89,11 +88,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()
@@ -121,12 +120,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| sdkerrors.MarkUnplayedBadRequest | 400 | application/json |
| sdkerrors.MarkUnplayedUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## UpdatePlayProgress
@@ -147,11 +145,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()
@@ -181,12 +179,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| sdkerrors.UpdatePlayProgressBadRequest | 400 | application/json |
| sdkerrors.UpdatePlayProgressUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetBannerImage
@@ -207,11 +204,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()
@@ -246,12 +243,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetBannerImageBadRequest | 400 | application/json |
| sdkerrors.GetBannerImageUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetThumbImage
@@ -272,11 +268,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()
@@ -311,8 +307,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ----------------------------------- | ----------------------------------- | ----------------------------------- |
| sdkerrors.GetThumbImageBadRequest | 400 | application/json |
| sdkerrors.GetThumbImageUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |

Some files were not shown because too many files have changed in this diff Show More