Compare commits

...

10 Commits

Author SHA1 Message Date
speakeasybot
8360d057ab ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.0 2025-02-07 00:11:14 +00:00
speakeasybot
18b64727c3 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-06 00:11:16 +00:00
speakeasybot
3152372037 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.484.1 2025-02-05 00:11:28 +00:00
speakeasybot
13cd8a7fe5 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.476.1 2025-01-27 00:11:19 +00:00
speakeasybot
cdcdc0ca8e ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.474.0 2025-01-24 00:11:07 +00:00
speakeasybot
b03cc6a609 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.459.2 2024-12-22 00:12:06 +00:00
speakeasybot
4e989e0de3 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.456.1 2024-12-20 16:02:41 +00:00
Luke Hagar
c10e011a68 adjusted workflow 2024-12-20 09:59:40 -06:00
speakeasybot
7e3dca8466 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-12-16 22:20:26 +00:00
speakeasybot
8a2d3e04ab ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6 2024-11-14 00:11:57 +00:00
520 changed files with 26460 additions and 10447 deletions

View File

@@ -1,28 +0,0 @@
/* eslint-env node */
module.exports = {
root: true,
extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:import/recommended",
"plugin:import/typescript",
],
parser: "@typescript-eslint/parser",
plugins: ["@typescript-eslint"],
settings: {
"import/resolver": {
typescript: true,
node: true,
},
},
rules: {
// Handled by typescript compiler
"@typescript-eslint/no-unused-vars": "off",
"@typescript-eslint/ban-types": "off",
"@typescript-eslint/no-namespace": "off",
"@typescript-eslint/no-explicit-any": "off",
"import/no-named-as-default-member": "off",
"import/no-default-export": "error",
},
};

3
.gitignore vendored
View File

@@ -1,3 +1,6 @@
/.eslintcache
/.speakeasy/reports
/react-query
/sdk/models/errors /sdk/models/errors
/sdk/types /sdk/types
/__tests__ /__tests__

View File

@@ -1,9 +1,13 @@
**/* **/*
!/FUNCTIONS.md
!/RUNTIMES.md
!/REACT_QUERY.md
!/**/*.ts !/**/*.ts
!/**/*.js !/**/*.js
!/**/*.json
!/**/*.map !/**/*.map
/.eslintrc.js /eslint.config.mjs
/cjs /cjs
/.tshy /.tshy
/.tshy-* /.tshy-*

File diff suppressed because one or more lines are too long

View File

@@ -11,8 +11,9 @@ generation:
requestResponseComponentNamesFeb2024: true requestResponseComponentNamesFeb2024: true
auth: auth:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
typescript: typescript:
version: 0.28.0 version: 0.33.0
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: {} devDependencies: {}
@@ -21,6 +22,8 @@ typescript:
author: LukeHagar author: LukeHagar
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError defaultErrorName: SDKError
enableCustomCodeRegions: false
enableReactQuery: false
enumFormat: enum enumFormat: enum
flattenGlobalSecurity: true flattenGlobalSecurity: true
flatteningOrder: body-first flatteningOrder: body-first

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.405.6 speakeasyVersion: 1.487.0
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,26 +9,29 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345 sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
tags: tags:
- latest - latest
- main - speakeasy-sdk-regen-1738886999
- 0.0.3
targets: targets:
plexjs: plexjs:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:15e040d800921ded49cf84650ef2bc8fb1acf32c885ee193c42e838d754bf345 sourceRevisionDigest: sha256:49536684a97842ea7c069f909012b31a22a046d8277aee47b50a334494bf2c64
sourceBlobDigest: sha256:c178be2b4bfefb37d76c0fdaef37c51f9b6ab1410422d3698a41bb6a8d79a79f sourceBlobDigest: sha256:eac671ea32ce31e1e558839153f7effef39bb35b4e461c6e95661d0eaf4ce1c8
codeSamplesNamespace: code-samples-typescript-plexjs codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:5c54699020b321aaa58525ef206ddf19e67e8cd6eb452f7a064169fdef2170a9 codeSamplesRevisionDigest: sha256:cc0edeb64bf898493d4f7f9e628ac369bb39b63de609919e22052c030a54edec
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest
sources: sources:
plexapi: plexapi:
inputs: inputs:
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main - location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets: targets:
plexjs: plexjs:
target: typescript target: typescript

View File

@@ -3,7 +3,9 @@ speakeasyVersion: latest
sources: sources:
plexapi: plexapi:
inputs: inputs:
- location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi:main - location: https://raw.githubusercontent.com/LukeHagar/plex-api-spec/refs/heads/main/output/plex-media-server-spec-dereferenced.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/plexapi
targets: targets:
plexjs: plexjs:
target: typescript target: typescript

View File

