Compare commits

...

14 Commits

Author SHA1 Message Date
speakeasybot
6bd12d8759 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.542.1 2025-05-05 00:13:14 +00:00
speakeasybot
891a7d39a1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.541.2 2025-05-01 00:13:53 +00:00
speakeasybot
763aa8e800 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.535.1 2025-04-19 00:12:04 +00:00
speakeasybot
7a950ea773 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.531.4 2025-04-14 00:12:56 +00:00
speakeasybot
379a408d74 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1 2025-04-06 00:12:51 +00:00
speakeasybot
2712820397 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.528.1 2025-04-03 00:12:07 +00:00
speakeasybot
c895213ae8 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 19:44:01 +00:00
Luke Hagar
c473c9d326 Update workflow.yaml 2025-03-31 14:41:40 -05:00
speakeasybot
3c13bba9de ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 19:35:21 +00:00
speakeasybot
650c5043ef ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 16:33:24 +00:00
Luke Hagar
0234804578 correcting label override key value 2025-03-31 11:30:53 -05:00
Luke Hagar
60d913c8f9 adjusting codesample labels 2025-03-28 16:58:29 -05:00
speakeasybot
8d9f4bbaf1 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.4 2025-03-09 00:10:48 +00:00
speakeasybot
5d57cd7c34 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.513.2 2025-03-07 00:11:26 +00:00
402 changed files with 15664 additions and 9071 deletions

6
.gitignore vendored
View File

@@ -1,3 +1,9 @@
.DS_Store
**/.speakeasy/temp/
**/.speakeasy/logs/
.DS_Store
/mcp-server
/bin
/.eslintcache /.eslintcache
/.speakeasy/reports /.speakeasy/reports
/react-query /react-query

View File

@@ -4,6 +4,7 @@
!/REACT_QUERY.md !/REACT_QUERY.md
!/**/*.ts !/**/*.ts
!/**/*.js !/**/*.js
!/**/*.mjs
!/**/*.json !/**/*.json
!/**/*.map !/**/*.map

File diff suppressed because one or more lines are too long

View File

@@ -7,13 +7,16 @@ generation:
useClassNamesForArrayFields: true useClassNamesForArrayFields: true
fixes: fixes:
nameResolutionDec2023: true nameResolutionDec2023: true
nameResolutionFeb2025: false
parameterOrderingFeb2024: true parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true requestResponseComponentNamesFeb2024: true
securityFeb2025: false
sharedErrorComponentsApr2025: false
auth: auth:
oAuth2ClientCredentialsEnabled: true oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false oAuth2PasswordEnabled: false
typescript: typescript:
version: 0.34.0 version: 0.37.2
additionalDependencies: additionalDependencies:
dependencies: {} dependencies: {}
devDependencies: {} devDependencies: {}
@@ -23,6 +26,7 @@ typescript:
clientServerStatusCodesAsErrors: true clientServerStatusCodesAsErrors: true
defaultErrorName: SDKError defaultErrorName: SDKError
enableCustomCodeRegions: false enableCustomCodeRegions: false
enableMCPServer: true
enableReactQuery: false enableReactQuery: false
enumFormat: enum enumFormat: enum
flattenGlobalSecurity: true flattenGlobalSecurity: true
@@ -36,6 +40,7 @@ typescript:
shared: sdk/models/shared shared: sdk/models/shared
webhooks: sdk/models/webhooks webhooks: sdk/models/webhooks
inputModelSuffix: input inputModelSuffix: input
jsonpath: legacy
maxMethodParams: 4 maxMethodParams: 4
methodArguments: require-security-and-request methodArguments: require-security-and-request
moduleFormat: commonjs moduleFormat: commonjs

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.487.1 speakeasyVersion: 1.542.1
sources: sources:
my-source: my-source:
sourceNamespace: my-source sourceNamespace: my-source
@@ -9,20 +9,20 @@ sources:
- main - main
plexapi: plexapi:
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6 sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46 sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
tags: tags:
- latest - latest
- speakeasy-sdk-regen-1739146221 - speakeasy-sdk-regen-1746403916
- 0.0.3 - 0.0.3
targets: targets:
plexjs: plexjs:
source: plexapi source: plexapi
sourceNamespace: plexapi sourceNamespace: plexapi
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6 sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46 sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
codeSamplesNamespace: code-samples-typescript-plexjs codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:18095ae1c50f9a506f370f124c16b4b0d5ebe8ec15c006e533371285a7201fb3 codeSamplesRevisionDigest: sha256:945657568eb11e06b45691a4a4a058c37170f5919329abbb42e23a5016781ba8
workflow: workflow:
workflowVersion: 1.0.0 workflowVersion: 1.0.0
speakeasyVersion: latest speakeasyVersion: latest
@@ -43,3 +43,5 @@ workflow:
output: codeSamples.yaml output: codeSamples.yaml
registry: registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
labelOverride:
fixedValue: PlexJS

View File

@@ -17,3 +17,5 @@ targets:
output: codeSamples.yaml output: codeSamples.yaml
registry: registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
labelOverride:
fixedValue: PlexJS

View File