@@ -27,11 +27,6 @@ import { SDKValidationError } from "@lukehagar/plexjs/sdk/models/errors/sdkvalid
// You can create one instance of it to use across an application. // You can create one instance of it to use across an application.
const plexAPI = new PlexAPICore({ const plexAPI = new PlexAPICore({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {

296
README.md
View File

@@ -40,18 +40,26 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
<!-- Start Table of Contents [toc] --> <!-- Start Table of Contents [toc] -->
## Table of Contents ## Table of Contents
<!-- $toc-max-depth=2 -->
* [@lukehagar/plexjs](#lukehagarplexjs)
* [Plex Media Server OpenAPI Specification](#plex-media-server-openapi-specification)
* [Documentation](#documentation)
* [SDKs](#sdks)
* [SDK Installation](#sdk-installation) * [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage) * [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations) * [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Retries](#retries)
* [Error Handling](#error-handling) * [Error Handling](#error-handling)
* [Server Selection](#server-selection) * [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client) * [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication) * [Authentication](#authentication)
* [Requirements](#requirements)
* [Standalone functions](#standalone-functions)
* [Retries](#retries)
* [Debugging](#debugging) * [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
<!-- End Table of Contents [toc] --> <!-- End Table of Contents [toc] -->
<!-- Start SDK Installation [installation] --> <!-- Start SDK Installation [installation] -->
@@ -97,11 +105,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {
@@ -158,8 +161,11 @@ run();
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items * [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library * [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library * [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries * [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey * [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children * [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content * [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck * [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
@@ -238,6 +244,10 @@ run();
* [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates * [checkForUpdates](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
* [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates * [applyUpdates](docs/sdks/updater/README.md#applyupdates) - Apply Updates
### [users](docs/sdks/users/README.md)
* [getUsers](docs/sdks/users/README.md#getusers) - Get list of all connected users
### [video](docs/sdks/video/README.md) ### [video](docs/sdks/video/README.md)
* [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item * [getTimeline](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
@@ -253,26 +263,16 @@ run();
<!-- Start Error Handling [errors] --> <!-- Start Error Handling [errors] -->
## Error Handling ## Error Handling
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`. Some methods specify known errors which can be thrown. All the known errors are enumerated in the `sdk/models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `getServerCapabilities` method may throw the following errors:
If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `getServerCapabilities` method may throw the following errors:
| Error Type | Status Code | Content Type | | Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | ---------------------------------------- | ----------- | ---------------- |
| errors.GetServerCapabilitiesBadRequest | 400 | application/json | | errors.GetServerCapabilitiesBadRequest | 400 | application/json |
| errors.GetServerCapabilitiesUnauthorized | 401 | application/json | | errors.GetServerCapabilitiesUnauthorized | 401 | application/json |
| errors.SDKError | 4XX, 5XX | \*/\* | | errors.SDKError | 4XX, 5XX | \*/\* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { import {
@@ -283,11 +283,6 @@ import {
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {
@@ -299,8 +294,9 @@ async function run() {
console.log(result); console.log(result);
} catch (err) { } catch (err) {
switch (true) { switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): { case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed // Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty()); console.error(err.pretty());
// Raw value may also be inspected // Raw value may also be inspected
console.error(err.rawValue); console.error(err.rawValue);
@@ -317,6 +313,7 @@ async function run() {
return; return;
} }
default: { default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err; throw err;
} }
} }
@@ -327,66 +324,38 @@ run();
``` ```
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `sdk/models/errors/httpclienterrors.ts` module:
| HTTP Client Error | Description |
| ---------------------------------------------------- | ---------------------------------------------------- |
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
<!-- End Error Handling [errors] --> <!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] --> <!-- Start Server Selection [server] -->
## Server Selection ## Server Selection
### Select Server by Index ### Server Variables
You can override the default server globally by passing a server index to the `serverIdx` optional parameter 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: 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 parameters are available when initializing the SDK client instance:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `{protocol}://{ip}:{port}` | `protocol` (default is `https`), `ip` (default is `10.10.10.47`), `port` (default is `32400`) |
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
serverIdx: 0,
accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
}
run();
```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
* `protocol: models.ServerProtocol` * `protocol: models.ServerProtocol`
* `ip: string` * `ip: string`
* `port: string` * `port: string`
### Override Server URL Per-Client ### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example: The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
serverURL: "{protocol}://{ip}:{port}", serverURL: "https://10.10.10.47:32400",
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {
@@ -399,20 +368,15 @@ async function run() {
run(); run();
``` ```
### Override Server URL Per-Operation ### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example: The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript ```typescript
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {
@@ -486,7 +450,7 @@ const sdk = new PlexAPI({ httpClient });
This SDK supports the following security scheme globally: This SDK supports the following security scheme globally:
| Name | Type | Scheme | | Name | Type | Scheme |
| ------------- | ------------- | ------------- | | ------------- | ------ | ------- |
| `accessToken` | apiKey | API key | | `accessToken` | apiKey | API key |
To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example: To authenticate with the API the `accessToken` parameter must be set when initializing the SDK client instance. For example:
@@ -495,11 +459,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {
@@ -535,83 +494,86 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
<summary>Available standalone functions</summary> <summary>Available standalone functions</summary>
- [activitiesCancelServerActivities](docs/sdks/activities/README.md#cancelserveractivities) - [`activitiesCancelServerActivities`](docs/sdks/activities/README.md#cancelserveractivities) - Cancel Server Activities
- [activitiesGetServerActivities](docs/sdks/activities/README.md#getserveractivities) - [`activitiesGetServerActivities`](docs/sdks/activities/README.md#getserveractivities) - Get Server Activities
- [authenticationGetSourceConnectionInformation](docs/sdks/authentication/README.md#getsourceconnectioninformation) - [`authenticationGetSourceConnectionInformation`](docs/sdks/authentication/README.md#getsourceconnectioninformation) - Get Source Connection Information
- [authenticationGetTokenDetails](docs/sdks/authentication/README.md#gettokendetails) - [`authenticationGetTokenDetails`](docs/sdks/authentication/README.md#gettokendetails) - Get Token Details
- [authenticationGetTransientToken](docs/sdks/authentication/README.md#gettransienttoken) - [`authenticationGetTransientToken`](docs/sdks/authentication/README.md#gettransienttoken) - Get a Transient Token
- [authenticationPostUsersSignInData](docs/sdks/authentication/README.md#postuserssignindata) - [`authenticationPostUsersSignInData`](docs/sdks/authentication/README.md#postuserssignindata) - Get User Sign In Data
- [butlerGetButlerTasks](docs/sdks/butler/README.md#getbutlertasks) - [`butlerGetButlerTasks`](docs/sdks/butler/README.md#getbutlertasks) - Get Butler tasks
- [butlerStartAllTasks](docs/sdks/butler/README.md#startalltasks) - [`butlerStartAllTasks`](docs/sdks/butler/README.md#startalltasks) - Start all Butler tasks
- [butlerStartTask](docs/sdks/butler/README.md#starttask) - [`butlerStartTask`](docs/sdks/butler/README.md#starttask) - Start a single Butler task
- [butlerStopAllTasks](docs/sdks/butler/README.md#stopalltasks) - [`butlerStopAllTasks`](docs/sdks/butler/README.md#stopalltasks) - Stop all Butler tasks
- [butlerStopTask](docs/sdks/butler/README.md#stoptask) - [`butlerStopTask`](docs/sdks/butler/README.md#stoptask) - Stop a single Butler task
- [hubsGetGlobalHubs](docs/sdks/hubs/README.md#getglobalhubs) - [`hubsGetGlobalHubs`](docs/sdks/hubs/README.md#getglobalhubs) - Get Global Hubs
- [hubsGetLibraryHubs](docs/sdks/hubs/README.md#getlibraryhubs) - [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
- [hubsGetRecentlyAdded](docs/sdks/hubs/README.md#getrecentlyadded) - [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
- [libraryDeleteLibrary](docs/sdks/library/README.md#deletelibrary) - [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
- [libraryGetAllLibraries](docs/sdks/library/README.md#getalllibraries) - [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
- [libraryGetFileHash](docs/sdks/library/README.md#getfilehash) - [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
- [libraryGetLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
- [libraryGetLibraryItems](docs/sdks/library/README.md#getlibraryitems) - [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
- [libraryGetMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
- [libraryGetMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
- [libraryGetOnDeck](docs/sdks/library/README.md#getondeck) - [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
- [libraryGetRecentlyAddedLibrary](docs/sdks/library/README.md#getrecentlyaddedlibrary) - [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
- [libraryGetRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
- [libraryGetSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
- [libraryGetSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
- [libraryGetTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
- [logEnablePaperTrail](docs/sdks/log/README.md#enablepapertrail) - [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
- [logLogLine](docs/sdks/log/README.md#logline) - [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
- [logLogMultiLine](docs/sdks/log/README.md#logmultiline) - [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
- [mediaGetBannerImage](docs/sdks/media/README.md#getbannerimage) - [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
- [mediaGetThumbImage](docs/sdks/media/README.md#getthumbimage) - [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
- [mediaMarkPlayed](docs/sdks/media/README.md#markplayed) - [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
- [mediaMarkUnplayed](docs/sdks/media/README.md#markunplayed) - [`mediaGetBannerImage`](docs/sdks/media/README.md#getbannerimage) - Get Banner Image
- [mediaUpdatePlayProgress](docs/sdks/media/README.md#updateplayprogress) - [`mediaGetThumbImage`](docs/sdks/media/README.md#getthumbimage) - Get Thumb Image
- [playlistsAddPlaylistContents](docs/sdks/playlists/README.md#addplaylistcontents) - [`mediaMarkPlayed`](docs/sdks/media/README.md#markplayed) - Mark Media Played
- [playlistsClearPlaylistContents](docs/sdks/playlists/README.md#clearplaylistcontents) - [`mediaMarkUnplayed`](docs/sdks/media/README.md#markunplayed) - Mark Media Unplayed
- [playlistsCreatePlaylist](docs/sdks/playlists/README.md#createplaylist) - [`mediaUpdatePlayProgress`](docs/sdks/media/README.md#updateplayprogress) - Update Media Play Progress
- [playlistsDeletePlaylist](docs/sdks/playlists/README.md#deleteplaylist) - [`playlistsAddPlaylistContents`](docs/sdks/playlists/README.md#addplaylistcontents) - Adding to a Playlist
- [playlistsGetPlaylistContents](docs/sdks/playlists/README.md#getplaylistcontents) - [`playlistsClearPlaylistContents`](docs/sdks/playlists/README.md#clearplaylistcontents) - Delete Playlist Contents
- [playlistsGetPlaylist](docs/sdks/playlists/README.md#getplaylist) - [`playlistsCreatePlaylist`](docs/sdks/playlists/README.md#createplaylist) - Create a Playlist
- [playlistsGetPlaylists](docs/sdks/playlists/README.md#getplaylists) - [`playlistsDeletePlaylist`](docs/sdks/playlists/README.md#deleteplaylist) - Deletes a Playlist
- [playlistsUpdatePlaylist](docs/sdks/playlists/README.md#updateplaylist) - [`playlistsGetPlaylist`](docs/sdks/playlists/README.md#getplaylist) - Retrieve Playlist
- [playlistsUploadPlaylist](docs/sdks/playlists/README.md#uploadplaylist) - [`playlistsGetPlaylistContents`](docs/sdks/playlists/README.md#getplaylistcontents) - Retrieve Playlist Contents
- [plexGetCompanionsData](docs/sdks/plex/README.md#getcompanionsdata) - [`playlistsGetPlaylists`](docs/sdks/playlists/README.md#getplaylists) - Get All Playlists
- [plexGetGeoData](docs/sdks/plex/README.md#getgeodata) - [`playlistsUpdatePlaylist`](docs/sdks/playlists/README.md#updateplaylist) - Update a Playlist
- [plexGetHomeData](docs/sdks/plex/README.md#gethomedata) - [`playlistsUploadPlaylist`](docs/sdks/playlists/README.md#uploadplaylist) - Upload Playlist
- [plexGetPin](docs/sdks/plex/README.md#getpin) - [`plexGetCompanionsData`](docs/sdks/plex/README.md#getcompanionsdata) - Get Companions Data
- [plexGetServerResources](docs/sdks/plex/README.md#getserverresources) - [`plexGetGeoData`](docs/sdks/plex/README.md#getgeodata) - Get Geo Data
- [plexGetTokenByPinId](docs/sdks/plex/README.md#gettokenbypinid) - [`plexGetHomeData`](docs/sdks/plex/README.md#gethomedata) - Get Plex Home Data
- [plexGetUserFriends](docs/sdks/plex/README.md#getuserfriends) - [`plexGetPin`](docs/sdks/plex/README.md#getpin) - Get a Pin
- [searchGetSearchResults](docs/sdks/search/README.md#getsearchresults) - [`plexGetServerResources`](docs/sdks/plex/README.md#getserverresources) - Get Server Resources
- [searchPerformSearch](docs/sdks/search/README.md#performsearch) - [`plexGetTokenByPinId`](docs/sdks/plex/README.md#gettokenbypinid) - Get Access Token by PinId
- [searchPerformVoiceSearch](docs/sdks/search/README.md#performvoicesearch) - [`plexGetUserFriends`](docs/sdks/plex/README.md#getuserfriends) - Get list of friends of the user logged in
- [serverGetAvailableClients](docs/sdks/server/README.md#getavailableclients) - [`searchGetSearchResults`](docs/sdks/search/README.md#getsearchresults) - Get Search Results
- [serverGetDevices](docs/sdks/server/README.md#getdevices) - [`searchPerformSearch`](docs/sdks/search/README.md#performsearch) - Perform a search
- [serverGetMediaProviders](docs/sdks/server/README.md#getmediaproviders) - [`searchPerformVoiceSearch`](docs/sdks/search/README.md#performvoicesearch) - Perform a voice search
- [serverGetMyPlexAccount](docs/sdks/server/README.md#getmyplexaccount) - [`serverGetAvailableClients`](docs/sdks/server/README.md#getavailableclients) - Get Available Clients
- [serverGetResizedPhoto](docs/sdks/server/README.md#getresizedphoto) - [`serverGetDevices`](docs/sdks/server/README.md#getdevices) - Get Devices
- [serverGetServerCapabilities](docs/sdks/server/README.md#getservercapabilities) - [`serverGetMediaProviders`](docs/sdks/server/README.md#getmediaproviders) - Get Media Providers
- [serverGetServerIdentity](docs/sdks/server/README.md#getserveridentity) - [`serverGetMyPlexAccount`](docs/sdks/server/README.md#getmyplexaccount) - Get MyPlex Account
- [serverGetServerList](docs/sdks/server/README.md#getserverlist) - [`serverGetResizedPhoto`](docs/sdks/server/README.md#getresizedphoto) - Get a Resized Photo
- [serverGetServerPreferences](docs/sdks/server/README.md#getserverpreferences) - [`serverGetServerCapabilities`](docs/sdks/server/README.md#getservercapabilities) - Get Server Capabilities
- [sessionsGetSessionHistory](docs/sdks/sessions/README.md#getsessionhistory) - [`serverGetServerIdentity`](docs/sdks/server/README.md#getserveridentity) - Get Server Identity
- [sessionsGetSessions](docs/sdks/sessions/README.md#getsessions) - [`serverGetServerList`](docs/sdks/server/README.md#getserverlist) - Get Server List
- [sessionsGetTranscodeSessions](docs/sdks/sessions/README.md#gettranscodesessions) - [`serverGetServerPreferences`](docs/sdks/server/README.md#getserverpreferences) - Get Server Preferences
- [sessionsStopTranscodeSession](docs/sdks/sessions/README.md#stoptranscodesession) - [`sessionsGetSessionHistory`](docs/sdks/sessions/README.md#getsessionhistory) - Get Session History
- [statisticsGetBandwidthStatistics](docs/sdks/statistics/README.md#getbandwidthstatistics) - [`sessionsGetSessions`](docs/sdks/sessions/README.md#getsessions) - Get Active Sessions
- [statisticsGetResourcesStatistics](docs/sdks/statistics/README.md#getresourcesstatistics) - [`sessionsGetTranscodeSessions`](docs/sdks/sessions/README.md#gettranscodesessions) - Get Transcode Sessions
- [statisticsGetStatistics](docs/sdks/statistics/README.md#getstatistics) - [`sessionsStopTranscodeSession`](docs/sdks/sessions/README.md#stoptranscodesession) - Stop a Transcode Session
- [updaterApplyUpdates](docs/sdks/updater/README.md#applyupdates) - [`statisticsGetBandwidthStatistics`](docs/sdks/statistics/README.md#getbandwidthstatistics) - Get Bandwidth Statistics
- [updaterCheckForUpdates](docs/sdks/updater/README.md#checkforupdates) - [`statisticsGetResourcesStatistics`](docs/sdks/statistics/README.md#getresourcesstatistics) - Get Resources Statistics
- [updaterGetUpdateStatus](docs/sdks/updater/README.md#getupdatestatus) - [`statisticsGetStatistics`](docs/sdks/statistics/README.md#getstatistics) - Get Media Statistics
- [videoGetTimeline](docs/sdks/video/README.md#gettimeline) - [`updaterApplyUpdates`](docs/sdks/updater/README.md#applyupdates) - Apply Updates
- [videoStartUniversalTranscode](docs/sdks/video/README.md#startuniversaltranscode) - [`updaterCheckForUpdates`](docs/sdks/updater/README.md#checkforupdates) - Checking for updates
- [watchlistGetWatchList](docs/sdks/watchlist/README.md#getwatchlist) - [`updaterGetUpdateStatus`](docs/sdks/updater/README.md#getupdatestatus) - Querying status of updates
- [`usersGetUsers`](docs/sdks/users/README.md#getusers) - Get list of all connected users
- [`videoGetTimeline`](docs/sdks/video/README.md#gettimeline) - Get the timeline for a media item
- [`videoStartUniversalTranscode`](docs/sdks/video/README.md#startuniversaltranscode) - Start Universal Transcode
- [`watchlistGetWatchList`](docs/sdks/watchlist/README.md#getwatchlist) - Get User Watchlist
</details> </details>
<!-- End Standalone functions [standalone-funcs] --> <!-- End Standalone functions [standalone-funcs] -->
@@ -627,11 +589,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {
@@ -672,11 +629,6 @@ const plexAPI = new PlexAPI({
retryConnectionErrors: false, retryConnectionErrors: false,
}, },
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {

View File

@@ -1129,3 +1129,93 @@ Based on:
- [typescript v0.28.0] . - [typescript v0.28.0] .
### Releases ### Releases
- [NPM v0.28.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.28.0 - . - [NPM v0.28.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.28.0 - .
## 2024-11-14 00:09:39
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.30.0] .
### Releases
- [NPM v0.30.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.30.0 - .
## 2024-12-16 22:17:52
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.405.6 (2.428.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.31.1] .
### Releases
- [NPM v0.31.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.31.1 - .
## 2024-12-20 16:01:16
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.456.1 (2.481.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.0] .
### Releases
- [NPM v0.32.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.0 - .
## 2024-12-22 00:10:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.459.2 (2.483.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.1] .
### Releases
- [NPM v0.32.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.1 - .
## 2025-01-24 00:09:35
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.474.0 (2.495.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.2] .
### Releases
- [NPM v0.32.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.2 - .
## 2025-01-27 00:09:48
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.476.1 (2.495.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.3] .
### Releases
- [NPM v0.32.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.3 - .
## 2025-02-05 00:09:58
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.4] .
### Releases
- [NPM v0.32.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.4 - .
## 2025-02-06 00:09:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.484.1 (2.503.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.32.5] .
### Releases
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
## 2025-02-07 00:09:41
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.33.0] .
### Releases
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .

View File

@@ -1,6 +1,6 @@
# Supported JavaScript runtimes # Supported JavaScript runtimes
This SDK is intended to be used in JavaScript runtimes that support the following features: This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
* [Web Fetch API][web-fetch] * [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream` * [Web Streams API][web-streams] and in particular `ReadableStream`
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming]) - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018 [deno-file-streaming]: https://github.com/denoland/deno/issues/11018
## Recommended TypeScript compiler options
The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
```jsonc
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
}
}
```
While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.

View File

@@ -4,11 +4,6 @@ import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({ const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>", accessToken: "<YOUR_API_KEY_HERE>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
clientVersion: "2.4.1",
platform: "Roku",
deviceNickname: "Roku 3",
}); });
async function run() { async function run() {

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,18 @@
# GetActorsLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,11 +1,11 @@
# GetMetaDataByRatingKeyErrors # GetActorsLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMetaDataByRatingKeyErrors = { let value: GetActorsLibraryErrors = {
code: 1000, code: 1000,
message: "X-Plex-Client-Identifier is missing", message: "X-Plex-Client-Identifier is missing",
status: 400, status: 400,

View File

@@ -1,11 +1,11 @@
# GetMetaDataByRatingKeyLibraryErrors # GetActorsLibraryLibraryErrors
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors"; import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMetaDataByRatingKeyLibraryErrors = { let value: GetActorsLibraryLibraryErrors = {
code: 1001, code: 1001,
message: "User could not be authenticated", message: "User could not be authenticated",
status: 401, status: 401,

View File

@@ -0,0 +1,18 @@
# GetActorsLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetCountriesLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetCountriesLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetCountriesLibraryErrors](../../../sdk/models/errors/getcountrieslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# GetCountriesLibraryErrors
## Example Usage
```typescript
import { GetCountriesLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetCountriesLibraryErrors = {
code: 1000,
message: "X-Plex-Client-Identifier is missing",
status: 400,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,21 @@
# GetCountriesLibraryLibraryErrors
## Example Usage
```typescript
import { GetCountriesLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetCountriesLibraryLibraryErrors = {
code: 1001,
message: "User could not be authenticated",
status: 401,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,18 @@
# GetCountriesLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetCountriesLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetCountriesLibraryLibraryErrors](../../../sdk/models/errors/getcountrieslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetGenresLibraryBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetGenresLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetGenresLibraryErrors](../../../sdk/models/errors/getgenreslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# GetGenresLibraryErrors
## Example Usage
```typescript
import { GetGenresLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetGenresLibraryErrors = {
code: 1000,
message: "X-Plex-Client-Identifier is missing",
status: 400,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,21 @@
# GetGenresLibraryLibraryErrors
## Example Usage
```typescript
import { GetGenresLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetGenresLibraryLibraryErrors = {
code: 1001,
message: "User could not be authenticated",
status: 401,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,18 @@
# GetGenresLibraryUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetGenresLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetGenresLibraryLibraryErrors](../../../sdk/models/errors/getgenreslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetMediaMetaDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMediaMetaDataErrors](../../../sdk/models/errors/getmediametadataerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataErrors
## Example Usage
```typescript
import { GetMediaMetaDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMediaMetaDataErrors = {
code: 1000,
message: "X-Plex-Client-Identifier is missing",
status: 400,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataLibraryErrors
## Example Usage
```typescript
import { GetMediaMetaDataLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetMediaMetaDataLibraryErrors = {
code: 1001,
message: "User could not be authenticated",
status: 401,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetMediaMetaDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMediaMetaDataLibraryErrors](../../../sdk/models/errors/getmediametadatalibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,18 +0,0 @@
# GetMetaDataByRatingKeyBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMetaDataByRatingKeyErrors](../../../sdk/models/errors/getmetadatabyratingkeyerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -1,18 +0,0 @@
# GetMetaDataByRatingKeyUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `errors` | [errors.GetMetaDataByRatingKeyLibraryErrors](../../../sdk/models/errors/getmetadatabyratingkeylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,18 @@
# GetUsersBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetUsersBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| `errors` | [errors.GetUsersErrors](../../../sdk/models/errors/getuserserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# GetUsersErrors
## Example Usage
```typescript
import { GetUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetUsersErrors = {
code: 1000,
message: "X-Plex-Client-Identifier is missing",
status: 400,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |

View File

@@ -0,0 +1,18 @@
# GetUsersUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetUsersUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `errors` | [errors.GetUsersUsersErrors](../../../sdk/models/errors/getusersuserserrors.md)[] | :heavy_minus_sign: | N/A |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |

View File

@@ -0,0 +1,21 @@
# GetUsersUsersErrors
## Example Usage
```typescript
import { GetUsersUsersErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetUsersUsersErrors = {
code: 1001,
message: "User could not be authenticated",
status: 401,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |

View File

@@ -6,7 +6,7 @@
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: AddPlaylistContentsRequest = { let value: AddPlaylistContentsRequest = {
playlistID: 6289.82, playlistID: 6874.88,
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1", uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
playQueueID: 123, playQueueID: 123,
}; };

View File

@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
let value: AddPlaylistContentsResponse = { let value: AddPlaylistContentsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 503, statusCode: 226,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -0,0 +1,18 @@
# AllLibraries
Indicates if the user has access to all libraries.
## Example Usage
```typescript
import { AllLibraries } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllLibraries = AllLibraries.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowCameraUpload
Indicates if the user is allowed to upload from a camera.
## Example Usage
```typescript
import { AllowCameraUpload } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowCameraUpload = AllowCameraUpload.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowChannels
Indicates if the user has access to channels.
## Example Usage
```typescript
import { AllowChannels } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowChannels = AllowChannels.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowSubtitleAdmin
Indicates if the user can manage subtitles.
## Example Usage
```typescript
import { AllowSubtitleAdmin } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowSubtitleAdmin = AllowSubtitleAdmin.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowSync
Indicates if the user is allowed to sync media.
## Example Usage
```typescript
import { AllowSync } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowSync = AllowSync.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -0,0 +1,18 @@
# AllowTuners
Indicates if the user is allowed to use tuners.
## Example Usage
```typescript
import { AllowTuners } from "@lukehagar/plexjs/sdk/models/operations";
let value: AllowTuners = AllowTuners.Enable;
```
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

View File

@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: ApplyUpdatesResponse = { let value: ApplyUpdatesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 103, statusCode: 101,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
let value: Billing = { let value: Billing = {
internalPaymentMethod: {}, internalPaymentMethod: {},
paymentMethodId: 374170, paymentMethodId: 517379,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
let value: CheckForUpdatesResponse = { let value: CheckForUpdatesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 201, statusCode: 205,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -6,7 +6,7 @@
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: ClearPlaylistContentsRequest = { let value: ClearPlaylistContentsRequest = {
playlistID: 3834.64, playlistID: 7980.47,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
let value: ClearPlaylistContentsResponse = { let value: ClearPlaylistContentsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 307, statusCode: 103,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
let value: CreatePlaylistRequest = { let value: CreatePlaylistRequest = {
title: "<value>", title: "<value>",
type: CreatePlaylistQueryParamType.Photo, type: CreatePlaylistQueryParamType.Video,
smart: Smart.One, smart: Smart.Zero,
uri: "https://enchanted-disclosure.com/", uri: "https://humble-confusion.com",
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
let value: CreatePlaylistResponse = { let value: CreatePlaylistResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 302, statusCode: 102,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -6,7 +6,7 @@
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeletePlaylistRequest = { let value: DeletePlaylistRequest = {
playlistID: 5365.79, playlistID: 206.51,
}; };
``` ```

View File

@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
let value: DeletePlaylistResponse = { let value: DeletePlaylistResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 511, statusCode: 409,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -0,0 +1,19 @@
# EnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Example Usage
```typescript
import { EnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
let value: EnableCreditsMarkerGeneration =
EnableCreditsMarkerGeneration.LibraryDefault;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

View File

@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
let value: EnablePaperTrailResponse = { let value: EnablePaperTrailResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 203, statusCode: 302,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -0,0 +1,19 @@
# EpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Example Usage
```typescript
import { EpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
let value: EpisodeSort = EpisodeSort.OldestFirst;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

View File

@@ -1,16 +1,19 @@
# FlattenSeasons # FlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Example Usage ## Example Usage
```typescript ```typescript
import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations"; import { FlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
let value: FlattenSeasons = FlattenSeasons.True; let value: FlattenSeasons = FlattenSeasons.Show;
``` ```
## Values ## Values
| Name | Value | | Name | Value |
| ------- | ------- | | ---------------- | ---------------- |
| `False` | 0 | | `LibraryDefault` | -1 |
| `True` | 1 | | `Hide` | 0 |
| `Show` | 1 |

View File

@@ -10,13 +10,8 @@ let value: Friend = {
friendlyName: "exampleUser", friendlyName: "exampleUser",
home: true, home: true,
id: 0, id: 0,
restricted: false, sharedServers: [],
sharedServers: [ sharedSources: [],
{},
],
sharedSources: [
{},
],
status: Status.Accepted, status: Status.Accepted,
thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578", thumb: "https://plex.tv/users/7d1916e0d8f6e76b/avatar?c=1694481578",
title: "username123", title: "username123",

View File

@@ -12,11 +12,8 @@ let value: GeoData = {
continentCode: "NA", continentCode: "NA",
country: "United States Virgin Islands", country: "United States Virgin Islands",
city: "Amsterdam", city: "Amsterdam",
europeanUnionMember: true,
timeZone: "America/St_Thomas", timeZone: "America/St_Thomas",
postalCode: "802", postalCode: "802",
inPrivacyRestrictedCountry: true,
inPrivacyRestrictedRegion: true,
subdivisions: "Saint Thomas", subdivisions: "Saint Thomas",
coordinates: "18.3381, -64.8941", coordinates: "18.3381, -64.8941",
}; };

View File

@@ -0,0 +1,24 @@
# GetActorsLibraryDirectory
## Example Usage
```typescript
import { GetActorsLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryDirectory = {
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |

View File

@@ -0,0 +1,49 @@
# GetActorsLibraryMediaContainer
## Example Usage
```typescript
import { GetActorsLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryMediaContainer = {
size: 50,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Starring Actor",
viewGroup: "secondary",
viewMode: "131131",
directory: [
{
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |

View File

@@ -0,0 +1,30 @@
# GetActorsLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Example Usage
```typescript
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryQueryParamType =
GetActorsLibraryQueryParamType.TvShow;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -0,0 +1,19 @@
# GetActorsLibraryRequest
## Example Usage
```typescript
import { GetActorsLibraryQueryParamType, GetActorsLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryRequest = {
sectionKey: 9518,
type: GetActorsLibraryQueryParamType.TvShow,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetActorsLibraryQueryParamType](../../../sdk/models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -0,0 +1,49 @@
# GetActorsLibraryResponse
## Example Usage
```typescript
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryResponse = {
contentType: "<value>",
statusCode: 413,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Starring Actor",
viewGroup: "secondary",
viewMode: "131131",
directory: [
{
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetActorsLibraryResponseBody](../../../sdk/models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |

View File

@@ -0,0 +1,41 @@
# GetActorsLibraryResponseBody
Successful response containing media container data.
## Example Usage
```typescript
import { GetActorsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetActorsLibraryResponseBody = {
mediaContainer: {
size: 50,
allowSync: false,
art: "/:/resources/show-fanart.jpg",
identifier: "com.plexapp.plugins.library",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Starring Actor",
viewGroup: "secondary",
viewMode: "131131",
directory: [
{
fastKey: "/library/sections/2/all?actor=134671",
thumb:
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
key: "134671",
title: "Aaron Paul",
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetActorsLibraryMediaContainer](../../../sdk/models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
let value: GetBandwidthStatisticsResponse = { let value: GetBandwidthStatisticsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 101, statusCode: 500,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -0,0 +1,21 @@
# GetCountriesLibraryDirectory
## Example Usage
```typescript
import { GetCountriesLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryDirectory = {
fastKey: "/library/sections/2/all?country=15491",
key: "15491",
title: "Japan",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
| `fastKey` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?country=15491 |
| `key` | *string* | :heavy_check_mark: | N/A | 15491 |
| `title` | *string* | :heavy_check_mark: | N/A | Japan |

View File

@@ -1,55 +1,28 @@
# GetMetaDataByRatingKeyPart # GetCountriesLibraryMediaContainer
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyPart } from "@lukehagar/plexjs/sdk/models/operations"; import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyPart = { let value: GetCountriesLibraryMediaContainer = {
id: 15, size: 50,
key: "/library/parts/15/1705637151/file.mp4", identifier: "com.plexapp.plugins.library",
duration: 141417, allowSync: false,
file: "/movies/Serenity (2005)/Serenity (2005).mp4", art: "/:/resources/show-fanart.jpg",
size: 40271948, content: "secondary",
audioProfile: "lc", mediaTagPrefix: "/system/bundle/media/flags/",
container: "mp4", mediaTagVersion: 1734362201,
has64bitOffsets: false, nocache: true,
optimizedForStreaming: false, thumb: "/:/resources/show.png",
videoProfile: "high", title1: "TV Series",
stream: [ title2: "By Country",
viewGroup: "secondary",
directory: [
{ {
id: 29, fastKey: "/library/sections/2/all?country=15491",
streamType: 2, key: "15491",
default: true, title: "Japan",
codec: "aac",
index: 0,
bitrate: 128,
bitDepth: 8,
chromaLocation: "left",
chromaSubsampling: "14520",
codedHeight: 816,
codedWidth: 1920,
colorPrimaries: "bt709",
colorRange: "tv",
colorSpace: "bt709",
colorTrc: "bt709",
frameRate: 24,
hasScalingMatrix: false,
height: 814,
level: 40,
profile: "lc",
refFrames: 4,
scanType: "progressive",
streamIdentifier: "1",
width: 1920,
displayTitle: "English (AAC Stereo)",
extendedDisplayTitle: "English (AAC Stereo)",
selected: true,
channels: 2,
language: "English",
languageTag: "en",
languageCode: "eng",
samplingRate: 44100,
}, },
], ],
}; };
@@ -59,14 +32,18 @@ let value: GetMetaDataByRatingKeyPart = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 15 | | `size` | *number* | :heavy_check_mark: | N/A | 50 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/15/1705637151/file.mp4 | | `offset` | *number* | :heavy_minus_sign: | N/A | |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 | | `totalSize` | *number* | :heavy_minus_sign: | N/A | |
| `file` | *string* | :heavy_minus_sign: | N/A | /movies/Serenity (2005)/Serenity (2005).mp4 | | `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `size` | *number* | :heavy_minus_sign: | N/A | 40271948 | | `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc | | `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `container` | *string* | :heavy_minus_sign: | N/A | mp4 | | `content` | *string* | :heavy_check_mark: | N/A | secondary |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false | | `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false | | `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | high | | `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
| `stream` | [operations.GetMetaDataByRatingKeyStream](../../../sdk/models/operations/getmetadatabyratingkeystream.md)[] | :heavy_minus_sign: | N/A | | | `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,30 @@
# GetCountriesLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Example Usage
```typescript
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryQueryParamType =
GetCountriesLibraryQueryParamType.TvShow;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -0,0 +1,19 @@
# GetCountriesLibraryRequest
## Example Usage
```typescript
import { GetCountriesLibraryQueryParamType, GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryRequest = {
sectionKey: 9518,
type: GetCountriesLibraryQueryParamType.TvShow,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetCountriesLibraryQueryParamType](../../../sdk/models/operations/getcountrieslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -0,0 +1,47 @@
# GetCountriesLibraryResponse
## Example Usage
```typescript
import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryResponse = {
contentType: "<value>",
statusCode: 300,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
identifier: "com.plexapp.plugins.library",
allowSync: false,
art: "/:/resources/show-fanart.jpg",
content: "secondary",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Country",
viewGroup: "secondary",
directory: [
{
fastKey: "/library/sections/2/all?country=15491",
key: "15491",
title: "Japan",
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetCountriesLibraryResponseBody](../../../sdk/models/operations/getcountrieslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |

View File

@@ -0,0 +1,39 @@
# GetCountriesLibraryResponseBody
Successful response containing media container data.
## Example Usage
```typescript
import { GetCountriesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetCountriesLibraryResponseBody = {
mediaContainer: {
size: 50,
identifier: "com.plexapp.plugins.library",
allowSync: false,
art: "/:/resources/show-fanart.jpg",
content: "secondary",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Series",
title2: "By Country",
viewGroup: "secondary",
directory: [
{
fastKey: "/library/sections/2/all?country=15491",
key: "15491",
title: "Japan",
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetCountriesLibraryMediaContainer](../../../sdk/models/operations/getcountrieslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,23 @@
# GetGenresLibraryDirectory
## Example Usage
```typescript
import { GetGenresLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryDirectory = {
fastKey: "/library/sections/10/all?genre=89",
key: "89",
title: "Action",
type: "genre",
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
| `fastKey` | *string* | :heavy_check_mark: | N/A | /library/sections/10/all?genre=89 |
| `key` | *string* | :heavy_check_mark: | N/A | 89 |
| `title` | *string* | :heavy_check_mark: | N/A | Action |
| `type` | *string* | :heavy_check_mark: | N/A | genre |

View File

@@ -0,0 +1,50 @@
# GetGenresLibraryMediaContainer
## Example Usage
```typescript
import { GetGenresLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryMediaContainer = {
size: 50,
identifier: "com.plexapp.plugins.library",
allowSync: false,
art: "/:/resources/show-fanart.jpg",
content: "secondary",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Shows (Reality)",
title2: "By Genre",
viewGroup: "secondary",
directory: [
{
fastKey: "/library/sections/10/all?genre=89",
key: "89",
title: "Action",
type: "genre",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
| `offset` | *number* | :heavy_minus_sign: | N/A | |
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -0,0 +1,30 @@
# GetGenresLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Example Usage
```typescript
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryQueryParamType =
GetGenresLibraryQueryParamType.TvShow;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -0,0 +1,19 @@
# GetGenresLibraryRequest
## Example Usage
```typescript
import { GetGenresLibraryQueryParamType, GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryRequest = {
sectionKey: 9518,
type: GetGenresLibraryQueryParamType.TvShow,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `type` | [operations.GetGenresLibraryQueryParamType](../../../sdk/models/operations/getgenreslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |

View File

@@ -0,0 +1,48 @@
# GetGenresLibraryResponse
## Example Usage
```typescript
import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryResponse = {
contentType: "<value>",
statusCode: 506,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
identifier: "com.plexapp.plugins.library",
allowSync: false,
art: "/:/resources/show-fanart.jpg",
content: "secondary",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Shows (Reality)",
title2: "By Genre",
viewGroup: "secondary",
directory: [
{
fastKey: "/library/sections/10/all?genre=89",
key: "89",
title: "Action",
type: "genre",
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetGenresLibraryResponseBody](../../../sdk/models/operations/getgenreslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |

View File

@@ -0,0 +1,40 @@
# GetGenresLibraryResponseBody
Successful response containing media container data.
## Example Usage
```typescript
import { GetGenresLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGenresLibraryResponseBody = {
mediaContainer: {
size: 50,
identifier: "com.plexapp.plugins.library",
allowSync: false,
art: "/:/resources/show-fanart.jpg",
content: "secondary",
mediaTagPrefix: "/system/bundle/media/flags/",
mediaTagVersion: 1734362201,
nocache: true,
thumb: "/:/resources/show.png",
title1: "TV Shows (Reality)",
title2: "By Genre",
viewGroup: "secondary",
directory: [
{
fastKey: "/library/sections/10/all?genre=89",
key: "89",
title: "Action",
type: "genre",
},
],
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetGenresLibraryMediaContainer](../../../sdk/models/operations/getgenreslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -12,11 +12,8 @@ let value: GetGeoDataGeoData = {
continentCode: "NA", continentCode: "NA",
country: "United States Virgin Islands", country: "United States Virgin Islands",
city: "Amsterdam", city: "Amsterdam",
europeanUnionMember: true,
timeZone: "America/St_Thomas", timeZone: "America/St_Thomas",
postalCode: "802", postalCode: "802",
inPrivacyRestrictedCountry: true,
inPrivacyRestrictedRegion: true,
subdivisions: "Saint Thomas", subdivisions: "Saint Thomas",
coordinates: "18.3381, -64.8941", coordinates: "18.3381, -64.8941",
}; };

View File

@@ -16,11 +16,8 @@ let value: GetGeoDataResponse = {
continentCode: "NA", continentCode: "NA",
country: "United States Virgin Islands", country: "United States Virgin Islands",
city: "Amsterdam", city: "Amsterdam",
europeanUnionMember: true,
timeZone: "America/St_Thomas", timeZone: "America/St_Thomas",
postalCode: "802", postalCode: "802",
inPrivacyRestrictedCountry: true,
inPrivacyRestrictedRegion: true,
subdivisions: "Saint Thomas", subdivisions: "Saint Thomas",
coordinates: "18.3381, -64.8941", coordinates: "18.3381, -64.8941",
}, },

View File

@@ -0,0 +1,19 @@
# GetLibraryItemsEnableCreditsMarkerGeneration
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
## Example Usage
```typescript
import { GetLibraryItemsEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsEnableCreditsMarkerGeneration =
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |

View File

@@ -0,0 +1,19 @@
# GetLibraryItemsEpisodeSort
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
## Example Usage
```typescript
import { GetLibraryItemsEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsEpisodeSort = GetLibraryItemsEpisodeSort.OldestFirst;
```
## Values
| Name | Value |
| ---------------- | ---------------- |
| `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |

View File

@@ -1,16 +1,19 @@
# GetLibraryItemsFlattenSeasons # GetLibraryItemsFlattenSeasons
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
## Example Usage ## Example Usage
```typescript ```typescript
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.True; let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
``` ```
## Values ## Values
| Name | Value | | Name | Value |
| ------- | ------- | | ---------------- | ---------------- |
| `False` | 0 | | `LibraryDefault` | -1 |
| `True` | 1 | | `Hide` | 0 |
| `Show` | 1 |

View File

@@ -3,11 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsLibraryActiveDirection,
GetLibraryItemsLibraryDefaultDirection,
GetLibraryItemsLibraryResponseType,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsLibraryResponseType = { let value: GetLibraryItemsLibraryResponseType = {
key: "/library/sections/2/all?type=2", key: "/library/sections/2/all?type=2",
@@ -27,8 +23,6 @@ let value: GetLibraryItemsLibraryResponseType = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -3,17 +3,11 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsLibraryActiveDirection,
GetLibraryItemsLibraryDefaultDirection,
GetLibraryItemsLibrarySort,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsLibrarySort = { let value: GetLibraryItemsLibrarySort = {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -3,11 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsMedia } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsHasThumbnail,
GetLibraryItemsMedia,
GetLibraryItemsOptimizedForStreaming,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsMedia = { let value: GetLibraryItemsMedia = {
id: 119534, id: 119534,
@@ -25,7 +21,6 @@ let value: GetLibraryItemsMedia = {
videoFrameRate: "24p", videoFrameRate: "24p",
videoProfile: "main 10", videoProfile: "main 10",
hasVoiceActivity: false, hasVoiceActivity: false,
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
has64bitOffsets: false, has64bitOffsets: false,
part: [ part: [
{ {
@@ -41,7 +36,6 @@ let value: GetLibraryItemsMedia = {
optimizedForStreaming: false, optimizedForStreaming: false,
videoProfile: "main 10", videoProfile: "main 10",
indexes: "sd", indexes: "sd",
hasThumbnail: GetLibraryItemsHasThumbnail.True,
stream: [ stream: [
{ {
id: 272796, id: 272796,

View File

@@ -7,16 +7,12 @@ The Meta object is only included in the response if the `includeMeta` parameter
```typescript ```typescript
import { import {
GetLibraryItemsActiveDirection, GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsDefaultDirection, GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons, GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryActiveDirection,
GetLibraryItemsLibraryDefaultDirection,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsMediaContainer, GetLibraryItemsMediaContainer,
GetLibraryItemsOptimizedForStreaming,
GetLibraryItemsShowOrdering, GetLibraryItemsShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
@@ -41,8 +37,6 @@ let value: GetLibraryItemsMediaContainer = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsActiveDirection.Ascending,
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",
@@ -110,8 +104,11 @@ let value: GetLibraryItemsMediaContainer = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True, flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
showOrdering: GetLibraryItemsShowOrdering.Dvd, episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",
@@ -149,7 +146,6 @@ let value: GetLibraryItemsMediaContainer = {
videoFrameRate: "24p", videoFrameRate: "24p",
videoProfile: "main 10", videoProfile: "main 10",
hasVoiceActivity: false, hasVoiceActivity: false,
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
has64bitOffsets: false, has64bitOffsets: false,
part: [ part: [
{ {
@@ -165,7 +161,6 @@ let value: GetLibraryItemsMediaContainer = {
optimizedForStreaming: false, optimizedForStreaming: false,
videoProfile: "main 10", videoProfile: "main 10",
indexes: "sd", indexes: "sd",
hasThumbnail: GetLibraryItemsHasThumbnail.True,
stream: [ stream: [
{ {
id: 272796, id: 272796,
@@ -322,8 +317,6 @@ let value: GetLibraryItemsMediaContainer = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -6,11 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsMeta } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsLibraryActiveDirection,
GetLibraryItemsLibraryDefaultDirection,
GetLibraryItemsMeta,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsMeta = { let value: GetLibraryItemsMeta = {
type: [ type: [
@@ -32,8 +28,6 @@ let value: GetLibraryItemsMeta = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
defaultDirection: GetLibraryItemsLibraryDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -4,12 +4,12 @@
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons, GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsMetadata, GetLibraryItemsMetadata,
GetLibraryItemsOptimizedForStreaming,
GetLibraryItemsShowOrdering, GetLibraryItemsShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types"; import { RFCDate } from "@lukehagar/plexjs/sdk/types";
@@ -34,8 +34,11 @@ let value: GetLibraryItemsMetadata = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True, flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
showOrdering: GetLibraryItemsShowOrdering.Dvd, episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",
@@ -73,7 +76,6 @@ let value: GetLibraryItemsMetadata = {
videoFrameRate: "24p", videoFrameRate: "24p",
videoProfile: "main 10", videoProfile: "main 10",
hasVoiceActivity: false, hasVoiceActivity: false,
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
has64bitOffsets: false, has64bitOffsets: false,
part: [ part: [
{ {
@@ -89,7 +91,6 @@ let value: GetLibraryItemsMetadata = {
optimizedForStreaming: false, optimizedForStreaming: false,
videoProfile: "main 10", videoProfile: "main 10",
indexes: "sd", indexes: "sd",
hasThumbnail: GetLibraryItemsHasThumbnail.True,
stream: [ stream: [
{ {
id: 272796, id: 272796,
@@ -249,8 +250,10 @@ let value: GetLibraryItemsMetadata = {
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 | | `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 | | `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. | | `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | N/A | 1 | | `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show <br/>None = Library default, <br/>tmdbAiring = The Movie Database (Aired), <br/>aired = TheTVDB (Aired), <br/>dvd = TheTVDB (DVD), <br/>absolute = TheTVDB (Absolute)).<br/> | dvd | | `episodeSort` | [operations.GetLibraryItemsEpisodeSort](../../../sdk/models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
| `enableCreditsMarkerGeneration` | [operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../../sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 | | `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/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 | | `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsPart = { let value: GetLibraryItemsPart = {
id: 119542, id: 119542,
@@ -18,7 +18,6 @@ let value: GetLibraryItemsPart = {
optimizedForStreaming: false, optimizedForStreaming: false,
videoProfile: "main 10", videoProfile: "main 10",
indexes: "sd", indexes: "sd",
hasThumbnail: GetLibraryItemsHasThumbnail.True,
stream: [ stream: [
{ {
id: 272796, id: 272796,

View File

@@ -1,6 +1,6 @@
# GetLibraryItemsQueryParamType # GetLibraryItemsQueryParamType
The type of media to retrieve. The type of media to retrieve or filter by.
1 = movie 1 = movie
2 = show 2 = show
3 = season 3 = season
@@ -25,3 +25,5 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
| `Season` | 3 | | `Season` | 3 |
| `Episode` | 4 | | `Episode` | 4 |
| `Audio` | 8 | | `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

View File

@@ -3,32 +3,22 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsQueryParamIncludeMeta,
GetLibraryItemsQueryParamType,
GetLibraryItemsRequest,
IncludeGuids,
Tag,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsRequest = { let value: GetLibraryItemsRequest = {
tag: Tag.FirstCharacter, tag: Tag.Folder,
includeGuids: IncludeGuids.Enable,
type: GetLibraryItemsQueryParamType.TvShow, type: GetLibraryItemsQueryParamType.TvShow,
sectionKey: 9518, sectionKey: 9518,
includeMeta: GetLibraryItemsQueryParamIncludeMeta.Enable,
xPlexContainerStart: 0,
xPlexContainerSize: 50,
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | | | `tag` | [operations.Tag](../../../sdk/models/operations/tag.md) | :heavy_check_mark: | A key representing a specific tag within the section. | |
| `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 | | `includeGuids` | [operations.IncludeGuids](../../../sdk/models/operations/includeguids.md) | :heavy_minus_sign: | Adds the Guids object to the response<br/> | 1 |
| `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_minus_sign: | The type of media to retrieve.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 | | `type` | [operations.GetLibraryItemsQueryParamType](../../../sdk/models/operations/getlibraryitemsqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 | | `sectionKey` | *number* | :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](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 | | `includeMeta` | [operations.GetLibraryItemsQueryParamIncludeMeta](../../../sdk/models/operations/getlibraryitemsqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 | | `xPlexContainerStart` | *number* | :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 |

View File

@@ -4,15 +4,11 @@
```typescript ```typescript
import { import {
GetLibraryItemsActiveDirection, GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsDefaultDirection, GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons, GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryActiveDirection,
GetLibraryItemsLibraryDefaultDirection,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsOptimizedForStreaming,
GetLibraryItemsResponse, GetLibraryItemsResponse,
GetLibraryItemsShowOrdering, GetLibraryItemsShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
@@ -45,8 +41,6 @@ let value: GetLibraryItemsResponse = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsActiveDirection.Ascending,
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",
@@ -114,8 +108,11 @@ let value: GetLibraryItemsResponse = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True, flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
showOrdering: GetLibraryItemsShowOrdering.Dvd, episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",
@@ -153,8 +150,6 @@ let value: GetLibraryItemsResponse = {
videoFrameRate: "24p", videoFrameRate: "24p",
videoProfile: "main 10", videoProfile: "main 10",
hasVoiceActivity: false, hasVoiceActivity: false,
optimizedForStreaming:
GetLibraryItemsOptimizedForStreaming.Enable,
has64bitOffsets: false, has64bitOffsets: false,
part: [ part: [
{ {
@@ -170,7 +165,6 @@ let value: GetLibraryItemsResponse = {
optimizedForStreaming: false, optimizedForStreaming: false,
videoProfile: "main 10", videoProfile: "main 10",
indexes: "sd", indexes: "sd",
hasThumbnail: GetLibraryItemsHasThumbnail.True,
stream: [ stream: [
{ {
id: 272796, id: 272796,
@@ -327,10 +321,6 @@ let value: GetLibraryItemsResponse = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection:
GetLibraryItemsLibraryActiveDirection.Ascending,
defaultDirection:
GetLibraryItemsLibraryDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -6,15 +6,11 @@ The contents of the library by section and tag
```typescript ```typescript
import { import {
GetLibraryItemsActiveDirection, GetLibraryItemsEnableCreditsMarkerGeneration,
GetLibraryItemsDefaultDirection, GetLibraryItemsEpisodeSort,
GetLibraryItemsFlattenSeasons, GetLibraryItemsFlattenSeasons,
GetLibraryItemsHasThumbnail,
GetLibraryItemsLibraryActiveDirection,
GetLibraryItemsLibraryDefaultDirection,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsOptimizedForStreaming,
GetLibraryItemsResponseBody, GetLibraryItemsResponseBody,
GetLibraryItemsShowOrdering, GetLibraryItemsShowOrdering,
} from "@lukehagar/plexjs/sdk/models/operations"; } from "@lukehagar/plexjs/sdk/models/operations";
@@ -41,8 +37,6 @@ let value: GetLibraryItemsResponseBody = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsActiveDirection.Ascending,
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",
@@ -110,8 +104,11 @@ let value: GetLibraryItemsResponseBody = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.True, flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
showOrdering: GetLibraryItemsShowOrdering.Dvd, episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
thumb: "/library/metadata/58683/thumb/1703239236", thumb: "/library/metadata/58683/thumb/1703239236",
art: "/library/metadata/58683/art/1703239236", art: "/library/metadata/58683/art/1703239236",
banner: "/library/metadata/58683/banner/1703239236", banner: "/library/metadata/58683/banner/1703239236",
@@ -149,7 +146,6 @@ let value: GetLibraryItemsResponseBody = {
videoFrameRate: "24p", videoFrameRate: "24p",
videoProfile: "main 10", videoProfile: "main 10",
hasVoiceActivity: false, hasVoiceActivity: false,
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
has64bitOffsets: false, has64bitOffsets: false,
part: [ part: [
{ {
@@ -165,7 +161,6 @@ let value: GetLibraryItemsResponseBody = {
optimizedForStreaming: false, optimizedForStreaming: false,
videoProfile: "main 10", videoProfile: "main 10",
indexes: "sd", indexes: "sd",
hasThumbnail: GetLibraryItemsHasThumbnail.True,
stream: [ stream: [
{ {
id: 272796, id: 272796,
@@ -322,9 +317,6 @@ let value: GetLibraryItemsResponseBody = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsLibraryActiveDirection.Ascending,
defaultDirection:
GetLibraryItemsLibraryDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -1,6 +1,6 @@
# GetLibraryItemsShowOrdering # GetLibraryItemsShowOrdering
Setting that indicates the episode ordering for the show Setting that indicates the episode ordering for the show.
None = Library default, None = Library default,
tmdbAiring = The Movie Database (Aired), tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired), aired = TheTVDB (Aired),
@@ -13,15 +13,16 @@ absolute = TheTVDB (Absolute)).
```typescript ```typescript
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsShowOrdering = GetLibraryItemsShowOrdering.Dvd; let value: GetLibraryItemsShowOrdering =
GetLibraryItemsShowOrdering.TvdbAbsolute;
``` ```
## Values ## Values
| Name | Value | | Name | Value |
| ------------ | ------------ | | -------------- | -------------- |
| `None` | None | | `None` | None |
| `TmdbAiring` | tmdbAiring | | `TmdbAiring` | tmdbAiring |
| `Aired` | aired | | `TvdbAired` | aired |
| `Dvd` | dvd | | `TvdbDvd` | dvd |
| `Absolute` | absolute | | `TvdbAbsolute` | absolute |

View File

@@ -3,17 +3,11 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsSort } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsActiveDirection,
GetLibraryItemsDefaultDirection,
GetLibraryItemsSort,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsSort = { let value: GetLibraryItemsSort = {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsActiveDirection.Ascending,
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -3,11 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
GetLibraryItemsActiveDirection,
GetLibraryItemsDefaultDirection,
GetLibraryItemsType,
} from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsType = { let value: GetLibraryItemsType = {
key: "/library/sections/2/all?type=2", key: "/library/sections/2/all?type=2",
@@ -27,8 +23,6 @@ let value: GetLibraryItemsType = {
{ {
default: "asc", default: "asc",
active: false, active: false,
activeDirection: GetLibraryItemsActiveDirection.Ascending,
defaultDirection: GetLibraryItemsDefaultDirection.Ascending,
descKey: "titleSort:desc", descKey: "titleSort:desc",
firstCharacterKey: "/library/sections/2/firstCharacter", firstCharacterKey: "/library/sections/2/firstCharacter",
key: "titleSort", key: "titleSort",

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataCountry
## Example Usage
```typescript
import { GetMediaMetaDataCountry } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataCountry = {
id: 58591,
filter: "country=58591",
tag: "United States of America",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique country identifier. | 58591 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
| `tag` | *string* | :heavy_check_mark: | The country name. | United States of America |

View File

@@ -1,18 +1,18 @@
# GetMetaDataByRatingKeyRole # GetMediaMetaDataDirector
## Example Usage ## Example Usage
```typescript ```typescript
import { GetMetaDataByRatingKeyRole } from "@lukehagar/plexjs/sdk/models/operations"; import { GetMediaMetaDataDirector } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetaDataByRatingKeyRole = { let value: GetMediaMetaDataDirector = {
id: 220, id: 109501,
filter: "actor=220", filter: "actor=109501",
tag: "Dennis Keiffer", tag: "Bob Odenkirk",
tagKey: "5d77683554f42c001f8c4708", tagKey: "5d77683254f42c001f8c3f69",
role: "Bar Guy (uncredited)", role: "Jimmy McGill",
thumb: thumb:
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg", "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
}; };
``` ```
@@ -20,9 +20,9 @@ let value: GetMetaDataByRatingKeyRole = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `id` | *number* | :heavy_minus_sign: | N/A | 220 | | `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
| `filter` | *string* | :heavy_minus_sign: | N/A | actor=220 | | `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
| `tag` | *string* | :heavy_minus_sign: | N/A | Dennis Keiffer | | `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
| `tagKey` | *string* | :heavy_minus_sign: | N/A | 5d77683554f42c001f8c4708 | | `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
| `role` | *string* | :heavy_minus_sign: | N/A | Bar Guy (uncredited) | | `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
| `thumb` | *string* | :heavy_minus_sign: | N/A | https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg | | `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataGenre
## Example Usage
```typescript
import { GetMediaMetaDataGenre } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataGenre = {
id: 1057,
filter: "genre=1057",
tag: "Crime",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `id` | *number* | :heavy_check_mark: | The unique genre identifier. | 1057 |
| `filter` | *string* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
| `tag` | *string* | :heavy_check_mark: | The genre name. | Crime |

View File

@@ -0,0 +1,21 @@
# GetMediaMetaDataImage
## Example Usage
```typescript
import { GetMediaMetaDataImage } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaMetaDataImage = {
alt: "Better Call Saul",
type: "coverPoster",
url: "/library/metadata/44288/thumb/1736487993",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| `alt` | *string* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
| `type` | *string* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
| `url` | *string* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |

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