@@ -54,6 +54,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
* [Authentication](#authentication) * [Authentication](#authentication)
* [Requirements](#requirements) * [Requirements](#requirements)
* [Standalone functions](#standalone-functions) * [Standalone functions](#standalone-functions)
* [File uploads](#file-uploads)
* [Retries](#retries) * [Retries](#retries)
* [Debugging](#debugging) * [Debugging](#debugging)
* [Development](#development) * [Development](#development)
@@ -167,9 +168,12 @@ run();
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors 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
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata * [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
* [getMediaArts](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
* [postMediaArts](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
* [getMediaPosters](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
* [postMediaPoster](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
* [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
### [log](docs/sdks/log/README.md) ### [log](docs/sdks/log/README.md)
@@ -344,13 +348,39 @@ In some rare cases, the SDK can fail to get a response from the server or even m
### Server Variables ### Server Variables
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: 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:
* `protocol: models.ServerProtocol`
* `ip: string` | Variable | Parameter | Supported Values | Default | Description |
* `port: string` | ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
#### Example
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
protocol: "https",
ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
port: "40311",
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.server.getServerCapabilities();
// Handle the result
console.log(result);
}
run();
```
### 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: string` optional parameter when initializing the SDK client instance. For example: The default server can 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";
@@ -518,14 +548,17 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media - [`libraryGetGenresLibrary`](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details - [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items - [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
- [`libraryGetMediaArts`](docs/sdks/library/README.md#getmediaarts) - Get Media Background Artwork
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata - [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
- [`libraryGetMediaPosters`](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children - [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added - [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library - [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries - [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library - [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
- [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content - [`libraryGetTopWatchedContent`](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
- [`libraryPostMediaArts`](docs/sdks/library/README.md#postmediaarts) - Upload Media Background Artwork
- [`libraryPostMediaPoster`](docs/sdks/library/README.md#postmediaposter) - Upload Media Poster
- [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail - [`logEnablePaperTrail`](docs/sdks/log/README.md#enablepapertrail) - Enabling Papertrail
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message. - [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message - [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
@@ -580,6 +613,44 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
</details> </details>
<!-- End Standalone functions [standalone-funcs] --> <!-- End Standalone functions [standalone-funcs] -->
<!-- Start File uploads [file-upload] -->
## File uploads
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
> [!TIP]
>
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
>
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
```typescript
import { PlexAPI } from "@lukehagar/plexjs";
import { openAsBlob } from "node:fs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.postMediaArts(
2268,
await openAsBlob("example.file"),
"https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b",
);
// Handle the result
console.log(result);
}
run();
```
<!-- End File uploads [file-upload] -->
<!-- Start Retries [retries] --> <!-- Start Retries [retries] -->
## Retries ## Retries

View File

@@ -1228,4 +1228,114 @@ Based on:
### Generated ### Generated
- [typescript v0.34.0] . - [typescript v0.34.0] .
### Releases ### Releases
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - . - [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
## 2025-03-07 00:09:55
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.0] .
### Releases
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
## 2025-03-09 00:09:12
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.1] .
### Releases
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
## 2025-03-31 16:31:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.2] .
### Releases
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
## 2025-03-31 19:33:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.3] .
### Releases
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
## 2025-03-31 19:42:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.4] .
### Releases
- [NPM v0.35.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.4 - .
## 2025-04-03 00:10:29
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.36.0] .
### Releases
- [NPM v0.36.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.0 - .
## 2025-04-06 00:11:19
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.36.1] .
### Releases
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .
## 2025-04-14 00:11:23
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.36.2] .
### Releases
- [NPM v0.36.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.2 - .
## 2025-04-19 00:10:19
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.37.0] .
### Releases
- [NPM v0.37.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.0 - .
## 2025-05-01 00:12:16
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.37.1] .
### Releases
- [NPM v0.37.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.1 - .
## 2025-05-05 00:11:37
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.542.1 (2.597.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.37.2] .
### Releases
- [NPM v0.37.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.2 - .

View File

@@ -7,7 +7,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getServerCapabilities label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -27,7 +27,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getServerPreferences label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -47,7 +47,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: updatePlayProgress label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -67,7 +67,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: markPlayed label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -87,7 +87,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getTimeline label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { State } from "@lukehagar/plexjs/sdk/models/operations"; import { State } from "@lukehagar/plexjs/sdk/models/operations";
@@ -119,7 +119,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: markUnplayed label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -139,7 +139,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getServerActivities label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -159,7 +159,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: cancelServerActivities label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -179,7 +179,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: stopAllTasks label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -199,7 +199,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getButlerTasks label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -219,7 +219,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: startAllTasks label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -239,7 +239,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: stopTask label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations"; import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
@@ -260,7 +260,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: startTask label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations"; import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
@@ -281,7 +281,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getAvailableClients label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -301,7 +301,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getCompanionsData label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -321,7 +321,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getDevices label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -341,7 +341,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getUserFriends label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -361,7 +361,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getGeoData label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -379,7 +379,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getHomeData label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -399,7 +399,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getGlobalHubs label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -419,7 +419,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: added label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Type } from "@lukehagar/plexjs/sdk/models/operations"; import { Type } from "@lukehagar/plexjs/sdk/models/operations";
@@ -444,7 +444,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: performSearch label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -464,7 +464,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: performVoiceSearch label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -484,7 +484,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getLibraryHubs label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -504,7 +504,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: identity label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -522,7 +522,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getTopWatchedContent label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -543,7 +543,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getFileHash label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -563,7 +563,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: data label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -593,12 +593,53 @@ actions:
console.log(result); console.log(result);
} }
run();
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["get"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getMediaArts(16099);
// Handle the result
console.log(result);
}
run();
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["post"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { openAsBlob } from "node:fs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.postMediaArts(2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
// Handle the result
console.log(result);
}
run(); run();
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"] - target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: image label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -625,7 +666,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getMetadataChildren label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -640,12 +681,53 @@ actions:
console.log(result); console.log(result);
} }
run();
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["get"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getMediaPosters(16099);
// Handle the result
console.log(result);
}
run();
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["post"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { openAsBlob } from "node:fs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.postMediaPoster(2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
// Handle the result
console.log(result);
}
run(); run();
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"] - target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: image label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -667,32 +749,12 @@ actions:
console.log(result); console.log(result);
} }
run();
- target: $["paths"]["/library/onDeck"]["get"]
update:
x-codeSamples:
- lang: typescript
label: getOnDeck
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getOnDeck();
// Handle the result
console.log(result);
}
run(); run();
- target: $["paths"]["/library/recentlyAdded"]["get"] - target: $["paths"]["/library/recentlyAdded"]["get"]
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: library label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -731,7 +793,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: libraries label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations"; import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
@@ -758,7 +820,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: libraries label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -778,7 +840,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: list label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Filter } from "@lukehagar/plexjs/sdk/models/operations"; import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
@@ -802,7 +864,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: deleteLibrary label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -822,7 +884,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: details label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -842,7 +904,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: library label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -863,7 +925,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: library label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -887,7 +949,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: library label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -908,7 +970,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: library label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -929,7 +991,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: metadata label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Force } from "@lukehagar/plexjs/sdk/models/operations"; import { Force } from "@lukehagar/plexjs/sdk/models/operations";
@@ -950,7 +1012,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: library label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -971,7 +1033,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: items label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
@@ -996,7 +1058,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: logLine label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Level } from "@lukehagar/plexjs/sdk/models/operations"; import { Level } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1017,7 +1079,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: logMultiLine label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1039,7 +1101,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: enablePaperTrail label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1059,7 +1121,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: providers label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1079,7 +1141,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getMyPlexAccount label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1099,7 +1161,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getResizedPhoto label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations"; import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1128,7 +1190,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getPin label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1152,7 +1214,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getTokenByPinId label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1177,7 +1239,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getPlaylists label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1197,7 +1259,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: createPlaylist label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations"; import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1223,7 +1285,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: uploadPlaylist label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations"; import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1244,7 +1306,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: deletePlaylist label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1264,7 +1326,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getPlaylist label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1284,7 +1346,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: updatePlaylist label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1304,7 +1366,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: clearPlaylistContents label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1324,7 +1386,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getPlaylistContents label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1345,7 +1407,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: addPlaylistContents label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1365,7 +1427,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: resources label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1385,7 +1447,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getSearchResults label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1405,7 +1467,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getSourceConnectionInformation label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1425,7 +1487,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getTransientToken label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations"; import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1446,7 +1508,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getServerList label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1466,7 +1528,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getBandwidthStatistics label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1486,7 +1548,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getStatistics label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1506,7 +1568,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getResourcesStatistics label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1526,7 +1588,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getSessions label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1546,7 +1608,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getSessionHistory label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1566,7 +1628,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getTranscodeSessions label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1586,7 +1648,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: stopTranscodeSession label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1606,7 +1668,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: applyUpdates label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations"; import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1627,7 +1689,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: checkForUpdates label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
import { Download } from "@lukehagar/plexjs/sdk/models/operations"; import { Download } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1648,7 +1710,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getUpdateStatus label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1668,7 +1730,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: getTokenDetails label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1688,7 +1750,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: users label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1720,7 +1782,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: data label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";
@@ -1749,7 +1811,7 @@ actions:
update: update:
x-codeSamples: x-codeSamples:
- lang: typescript - lang: typescript
label: startUniversalTranscode label: PlexJS
source: |- source: |-
import { PlexAPI } from "@lukehagar/plexjs"; import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -1,18 +0,0 @@
# GetOnDeckBadRequest
Bad Request - A parameter was not specified, or was specified incorrectly.
## Example Usage
```typescript
import { GetOnDeckBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `errors` | [errors.GetOnDeckErrors](../../../sdk/models/errors/getondeckerrors.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,21 +0,0 @@
# GetOnDeckErrors
## Example Usage
```typescript
import { GetOnDeckErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetOnDeckErrors = {
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

@@ -1,21 +0,0 @@
# GetOnDeckLibraryErrors
## Example Usage
```typescript
import { GetOnDeckLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
let value: GetOnDeckLibraryErrors = {
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

@@ -1,18 +0,0 @@
# GetOnDeckUnauthorized
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
## Example Usage
```typescript
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
// No examples available for this model
```
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `errors` | [errors.GetOnDeckLibraryErrors](../../../sdk/models/errors/getondecklibraryerrors.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

@@ -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: 3741.7, playlistID: 1207.42,
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: 302, statusCode: 207,
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 { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: ApplyUpdatesResponse = { let value: ApplyUpdatesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 428, statusCode: 200,
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 @@
# Attributes
Attributes associated with the marker.
## Example Usage
```typescript
import { Attributes } from "@lukehagar/plexjs/sdk/models/operations";
let value: Attributes = {
id: 306970,
version: 4,
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
| `version` | *number* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |

View File

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

View File

@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/ope
let value: CancelServerActivitiesResponse = { let value: CancelServerActivitiesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 417, statusCode: 405,
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,29 @@
# Chapter
The thumbnail for the chapter
## Example Usage
```typescript
import { Chapter } from "@lukehagar/plexjs/sdk/models/operations";
let value: Chapter = {
id: 4,
filter: "thumb=4",
index: 1,
startTimeOffset: 0,
endTimeOffset: 100100,
thumb: "/library/media/46883/chapterImages/1",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
| `id` | *number* | :heavy_check_mark: | N/A | 4 |
| `filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
| `index` | *number* | :heavy_check_mark: | N/A | 1 |
| `startTimeOffset` | *number* | :heavy_check_mark: | N/A | 0 |
| `endTimeOffset` | *number* | :heavy_check_mark: | N/A | 100100 |
| `thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |

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: 508, statusCode: 504,
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: 256.62, playlistID: 5077.01,
}; };
``` ```

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: 204, statusCode: 504,
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,12 +6,12 @@
import { Collection } from "@lukehagar/plexjs/sdk/models/operations"; import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
let value: Collection = { let value: Collection = {
tag: "Working NL Subs", tag: "My Awesome Collection",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs | | `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

View File

@@ -7,9 +7,9 @@ import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
let value: Connections = { let value: Connections = {
protocol: Protocol.Http, protocol: Protocol.Http,
address: "21611 Schuster Cliffs", address: "84577 W 9th Street",
port: 54915, port: 40036,
uri: "https://wobbly-instance.org/", uri: "https://dearest-custom.net",
local: false, local: false,
relay: false, relay: false,
iPv6: false, iPv6: false,

View File

@@ -1,17 +1,23 @@
# Country # Country
The filter query string for country media items.
## Example Usage ## Example Usage
```typescript ```typescript
import { Country } from "@lukehagar/plexjs/sdk/models/operations"; import { Country } from "@lukehagar/plexjs/sdk/models/operations";
let value: Country = { let value: Country = {
id: 259,
tag: "United States of America", tag: "United States of America",
filter: "country=19",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America | | `id` | *number* | :heavy_check_mark: | N/A | 259 |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
| `filter` | *string* | :heavy_minus_sign: | N/A | country=19 |

View File

@@ -7,13 +7,16 @@ type of playlist to create
```typescript ```typescript
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations"; import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video; let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
``` ```
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ------- | ------- |
| `Audio` | audio | | Name | Value |
| `Video` | video | | ---------------------- | ---------------------- |
| `Photo` | photo | | `Audio` | audio |
| `Video` | video |
| `Photo` | photo |
| - | `Unrecognized<string>` |

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.Audio,
smart: Smart.One, smart: Smart.Zero,
uri: "https://radiant-dividend.com/", uri: "https://courageous-futon.net",
}; };
``` ```

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: 409, statusCode: 510,
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 { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: DeleteLibraryResponse = { let value: DeleteLibraryResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 507, 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: 1856.36, playlistID: 5840.32,
}; };
``` ```

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: 507, 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

@@ -6,12 +6,12 @@
import { Director } from "@lukehagar/plexjs/sdk/models/operations"; import { Director } from "@lukehagar/plexjs/sdk/models/operations";
let value: Director = { let value: Director = {
tag: "James Cameron", tag: "Danny Boyle",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron | | `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |

View File

@@ -13,7 +13,10 @@ let value: EnableCreditsMarkerGeneration =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ---------------- | ---------------- |
| `LibraryDefault` | -1 | | Name | Value |
| `Disabled` | 0 | | ---------------------- | ---------------------- |
| `LibraryDefault` | -1 |
| `Disabled` | 0 |
| - | `Unrecognized<string>` |

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: 102, statusCode: 416,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -12,8 +12,11 @@ let value: EpisodeSort = EpisodeSort.OldestFirst;
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ---------------- | ---------------- |
| `LibraryDefault` | -1 | | Name | Value |
| `OldestFirst` | 0 | | ---------------------- | ---------------------- |
| `NewestFirst` | 1 | | `LibraryDefault` | -1 |
| `OldestFirst` | 0 |
| `NewestFirst` | 1 |
| - | `Unrecognized<string>` |

View File

@@ -0,0 +1,17 @@
# Extras
## Example Usage
```typescript
import { Extras } from "@lukehagar/plexjs/sdk/models/operations";
let value: Extras = {
size: 1,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
| `size` | *number* | :heavy_minus_sign: | The size of the extras. | 1 |

View File

@@ -7,13 +7,16 @@ Filter
```typescript ```typescript
import { Filter } from "@lukehagar/plexjs/sdk/models/operations"; import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
let value: Filter = Filter.All; let value: Filter = Filter.Available;
``` ```
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ----------- | ----------- |
| `All` | all | | Name | Value |
| `Available` | available | | ---------------------- | ---------------------- |
| `Released` | released | | `All` | all |
| `Available` | available |
| `Released` | released |
| - | `Unrecognized<string>` |

View File

@@ -12,8 +12,11 @@ let value: FlattenSeasons = FlattenSeasons.Show;
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ---------------- | ---------------- |
| `LibraryDefault` | -1 | | Name | Value |
| `Hide` | 0 | | ---------------------- | ---------------------- |
| `Show` | 1 | | `LibraryDefault` | -1 |
| `Hide` | 0 |
| `Show` | 1 |
| - | `Unrecognized<string>` |

View File

@@ -7,7 +7,7 @@ Force the refresh even if the library is already being refreshed.
```typescript ```typescript
import { Force } from "@lukehagar/plexjs/sdk/models/operations"; import { Force } from "@lukehagar/plexjs/sdk/models/operations";
let value: Force = Force.One; let value: Force = Force.Zero;
``` ```
## Values ## Values

View File

@@ -1,17 +1,23 @@
# Genre # Genre
The filter query string for similar items.
## Example Usage ## Example Usage
```typescript ```typescript
import { Genre } from "@lukehagar/plexjs/sdk/models/operations"; import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
let value: Genre = { let value: Genre = {
tag: "Adventure", id: 259,
filter: "genre=19",
tag: "Crime",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure | | `id` | *number* | :heavy_check_mark: | N/A | 259 |
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

View File

@@ -19,12 +19,15 @@ let value: GetActorsLibraryQueryParamType =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| --------- | --------- |
| `Movie` | 1 | | Name | Value |
| `TvShow` | 2 | | ---------------------- | ---------------------- |
| `Season` | 3 | | `Movie` | 1 |
| `Episode` | 4 | | `TvShow` | 2 |
| `Audio` | 8 | | `Season` | 3 |
| `Album` | 9 | | `Episode` | 4 |
| `Track` | 10 | | `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

View File

@@ -3,33 +3,32 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllLibrariesDirectory, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesDirectory = { let value: GetAllLibrariesDirectory = {
allowSync: true, allowSync: false,
art: "/:/resources/movie-fanart.jpg", art: "/:/resources/show-fanart.jpg",
composite: "/library/sections/1/composite/1705615584", composite: "/library/sections/1/composite/1743824484",
filters: true, filters: true,
refreshing: false, refreshing: true,
thumb: "/:/resources/movie.png", thumb: "/:/resources/show.png",
key: "1", key: "1",
type: "movie", type: GetAllLibrariesType.Movie,
title: "Movies", title: "Movies",
agent: "tv.plex.agents.movie", agent: "tv.plex.agents.movie",
scanner: "Plex Movie", scanner: "Plex Movie",
language: "en-US", language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30", uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
updatedAt: 1556281940, updatedAt: 1556281940,
createdAt: 1556281940, createdAt: 1556281940,
scannedAt: 1556281940, scannedAt: 1556281940,
content: true, content: true,
directory: true, directory: true,
contentChangedAt: 1556281940, contentChangedAt: 9173960,
hidden: 0,
location: [ location: [
{ {
id: 1, id: 1,
path: "/movies", path: "/Movies",
}, },
], ],
}; };
@@ -37,26 +36,26 @@ let value: GetAllLibrariesDirectory = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true | | `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg | | `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 | | `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
| `filters` | *boolean* | :heavy_check_mark: | N/A | true | | `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false | | `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png | | `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `key` | *string* | :heavy_check_mark: | N/A | 1 | | `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
| `type` | *string* | :heavy_check_mark: | N/A | movie | | `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Movies | | `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie | | `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie | | `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
| `language` | *string* | :heavy_check_mark: | N/A | en-US | | `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 | | `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *boolean* | :heavy_check_mark: | N/A | true | | `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
| `directory` | *boolean* | :heavy_check_mark: | N/A | true | | `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 | | `contentChangedAt` | *number* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 | | `hidden` | [operations.Hidden](../../../sdk/models/operations/hidden.md) | :heavy_minus_sign: | The Plex library visibility setting | 1 |
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | | | `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |

View File

@@ -7,13 +7,13 @@ import { GetAllLibrariesLocation } from "@lukehagar/plexjs/sdk/models/operations
let value: GetAllLibrariesLocation = { let value: GetAllLibrariesLocation = {
id: 1, id: 1,
path: "/movies", path: "/Movies",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `id` | *number* | :heavy_check_mark: | N/A | 1 | | `id` | *number* | :heavy_check_mark: | The ID of the location. | 1 |
| `path` | *string* | :heavy_check_mark: | N/A | /movies | | `path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |

View File

@@ -3,38 +3,37 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllLibrariesMediaContainer, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesMediaContainer = { let value: GetAllLibrariesMediaContainer = {
size: 5, size: 50,
allowSync: false, allowSync: false,
title1: "Plex Library", title1: "TV Series",
directory: [ directory: [
{ {
allowSync: true, allowSync: false,
art: "/:/resources/movie-fanart.jpg", art: "/:/resources/show-fanart.jpg",
composite: "/library/sections/1/composite/1705615584", composite: "/library/sections/1/composite/1743824484",
filters: true, filters: true,
refreshing: false, refreshing: true,
thumb: "/:/resources/movie.png", thumb: "/:/resources/show.png",
key: "1", key: "1",
type: "movie", type: GetAllLibrariesType.Movie,
title: "Movies", title: "Movies",
agent: "tv.plex.agents.movie", agent: "tv.plex.agents.movie",
scanner: "Plex Movie", scanner: "Plex Movie",
language: "en-US", language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30", uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
updatedAt: 1556281940, updatedAt: 1556281940,
createdAt: 1556281940, createdAt: 1556281940,
scannedAt: 1556281940, scannedAt: 1556281940,
content: true, content: true,
directory: true, directory: true,
contentChangedAt: 1556281940, contentChangedAt: 9173960,
hidden: 0,
location: [ location: [
{ {
id: 1, id: 1,
path: "/movies", path: "/Movies",
}, },
], ],
}, },
@@ -46,7 +45,7 @@ let value: GetAllLibrariesMediaContainer = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | N/A | 5 | | `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false | | `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library | | `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_check_mark: | N/A | | | `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -3,45 +3,44 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllLibrariesResponse, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesResponse = { let value: GetAllLibrariesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 308, statusCode: 101,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
object: { object: {
mediaContainer: { mediaContainer: {
size: 5, size: 50,
allowSync: false, allowSync: false,
title1: "Plex Library", title1: "TV Series",
directory: [ directory: [
{ {
allowSync: true, allowSync: false,
art: "/:/resources/movie-fanart.jpg", art: "/:/resources/show-fanart.jpg",
composite: "/library/sections/1/composite/1705615584", composite: "/library/sections/1/composite/1743824484",
filters: true, filters: true,
refreshing: false, refreshing: true,
thumb: "/:/resources/movie.png", thumb: "/:/resources/show.png",
key: "1", key: "1",
type: "movie", type: GetAllLibrariesType.Movie,
title: "Movies", title: "Movies",
agent: "tv.plex.agents.movie", agent: "tv.plex.agents.movie",
scanner: "Plex Movie", scanner: "Plex Movie",
language: "en-US", language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30", uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
updatedAt: 1556281940, updatedAt: 1556281940,
createdAt: 1556281940, createdAt: 1556281940,
scannedAt: 1556281940, scannedAt: 1556281940,
content: true, content: true,
directory: true, directory: true,
contentChangedAt: 1556281940, contentChangedAt: 9173960,
hidden: 0,
location: [ location: [
{ {
id: 1, id: 1,
path: "/movies", path: "/Movies",
}, },
], ],
}, },

View File

@@ -5,39 +5,38 @@ The libraries available on the Server
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllLibrariesResponseBody, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesResponseBody = { let value: GetAllLibrariesResponseBody = {
mediaContainer: { mediaContainer: {
size: 5, size: 50,
allowSync: false, allowSync: false,
title1: "Plex Library", title1: "TV Series",
directory: [ directory: [
{ {
allowSync: true, allowSync: false,
art: "/:/resources/movie-fanart.jpg", art: "/:/resources/show-fanart.jpg",
composite: "/library/sections/1/composite/1705615584", composite: "/library/sections/1/composite/1743824484",
filters: true, filters: true,
refreshing: false, refreshing: true,
thumb: "/:/resources/movie.png", thumb: "/:/resources/show.png",
key: "1", key: "1",
type: "movie", type: GetAllLibrariesType.Movie,
title: "Movies", title: "Movies",
agent: "tv.plex.agents.movie", agent: "tv.plex.agents.movie",
scanner: "Plex Movie", scanner: "Plex Movie",
language: "en-US", language: "en-US",
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30", uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
updatedAt: 1556281940, updatedAt: 1556281940,
createdAt: 1556281940, createdAt: 1556281940,
scannedAt: 1556281940, scannedAt: 1556281940,
content: true, content: true,
directory: true, directory: true,
contentChangedAt: 1556281940, contentChangedAt: 9173960,
hidden: 0,
location: [ location: [
{ {
id: 1, id: 1,
path: "/movies", path: "/Movies",
}, },
], ],
}, },
@@ -50,4 +49,4 @@ let value: GetAllLibrariesResponseBody = {
| Field | Type | Required | Description | | Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_check_mark: | N/A | | `mediaContainer` | [operations.GetAllLibrariesMediaContainer](../../../sdk/models/operations/getalllibrariesmediacontainer.md) | :heavy_minus_sign: | N/A |

View File

@@ -0,0 +1,25 @@
# GetAllLibrariesType
The library type
## Example Usage
```typescript
import { GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesType = GetAllLibrariesType.Movie;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

View File

@@ -6,12 +6,12 @@
import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryGenre = { let value: GetAllMediaLibraryGenre = {
tag: "United States of America", tag: "Crime",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America | | `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |

View File

@@ -0,0 +1,17 @@
# GetAllMediaLibraryGuids
## Example Usage
```typescript
import { GetAllMediaLibraryGuids } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryGuids = {
id: "tvdb://2337",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

View File

@@ -11,9 +11,12 @@ let value: GetAllMediaLibraryLibraryResponseType =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ------------- | ------------- |
| `CoverPoster` | coverPoster | | Name | Value |
| `Background` | background | | ---------------------- | ---------------------- |
| `Snapshot` | snapshot | | `CoverPoster` | coverPoster |
| `ClearLogo` | clearLogo | | `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| - | `Unrecognized<string>` |

View File

@@ -13,11 +13,14 @@ let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| --------- | --------- |
| `Movie` | movie | | Name | Value |
| `TvShow` | show | | ---------------------- | ---------------------- |
| `Season` | season | | `Movie` | movie |
| `Episode` | episode | | `TvShow` | show |
| `Artist` | artist | | `Season` | season |
| `Album` | album | | `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllMediaLibraryMedia } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryMedia, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryMedia = { let value: GetAllMediaLibraryMedia = {
id: 387322, id: 387322,
@@ -41,7 +41,8 @@ let value: GetAllMediaLibraryMedia = {
stream: [ stream: [
{ {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -63,17 +64,20 @@ let value: GetAllMediaLibraryMedia = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -112,8 +116,8 @@ let value: GetAllMediaLibraryMedia = {
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv | | `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p | | `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 | | `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false | | `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts | | `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | | | `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false | | `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_check_mark: | An array of parts for this media item. | | | `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |

View File

@@ -7,6 +7,7 @@ import {
GetAllMediaLibraryLibraryResponseType, GetAllMediaLibraryLibraryResponseType,
GetAllMediaLibraryLibraryType, GetAllMediaLibraryLibraryType,
GetAllMediaLibraryMediaContainer, GetAllMediaLibraryMediaContainer,
GetAllMediaLibraryStreamType,
} 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";
@@ -188,7 +189,8 @@ let value: GetAllMediaLibraryMediaContainer = {
stream: [ stream: [
{ {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -210,17 +212,20 @@ let value: GetAllMediaLibraryMediaContainer = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -242,7 +247,7 @@ let value: GetAllMediaLibraryMediaContainer = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -257,12 +262,12 @@ let value: GetAllMediaLibraryMediaContainer = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [

View File

@@ -10,6 +10,7 @@ import {
GetAllMediaLibraryLibraryResponseType, GetAllMediaLibraryLibraryResponseType,
GetAllMediaLibraryLibraryType, GetAllMediaLibraryLibraryType,
GetAllMediaLibraryMetadata, GetAllMediaLibraryMetadata,
GetAllMediaLibraryStreamType,
} 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";
@@ -122,7 +123,8 @@ let value: GetAllMediaLibraryMetadata = {
stream: [ stream: [
{ {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -144,17 +146,20 @@ let value: GetAllMediaLibraryMetadata = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -176,7 +181,7 @@ let value: GetAllMediaLibraryMetadata = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -191,12 +196,12 @@ let value: GetAllMediaLibraryMetadata = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [
@@ -228,7 +233,7 @@ let value: GetAllMediaLibraryMetadata = {
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> | | `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 | | `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 | | `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `year` | *number* | :heavy_check_mark: | The release year of the media item. | 2022 | | `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. | | `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 | | `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 | | `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
@@ -278,5 +283,5 @@ let value: GetAllMediaLibraryMetadata = {
| `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | | | `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | |
| `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | | | `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | | | `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | |
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | | | `guids` | [operations.GetAllMediaLibraryGuids](../../../sdk/models/operations/getallmedialibraryguids.md)[] | :heavy_minus_sign: | N/A | |
| `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | | | `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | |

View File

@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
## Supported Types ## Supported Types
### `operations.One` ### `operations.OptimizedForStreaming1`
```typescript ```typescript
const value: operations.One = One.One; const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
``` ```
### `boolean` ### `boolean`

View File

@@ -6,7 +6,7 @@
import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryOptimizedForStreaming1 = let value: GetAllMediaLibraryOptimizedForStreaming1 =
GetAllMediaLibraryOptimizedForStreaming1.Zero; GetAllMediaLibraryOptimizedForStreaming1.One;
``` ```
## Values ## Values

View File

@@ -3,7 +3,7 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllMediaLibraryPart } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryPart, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryPart = { let value: GetAllMediaLibraryPart = {
accessible: true, accessible: true,
@@ -22,7 +22,8 @@ let value: GetAllMediaLibraryPart = {
stream: [ stream: [
{ {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -44,17 +45,20 @@ let value: GetAllMediaLibraryPart = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",

View File

@@ -19,12 +19,15 @@ let value: GetAllMediaLibraryQueryParamType =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| --------- | --------- |
| `Movie` | 1 | | Name | Value |
| `TvShow` | 2 | | ---------------------- | ---------------------- |
| `Season` | 3 | | `Movie` | 1 |
| `Episode` | 4 | | `TvShow` | 2 |
| `Audio` | 8 | | `Season` | 3 |
| `Album` | 9 | | `Episode` | 4 |
| `Track` | 10 | | `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

View File

@@ -7,12 +7,13 @@ import {
GetAllMediaLibraryLibraryResponseType, GetAllMediaLibraryLibraryResponseType,
GetAllMediaLibraryLibraryType, GetAllMediaLibraryLibraryType,
GetAllMediaLibraryResponse, GetAllMediaLibraryResponse,
GetAllMediaLibraryStreamType,
} 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";
let value: GetAllMediaLibraryResponse = { let value: GetAllMediaLibraryResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 103, statusCode: 505,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
@@ -195,7 +196,8 @@ let value: GetAllMediaLibraryResponse = {
stream: [ stream: [
{ {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -217,17 +219,20 @@ let value: GetAllMediaLibraryResponse = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -249,7 +254,7 @@ let value: GetAllMediaLibraryResponse = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -264,12 +269,12 @@ let value: GetAllMediaLibraryResponse = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [

View File

@@ -9,6 +9,7 @@ import {
GetAllMediaLibraryLibraryResponseType, GetAllMediaLibraryLibraryResponseType,
GetAllMediaLibraryLibraryType, GetAllMediaLibraryLibraryType,
GetAllMediaLibraryResponseBody, GetAllMediaLibraryResponseBody,
GetAllMediaLibraryStreamType,
} 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";
@@ -191,7 +192,8 @@ let value: GetAllMediaLibraryResponseBody = {
stream: [ stream: [
{ {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -213,17 +215,20 @@ let value: GetAllMediaLibraryResponseBody = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -245,7 +250,7 @@ let value: GetAllMediaLibraryResponseBody = {
], ],
genre: [ genre: [
{ {
tag: "United States of America", tag: "Crime",
}, },
], ],
country: [ country: [
@@ -260,12 +265,12 @@ let value: GetAllMediaLibraryResponseBody = {
], ],
writer: [ writer: [
{ {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}, },
], ],
role: [ role: [
{ {
tag: "Danny Boyle", tag: "Teller",
}, },
], ],
guids: [ guids: [

View File

@@ -6,12 +6,12 @@
import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryRole = { let value: GetAllMediaLibraryRole = {
tag: "Danny Boyle", tag: "Teller",
}; };
``` ```
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle | | `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |

View File

@@ -3,11 +3,12 @@
## Example Usage ## Example Usage
```typescript ```typescript
import { GetAllMediaLibraryStream } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryStream, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryStream = { let value: GetAllMediaLibraryStream = {
id: 1002625, id: 1002625,
streamType: 1, streamType: GetAllMediaLibraryStreamType.Video,
format: "srt",
default: true, default: true,
codec: "hevc", codec: "hevc",
index: 0, index: 0,
@@ -29,17 +30,20 @@ let value: GetAllMediaLibraryStream = {
chromaSubsampling: "4:2:0", chromaSubsampling: "4:2:0",
codedHeight: 1608, codedHeight: 1608,
codedWidth: 3840, codedWidth: 3840,
closedCaptions: true,
colorPrimaries: "bt2020", colorPrimaries: "bt2020",
colorRange: "tv", colorRange: "tv",
colorSpace: "bt2020nc", colorSpace: "bt2020nc",
colorTrc: "smpte2084", colorTrc: "smpte2084",
frameRate: 23.976, frameRate: 23.976,
key: "/library/streams/216389",
height: 1602, height: 1602,
level: 150, level: 150,
original: true, original: true,
hasScalingMatrix: false, hasScalingMatrix: false,
profile: "main 10", profile: "main 10",
scanType: "progressive", scanType: "progressive",
embeddedInVideo: "progressive",
refFrames: 1, refFrames: 1,
width: 3840, width: 3840,
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)", displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
@@ -58,52 +62,56 @@ let value: GetAllMediaLibraryStream = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 | | `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 | | `streamType` | [operations.GetAllMediaLibraryStreamType](../../../sdk/models/operations/getallmedialibrarystreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true | | `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc | | `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 | | `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 | | `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English | | `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en | | `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng | | `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true | | `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 | | `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true | | `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false | | `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 | | `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true | | `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 | | `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true | | `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 | | `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 | | `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft | | `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 | | `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 | | `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 | | `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 | | `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv | | `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc | | `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 | | `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 | | `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 | | `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 | | `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true | | `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false | | `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 | | `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive | | `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 | | `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 | | `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) | | `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) | | `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true | | `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true | | `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 | | `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) | | `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 | | `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false | | `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true | | `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true | | `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH | | `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryStreamType
Stream type:
- 1 = video
- 2 = audio
- 3 = subtitle
## Example Usage
```typescript
import { GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryStreamType = GetAllMediaLibraryStreamType.Video;
```
## Values
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| Name | Value |
| ---------------------- | ---------------------- |
| `Video` | 1 |
| `Audio` | 2 |
| `Subtitle` | 3 |
| - | `Unrecognized<number>` |

View File

@@ -6,7 +6,7 @@
import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations"; import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllMediaLibraryWriter = { let value: GetAllMediaLibraryWriter = {
tag: "Danny Boyle", tag: "Jamie P. Hanson",
}; };
``` ```
@@ -14,4 +14,4 @@ let value: GetAllMediaLibraryWriter = {
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle | | `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |

View File

@@ -7,7 +7,7 @@ import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operat
let value: GetAvailableClientsResponse = { let value: GetAvailableClientsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 305, statusCode: 308,
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 { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
let value: GetBandwidthStatisticsResponse = { let value: GetBandwidthStatisticsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 424, 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 { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations"
let value: GetButlerTasksResponse = { let value: GetButlerTasksResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 431, statusCode: 402,
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 { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operatio
let value: GetCompanionsDataResponse = { let value: GetCompanionsDataResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 308, statusCode: 301,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -19,12 +19,15 @@ let value: GetCountriesLibraryQueryParamType =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| --------- | --------- |
| `Movie` | 1 | | Name | Value |
| `TvShow` | 2 | | ---------------------- | ---------------------- |
| `Season` | 3 | | `Movie` | 1 |
| `Episode` | 4 | | `TvShow` | 2 |
| `Audio` | 8 | | `Season` | 3 |
| `Album` | 9 | | `Episode` | 4 |
| `Track` | 10 | | `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

View File

@@ -7,7 +7,7 @@ import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operat
let value: GetCountriesLibraryResponse = { let value: GetCountriesLibraryResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 510, statusCode: 404,
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 { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetDevicesResponse = { let value: GetDevicesResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 308, statusCode: 301,
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 { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetFileHashResponse = { let value: GetFileHashResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 305, 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

@@ -19,12 +19,15 @@ let value: GetGenresLibraryQueryParamType =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| --------- | --------- |
| `Movie` | 1 | | Name | Value |
| `TvShow` | 2 | | ---------------------- | ---------------------- |
| `Season` | 3 | | `Movie` | 1 |
| `Episode` | 4 | | `TvShow` | 2 |
| `Audio` | 8 | | `Season` | 3 |
| `Album` | 9 | | `Episode` | 4 |
| `Track` | 10 | | `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

View File

@@ -7,7 +7,7 @@ import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
let value: GetGenresLibraryResponse = { let value: GetGenresLibraryResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 428, statusCode: 301,
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 { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGeoDataResponse = { let value: GetGeoDataResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 102, 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,7 +7,7 @@ import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetGlobalHubsResponse = { let value: GetGlobalHubsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 423, statusCode: 306,
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 { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetHomeDataResponse = { let value: GetHomeDataResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 204, statusCode: 404,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),

View File

@@ -12,7 +12,7 @@ let value: GetLibraryDetailsRequest = {
## Fields ## Fields
| Field | Type | Required | Description | Example | | Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | | | `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
| `sectionKey` | *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 |

View File

@@ -7,7 +7,7 @@ import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operatio
let value: GetLibraryDetailsResponse = { let value: GetLibraryDetailsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 308, statusCode: 206,
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 { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryHubsRequest = { let value: GetLibraryHubsRequest = {
sectionId: 6063.93, sectionId: 7247.75,
}; };
``` ```

View File

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

View File

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

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

View File

@@ -11,9 +11,12 @@ let value: GetLibraryItemsLibraryResponse200Type =
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| ------------- | ------------- |
| `CoverPoster` | coverPoster | | Name | Value |
| `Background` | background | | ---------------------- | ---------------------- |
| `Snapshot` | snapshot | | `CoverPoster` | coverPoster |
| `ClearLogo` | clearLogo | | `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |
| - | `Unrecognized<string>` |

View File

@@ -13,11 +13,14 @@ let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.Movie;
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
| --------- | --------- |
| `Movie` | movie | | Name | Value |
| `TvShow` | show | | ---------------------- | ---------------------- |
| `Season` | season | | `Movie` | movie |
| `Episode` | episode | | `TvShow` | show |
| `Artist` | artist | | `Season` | season |
| `Album` | album | | `Episode` | episode |
| `Artist` | artist |
| `Album` | album |
| - | `Unrecognized<string>` |

View File

@@ -7,13 +7,13 @@ The Meta object is only included in the response if the `includeMeta` parameter
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsMediaContainer, GetLibraryItemsMediaContainer,
GetLibraryItemsShowOrdering, ShowOrdering,
} 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";
@@ -106,11 +106,11 @@ let value: GetLibraryItemsMediaContainer = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute, showOrdering: ShowOrdering.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",

View File

@@ -1,17 +0,0 @@
# GetLibraryItemsMediaGuid
## Example Usage
```typescript
import { GetLibraryItemsMediaGuid } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsMediaGuid = {
id: "imdb://tt13015952",
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |

View File

@@ -4,13 +4,13 @@
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsMetadata, GetLibraryItemsMetadata,
GetLibraryItemsShowOrdering, ShowOrdering,
} 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,11 +34,10 @@ let value: GetLibraryItemsMetadata = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration: EnableCreditsMarkerGeneration.LibraryDefault,
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, showOrdering: ShowOrdering.TvdbAbsolute,
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",
@@ -250,10 +249,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: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 | | `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
| `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 | | `episodeSort` | [operations.EpisodeSort](../../../sdk/models/operations/episodesort.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 | | `enableCreditsMarkerGeneration` | [operations.EnableCreditsMarkerGeneration](../../../sdk/models/operations/enablecreditsmarkergeneration.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 | | `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | 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 |
@@ -282,9 +281,9 @@ let value: GetLibraryItemsMetadata = {
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | | | `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | | | `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
| `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | | | `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | |
| `mediaGuid` | [operations.GetLibraryItemsMediaGuid](../../../sdk/models/operations/getlibraryitemsmediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | | | `mediaGuid` | [operations.MediaGuid](../../../sdk/models/operations/mediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | | | `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
| `metaDataRating` | [operations.GetLibraryItemsMetaDataRating](../../../sdk/models/operations/getlibraryitemsmetadatarating.md)[] | :heavy_minus_sign: | N/A | | | `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | |
| `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | | | `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | |
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale | | `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 | | `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |

View File

@@ -1,21 +0,0 @@
# GetLibraryItemsMetaDataRating
## Example Usage
```typescript
import { GetLibraryItemsMetaDataRating } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsMetaDataRating = {
image: "themoviedb://image.rating",
value: 3,
type: "audience",
};
```
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
| `value` | *number* | :heavy_check_mark: | The value of the rating. | 3 |
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |

View File

@@ -18,12 +18,15 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
## Values ## Values
| Name | Value | This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
| --------- | --------- |
| `Movie` | 1 | | Name | Value |
| `TvShow` | 2 | | ---------------------- | ---------------------- |
| `Season` | 3 | | `Movie` | 1 |
| `Episode` | 4 | | `TvShow` | 2 |
| `Audio` | 8 | | `Season` | 3 |
| `Album` | 9 | | `Episode` | 4 |
| `Track` | 10 | | `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |
| - | `Unrecognized<number>` |

View File

@@ -6,7 +6,7 @@
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations"; import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryItemsRequest = { let value: GetLibraryItemsRequest = {
tag: Tag.Folder, tag: Tag.OnDeck,
type: GetLibraryItemsQueryParamType.TvShow, type: GetLibraryItemsQueryParamType.TvShow,
sectionKey: 9518, sectionKey: 9518,
}; };

View File

@@ -4,19 +4,19 @@
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsResponse, GetLibraryItemsResponse,
GetLibraryItemsShowOrdering, ShowOrdering,
} 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";
let value: GetLibraryItemsResponse = { let value: GetLibraryItemsResponse = {
contentType: "<value>", contentType: "<value>",
statusCode: 451, statusCode: 102,
rawResponse: new Response("{\"message\": \"hello world\"}", { rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" }, headers: { "Content-Type": "application/json" },
}), }),
@@ -110,11 +110,11 @@ let value: GetLibraryItemsResponse = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute, showOrdering: ShowOrdering.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",

View File

@@ -6,13 +6,13 @@ The contents of the library by section and tag
```typescript ```typescript
import { import {
GetLibraryItemsEnableCreditsMarkerGeneration, EnableCreditsMarkerGeneration,
GetLibraryItemsEpisodeSort, EpisodeSort,
GetLibraryItemsFlattenSeasons, FlattenSeasons,
GetLibraryItemsLibraryResponse200Type, GetLibraryItemsLibraryResponse200Type,
GetLibraryItemsLibraryType, GetLibraryItemsLibraryType,
GetLibraryItemsResponseBody, GetLibraryItemsResponseBody,
GetLibraryItemsShowOrdering, ShowOrdering,
} 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";
@@ -106,11 +106,11 @@ let value: GetLibraryItemsResponseBody = {
year: 2022, year: 2022,
seasonCount: 2022, seasonCount: 2022,
tagline: "Return to Pandora.", tagline: "Return to Pandora.",
flattenSeasons: GetLibraryItemsFlattenSeasons.Show, flattenSeasons: FlattenSeasons.Show,
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst, episodeSort: EpisodeSort.OldestFirst,
enableCreditsMarkerGeneration: enableCreditsMarkerGeneration:
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault, EnableCreditsMarkerGeneration.LibraryDefault,
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute, showOrdering: ShowOrdering.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",

View File

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

View File

@@ -0,0 +1,36 @@
# GetMediaArtsMediaContainer
## Example Usage
```typescript
import { GetMediaArtsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaArtsMediaContainer = {
size: 50,
mediaTagVersion: 1734362201,
mediaTagPrefix: "/system/bundle/media/flags/",
identifier: "com.plexapp.plugins.library",
metadata: [
{
key:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
provider: "tmdb",
ratingKey:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
selected: true,
thumb:
"https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `metadata` | [operations.GetMediaArtsMetadata](../../../sdk/models/operations/getmediaartsmetadata.md)[] | :heavy_check_mark: | N/A | |

View File

@@ -0,0 +1,27 @@
# GetMediaArtsMetadata
## Example Usage
```typescript
import { GetMediaArtsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaArtsMetadata = {
key: "https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
provider: "tmdb",
ratingKey:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
selected: true,
thumb:
"https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg",
};
```
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
| `provider` | *string* | :heavy_minus_sign: | The provider of the artwork. | tmdb |
| `ratingKey` | *string* | :heavy_check_mark: | The URL of the artwork. | https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg |
| `selected` | *boolean* | :heavy_check_mark: | Whether this is the selected artwork. | true |
| `thumb` | *string* | :heavy_check_mark: | The URL of the artwork thumbnail. | https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg |

View File

@@ -0,0 +1,17 @@
# GetMediaArtsRequest
## Example Usage
```typescript
import { GetMediaArtsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaArtsRequest = {
ratingKey: 16099,
};
```
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the artwork of. | 16099 |

View File

@@ -0,0 +1,44 @@
# GetMediaArtsResponse
## Example Usage
```typescript
import { GetMediaArtsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaArtsResponse = {
contentType: "<value>",
statusCode: 301,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
mediaTagVersion: 1734362201,
mediaTagPrefix: "/system/bundle/media/flags/",
identifier: "com.plexapp.plugins.library",
metadata: [
{
key:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
provider: "tmdb",
ratingKey:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
selected: true,
thumb:
"https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg",
},
],
},
},
};
```
## 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.GetMediaArtsResponseBody](../../../sdk/models/operations/getmediaartsresponsebody.md) | :heavy_minus_sign: | The available background artwork for the library item. |

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