mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
6bd12d8759 | ||
|
|
891a7d39a1 | ||
|
|
763aa8e800 | ||
|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
||||
.DS_Store
|
||||
**/.speakeasy/temp/
|
||||
**/.speakeasy/logs/
|
||||
.DS_Store
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -11,11 +11,12 @@ generation:
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
sharedErrorComponentsApr2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.35.2
|
||||
version: 0.37.2
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.526.6
|
||||
speakeasyVersion: 1.542.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:cffb18feaa0523b300655a6f0073caad99133b143f5a420fddbb1e1efe47bcaf
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
|
||||
sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1743438725
|
||||
- speakeasy-sdk-regen-1746403916
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:cffb18feaa0523b300655a6f0073caad99133b143f5a420fddbb1e1efe47bcaf
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
sourceRevisionDigest: sha256:37adc934a79841fb00cfe6ed569f5b1c88534b20202ecbde64b4e84828cee22a
|
||||
sourceBlobDigest: sha256:ffb5b8d288111a763e4d035c8c9e37f5c89690d146b7297493b43a71d8298e6c
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:1e82144ee5f8b57f2ee0633b982f4dd97305e92b7810d3ea83a6960fb89390cf
|
||||
codeSamplesRevisionDigest: sha256:945657568eb11e06b45691a4a4a058c37170f5919329abbb42e23a5016781ba8
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -43,6 +43,5 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
langOverride: TypeScript
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
@@ -17,6 +17,5 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
langOverride: TypeScript
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
47
README.md
47
README.md
@@ -54,6 +54,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
|
||||
* [Authentication](#authentication)
|
||||
* [Requirements](#requirements)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [File uploads](#file-uploads)
|
||||
* [Retries](#retries)
|
||||
* [Debugging](#debugging)
|
||||
* [Development](#development)
|
||||
@@ -167,6 +168,10 @@ run();
|
||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [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
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
|
||||
@@ -543,13 +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
|
||||
- [`libraryGetLibraryDetails`](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
- [`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
|
||||
- [`libraryGetMediaPosters`](docs/sdks/library/README.md#getmediaposters) - Get Media Posters
|
||||
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
- [`libraryGetSearchLibrary`](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
- [`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
|
||||
- [`logLogLine`](docs/sdks/log/README.md#logline) - Logging a single line message.
|
||||
- [`logLogMultiLine`](docs/sdks/log/README.md#logmultiline) - Logging a multi-line message
|
||||
@@ -604,6 +613,44 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
</details>
|
||||
<!-- 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] -->
|
||||
## Retries
|
||||
|
||||
|
||||
80
RELEASES.md
80
RELEASES.md
@@ -1259,3 +1259,83 @@ Based on:
|
||||
- [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 - .
|
||||
242
codeSamples.yaml
242
codeSamples.yaml
@@ -6,7 +6,7 @@ actions:
|
||||
- target: $["paths"]["/"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -26,7 +26,7 @@ actions:
|
||||
- target: $["paths"]["/:/prefs"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -46,7 +46,7 @@ actions:
|
||||
- target: $["paths"]["/:/progress"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -66,7 +66,7 @@ actions:
|
||||
- target: $["paths"]["/:/scrobble"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -86,7 +86,7 @@ actions:
|
||||
- target: $["paths"]["/:/timeline"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -118,7 +118,7 @@ actions:
|
||||
- target: $["paths"]["/:/unscrobble"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -138,7 +138,7 @@ actions:
|
||||
- target: $["paths"]["/activities"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -158,7 +158,7 @@ actions:
|
||||
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -178,7 +178,7 @@ actions:
|
||||
- target: $["paths"]["/butler"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -198,7 +198,7 @@ actions:
|
||||
- target: $["paths"]["/butler"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -218,7 +218,7 @@ actions:
|
||||
- target: $["paths"]["/butler"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -238,7 +238,7 @@ actions:
|
||||
- target: $["paths"]["/butler/{taskName}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -259,7 +259,7 @@ actions:
|
||||
- target: $["paths"]["/butler/{taskName}"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -280,7 +280,7 @@ actions:
|
||||
- target: $["paths"]["/clients"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -300,7 +300,7 @@ actions:
|
||||
- target: $["paths"]["/companions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -320,7 +320,7 @@ actions:
|
||||
- target: $["paths"]["/devices"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -340,7 +340,7 @@ actions:
|
||||
- target: $["paths"]["/friends"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -360,7 +360,7 @@ actions:
|
||||
- target: $["paths"]["/geoip"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -378,7 +378,7 @@ actions:
|
||||
- target: $["paths"]["/home"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -398,7 +398,7 @@ actions:
|
||||
- target: $["paths"]["/hubs"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -418,7 +418,7 @@ actions:
|
||||
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -443,7 +443,7 @@ actions:
|
||||
- target: $["paths"]["/hubs/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -463,7 +463,7 @@ actions:
|
||||
- target: $["paths"]["/hubs/search/voice"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -483,7 +483,7 @@ actions:
|
||||
- target: $["paths"]["/hubs/sections/{sectionId}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -503,7 +503,7 @@ actions:
|
||||
- target: $["paths"]["/identity"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -521,7 +521,7 @@ actions:
|
||||
- target: $["paths"]["/library/all/top"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -542,7 +542,7 @@ actions:
|
||||
- target: $["paths"]["/library/hashes"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -562,7 +562,7 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -593,11 +593,52 @@ actions:
|
||||
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();
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -624,7 +665,7 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -640,11 +681,52 @@ actions:
|
||||
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();
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -671,7 +753,7 @@ actions:
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -710,7 +792,7 @@ actions:
|
||||
- target: $["paths"]["/library/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -737,7 +819,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -757,7 +839,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -781,7 +863,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -801,7 +883,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -821,7 +903,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -842,7 +924,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -866,7 +948,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -887,7 +969,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/genre"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -908,7 +990,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -929,7 +1011,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -950,7 +1032,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -975,7 +1057,7 @@ actions:
|
||||
- target: $["paths"]["/log"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -996,7 +1078,7 @@ actions:
|
||||
- target: $["paths"]["/log"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1018,7 +1100,7 @@ actions:
|
||||
- target: $["paths"]["/log/networked"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1038,7 +1120,7 @@ actions:
|
||||
- target: $["paths"]["/media/providers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1058,7 +1140,7 @@ actions:
|
||||
- target: $["paths"]["/myplex/account"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1078,7 +1160,7 @@ actions:
|
||||
- target: $["paths"]["/photo/:/transcode"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1107,7 +1189,7 @@ actions:
|
||||
- target: $["paths"]["/pins"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1131,7 +1213,7 @@ actions:
|
||||
- target: $["paths"]["/pins/{pinID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1156,7 +1238,7 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1176,7 +1258,7 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1202,7 +1284,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/upload"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1223,7 +1305,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1243,7 +1325,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1263,7 +1345,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1283,7 +1365,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1303,7 +1385,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1324,7 +1406,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1344,7 +1426,7 @@ actions:
|
||||
- target: $["paths"]["/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1364,7 +1446,7 @@ actions:
|
||||
- target: $["paths"]["/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1384,7 +1466,7 @@ actions:
|
||||
- target: $["paths"]["/security/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1404,7 +1486,7 @@ actions:
|
||||
- target: $["paths"]["/security/token"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1425,7 +1507,7 @@ actions:
|
||||
- target: $["paths"]["/servers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1445,7 +1527,7 @@ actions:
|
||||
- target: $["paths"]["/statistics/bandwidth"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1465,7 +1547,7 @@ actions:
|
||||
- target: $["paths"]["/statistics/media"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1485,7 +1567,7 @@ actions:
|
||||
- target: $["paths"]["/statistics/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1505,7 +1587,7 @@ actions:
|
||||
- target: $["paths"]["/status/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1525,7 +1607,7 @@ actions:
|
||||
- target: $["paths"]["/status/sessions/history/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1545,7 +1627,7 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1565,7 +1647,7 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1585,7 +1667,7 @@ actions:
|
||||
- target: $["paths"]["/updater/apply"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1606,7 +1688,7 @@ actions:
|
||||
- target: $["paths"]["/updater/check"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1627,7 +1709,7 @@ actions:
|
||||
- target: $["paths"]["/updater/status"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1647,7 +1729,7 @@ actions:
|
||||
- target: $["paths"]["/user"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1667,7 +1749,7 @@ actions:
|
||||
- target: $["paths"]["/users"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1699,7 +1781,7 @@ actions:
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1728,7 +1810,7 @@ actions:
|
||||
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 2776.28,
|
||||
playlistID: 1207.42,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 307,
|
||||
statusCode: 207,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 208,
|
||||
statusCode: 200,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
21
docs/sdk/models/operations/attributes.md
Normal file
21
docs/sdk/models/operations/attributes.md
Normal 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 |
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 903720,
|
||||
paymentMethodId: 395427,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: CancelServerActivitiesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 417,
|
||||
statusCode: 405,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
29
docs/sdk/models/operations/chapter.md
Normal file
29
docs/sdk/models/operations/chapter.md
Normal 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 |
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 428,
|
||||
statusCode: 504,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 4246.85,
|
||||
playlistID: 5077.01,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 204,
|
||||
statusCode: 504,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,9 +7,9 @@ import { Connections, Protocol } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Connections = {
|
||||
protocol: Protocol.Http,
|
||||
address: "21611 Schuster Cliffs",
|
||||
port: 54915,
|
||||
uri: "https://wobbly-instance.org/",
|
||||
address: "84577 W 9th Street",
|
||||
port: 40036,
|
||||
uri: "https://dearest-custom.net",
|
||||
local: false,
|
||||
relay: false,
|
||||
iPv6: false,
|
||||
|
||||
@@ -12,8 +12,11 @@ let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -8,8 +8,8 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Audio,
|
||||
smart: Smart.One,
|
||||
uri: "https://ajar-reward.biz/",
|
||||
smart: Smart.Zero,
|
||||
uri: "https://courageous-futon.net",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 205,
|
||||
statusCode: 510,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeleteLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 451,
|
||||
statusCode: 102,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 6874.88,
|
||||
playlistID: 5840.32,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 226,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -13,7 +13,10 @@ let value: EnableCreditsMarkerGeneration =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 304,
|
||||
statusCode: 416,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -12,8 +12,11 @@ let value: EpisodeSort = EpisodeSort.OldestFirst;
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
17
docs/sdk/models/operations/extras.md
Normal file
17
docs/sdk/models/operations/extras.md
Normal 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 |
|
||||
@@ -7,13 +7,16 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.Released;
|
||||
let value: Filter = Filter.Available;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,8 +12,11 @@ let value: FlattenSeasons = FlattenSeasons.Show;
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,7 +7,7 @@ Force the refresh even if the library is already being refreshed.
|
||||
```typescript
|
||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Force = Force.One;
|
||||
let value: Force = Force.Zero;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -19,8 +19,10 @@ let value: GetActorsLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
@@ -28,3 +30,4 @@ let value: GetActorsLibraryQueryParamType =
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -7,7 +7,7 @@ import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetActorsLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -3,33 +3,32 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesDirectory, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesDirectory = {
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -38,25 +37,25 @@ let value: GetAllLibrariesDirectory = {
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `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` | [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 | |
|
||||
@@ -7,13 +7,13 @@ import { GetAllLibrariesLocation } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: GetAllLibrariesLocation = {
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `path` | *string* | :heavy_check_mark: | N/A | /movies |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The ID of the location. | 1 |
|
||||
| `path` | *string* | :heavy_check_mark: | The path to the media item. | /Movies |
|
||||
@@ -3,38 +3,37 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesMediaContainer, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesMediaContainer = {
|
||||
size: 5,
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
title1: "TV Series",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -46,7 +45,7 @@ let value: GetAllLibrariesMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 5 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | Plex Library |
|
||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_check_mark: | N/A | |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `directory` | [operations.GetAllLibrariesDirectory](../../../sdk/models/operations/getalllibrariesdirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,45 +3,44 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesResponse, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 508,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
title1: "TV Series",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -5,39 +5,38 @@ The libraries available on the Server
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllLibrariesResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllLibrariesResponseBody, GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllLibrariesResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 5,
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
title1: "Plex Library",
|
||||
title1: "TV Series",
|
||||
directory: [
|
||||
{
|
||||
allowSync: true,
|
||||
art: "/:/resources/movie-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1705615584",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
composite: "/library/sections/1/composite/1743824484",
|
||||
filters: true,
|
||||
refreshing: false,
|
||||
thumb: "/:/resources/movie.png",
|
||||
refreshing: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
key: "1",
|
||||
type: "movie",
|
||||
type: GetAllLibrariesType.Movie,
|
||||
title: "Movies",
|
||||
agent: "tv.plex.agents.movie",
|
||||
scanner: "Plex Movie",
|
||||
language: "en-US",
|
||||
uuid: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
uuid: "e69655a2-ef48-4aba-bb19-01e7d3cc34d6",
|
||||
updatedAt: 1556281940,
|
||||
createdAt: 1556281940,
|
||||
scannedAt: 1556281940,
|
||||
content: true,
|
||||
directory: true,
|
||||
contentChangedAt: 1556281940,
|
||||
hidden: 0,
|
||||
contentChangedAt: 9173960,
|
||||
location: [
|
||||
{
|
||||
id: 1,
|
||||
path: "/movies",
|
||||
path: "/Movies",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -50,4 +49,4 @@ let value: GetAllLibrariesResponseBody = {
|
||||
|
||||
| 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 |
|
||||
25
docs/sdk/models/operations/getalllibrariestype.md
Normal file
25
docs/sdk/models/operations/getalllibrariestype.md
Normal 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>` |
|
||||
@@ -11,9 +11,12 @@ let value: GetAllMediaLibraryLibraryResponseType =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,11 +13,14 @@ let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.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>` |
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllMediaLibraryMedia, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMedia = {
|
||||
id: 387322,
|
||||
@@ -41,7 +41,8 @@ let value: GetAllMediaLibraryMedia = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -69,6 +70,7 @@ let value: GetAllMediaLibraryMedia = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMediaContainer,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -188,7 +189,8 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -216,6 +218,7 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -10,6 +10,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMetadata,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -122,7 +123,8 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -150,6 +152,7 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllMediaLibraryPart, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryPart = {
|
||||
accessible: true,
|
||||
@@ -22,7 +22,8 @@ let value: GetAllMediaLibraryPart = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -50,6 +51,7 @@ let value: GetAllMediaLibraryPart = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -19,8 +19,10 @@ let value: GetAllMediaLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
@@ -28,3 +30,4 @@ let value: GetAllMediaLibraryQueryParamType =
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -7,12 +7,13 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponse,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
statusCode: 505,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -195,7 +196,8 @@ let value: GetAllMediaLibraryResponse = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -223,6 +225,7 @@ let value: GetAllMediaLibraryResponse = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -9,6 +9,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponseBody,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -191,7 +192,8 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -219,6 +221,7 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,11 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllMediaLibraryStream, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryStream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -35,6 +36,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -61,12 +63,13 @@ let value: GetAllMediaLibraryStream = {
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
@@ -91,6 +94,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
|
||||
26
docs/sdk/models/operations/getallmedialibrarystreamtype.md
Normal file
26
docs/sdk/models/operations/getallmedialibrarystreamtype.md
Normal 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>` |
|
||||
@@ -7,7 +7,7 @@ import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetAvailableClientsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 305,
|
||||
statusCode: 308,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 205,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: GetButlerTasksResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 431,
|
||||
statusCode: 402,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
||||
|
||||
let value: GetCompanionsDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 301,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -19,8 +19,10 @@ let value: GetCountriesLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
@@ -28,3 +30,4 @@ let value: GetCountriesLibraryQueryParamType =
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -7,7 +7,7 @@ import { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetDevicesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 301,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetFileHashResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 102,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -19,8 +19,10 @@ let value: GetGenresLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
@@ -28,3 +30,4 @@ let value: GetGenresLibraryQueryParamType =
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -7,7 +7,7 @@ import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetGenresLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 301,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetGeoDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 103,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetGlobalHubsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 423,
|
||||
statusCode: 306,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetHomeDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 204,
|
||||
statusCode: 404,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -13,6 +13,6 @@ let value: GetLibraryDetailsRequest = {
|
||||
## Fields
|
||||
|
||||
| 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/> | |
|
||||
| `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 |
|
||||
@@ -7,7 +7,7 @@ import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
||||
|
||||
let value: GetLibraryDetailsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 206,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryHubsRequest = {
|
||||
sectionId: 2900.77,
|
||||
sectionId: 7247.75,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetLibraryHubsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 412,
|
||||
statusCode: 304,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -11,9 +11,12 @@ let value: GetLibraryItemsLibraryResponse200Type =
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,11 +13,14 @@ let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.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>` |
|
||||
@@ -18,8 +18,10 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
@@ -27,3 +29,4 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsRequest = {
|
||||
tag: Tag.FirstCharacter,
|
||||
tag: Tag.OnDeck,
|
||||
type: GetLibraryItemsQueryParamType.TvShow,
|
||||
sectionKey: 9518,
|
||||
};
|
||||
|
||||
36
docs/sdk/models/operations/getmediaartsmediacontainer.md
Normal file
36
docs/sdk/models/operations/getmediaartsmediacontainer.md
Normal 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 | |
|
||||
27
docs/sdk/models/operations/getmediaartsmetadata.md
Normal file
27
docs/sdk/models/operations/getmediaartsmetadata.md
Normal 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 |
|
||||
17
docs/sdk/models/operations/getmediaartsrequest.md
Normal file
17
docs/sdk/models/operations/getmediaartsrequest.md
Normal 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 |
|
||||
44
docs/sdk/models/operations/getmediaartsresponse.md
Normal file
44
docs/sdk/models/operations/getmediaartsresponse.md
Normal 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. |
|
||||
36
docs/sdk/models/operations/getmediaartsresponsebody.md
Normal file
36
docs/sdk/models/operations/getmediaartsresponsebody.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# GetMediaArtsResponseBody
|
||||
|
||||
The available background artwork for the library item.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaArtsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaArtsResponseBody = {
|
||||
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 |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetMediaArtsMediaContainer](../../../sdk/models/operations/getmediaartsmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,21 +1,23 @@
|
||||
# GetMediaMetaDataCountry
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataCountry = {
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country name. | United States of America |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `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 |
|
||||
@@ -6,23 +6,21 @@
|
||||
import { GetMediaMetaDataDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataDirector = {
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | A unique key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -1,21 +1,23 @@
|
||||
# GetMediaMetaDataGenre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataGenre = {
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name. | Crime |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
@@ -3,19 +3,19 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataImage } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataImage, GetMediaMetaDataLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataImage = {
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||
| `url` | *string* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetMediaMetaDataLibraryType](../../../sdk/models/operations/getmediametadatalibrarytype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
@@ -9,7 +9,7 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
```typescript
|
||||
const value: operations.GetMediaMetaDataOptimizedForStreamingLibrary1 =
|
||||
GetMediaMetaDataOptimizedForStreamingLibrary1.One;
|
||||
GetMediaMetaDataOptimizedForStreamingLibrary1.Zero;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
21
docs/sdk/models/operations/getmediametadatalibrarytype.md
Normal file
21
docs/sdk/models/operations/getmediametadatalibrarytype.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataLibraryType = GetMediaMetaDataLibraryType.Background;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataMedia, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataMedia = {
|
||||
id: 387322,
|
||||
@@ -41,7 +41,8 @@ let value: GetMediaMetaDataMedia = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -69,6 +70,7 @@ let value: GetMediaMetaDataMedia = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,7 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataMediaContainer,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataMediaContainer = {
|
||||
@@ -17,55 +22,80 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
mediaTagVersion: 1734362201,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -103,7 +133,8 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -131,6 +162,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -157,31 +189,60 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -196,50 +257,6 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -252,6 +269,32 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
@@ -1,61 +1,94 @@
|
||||
# GetMediaMetaDataMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataMetadata,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataMetadata = {
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -93,7 +126,8 @@ let value: GetMediaMetaDataMetadata = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -121,6 +155,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -147,31 +182,60 @@ let value: GetMediaMetaDataMetadata = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -186,50 +250,6 @@ let value: GetMediaMetaDataMetadata = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -242,71 +262,109 @@ let value: GetMediaMetaDataMetadata = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
||||
| `key` | *string* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
||||
| `slug` | *string* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
||||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The ID of the library section. | 2 |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
|
||||
| `summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
||||
| `index` | *number* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
||||
| `year` | *number* | :heavy_check_mark: | The release year. | 2015 |
|
||||
| `rating` | *number* | :heavy_minus_sign: | The general rating | 6 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
||||
| `art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
||||
| `theme` | *string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||
| `duration` | *number* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
||||
| `childCount` | *number* | :heavy_minus_sign: | The number of child items. | 6 |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `type` | [operations.GetMediaMetaDataType](../../../sdk/models/operations/getmediametadatatype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `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 |
|
||||
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `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. |
|
||||
| `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 |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||
| `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `createdAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||
| `createdAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `media` | [operations.GetMediaMetaDataMedia](../../../sdk/models/operations/getmediametadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_check_mark: | An array of image objects. | |
|
||||
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
||||
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | An array of genre tags. | |
|
||||
| `country` | [operations.GetMediaMetaDataCountry](../../../sdk/models/operations/getmediametadatacountry.md)[] | :heavy_minus_sign: | An array of country tags. | |
|
||||
| `guids` | [operations.GetMediaMetaDataGuids](../../../sdk/models/operations/getmediametadataguids.md)[] | :heavy_minus_sign: | An array of GUID objects. | |
|
||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | An array of rating objects. | |
|
||||
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | An array of Actor roles. | |
|
||||
| `director` | [operations.GetMediaMetaDataDirector](../../../sdk/models/operations/getmediametadatadirector.md)[] | :heavy_minus_sign: | An array of Director roles. | |
|
||||
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.md)[] | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | An array of location objects. | |
|
||||
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetMediaMetaDataCountry](../../../sdk/models/operations/getmediametadatacountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetMediaMetaDataDirector](../../../sdk/models/operations/getmediametadatadirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetMediaMetaDataGuids](../../../sdk/models/operations/getmediametadataguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | [operations.Chapter](../../../sdk/models/operations/chapter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | [operations.Marker](../../../sdk/models/operations/marker.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [operations.Extras](../../../sdk/models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMediaMetaDataOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataOptimizedForStreaming1 =
|
||||
GetMediaMetaDataOptimizedForStreaming1.Zero;
|
||||
GetMediaMetaDataOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMediaMetaDataOptimizedForStreamingLibrary1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataOptimizedForStreamingLibrary1 =
|
||||
GetMediaMetaDataOptimizedForStreamingLibrary1.One;
|
||||
GetMediaMetaDataOptimizedForStreamingLibrary1.Zero;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataPart, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataPart = {
|
||||
accessible: true,
|
||||
@@ -22,7 +22,8 @@ let value: GetMediaMetaDataPart = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -50,6 +51,7 @@ let value: GetMediaMetaDataPart = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,12 +3,17 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataResponse,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 306,
|
||||
statusCode: 100,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -24,55 +29,80 @@ let value: GetMediaMetaDataResponse = {
|
||||
mediaTagVersion: 1734362201,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -110,7 +140,8 @@ let value: GetMediaMetaDataResponse = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -138,6 +169,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -164,31 +196,60 @@ let value: GetMediaMetaDataResponse = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -203,50 +264,6 @@ let value: GetMediaMetaDataResponse = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -259,6 +276,32 @@ let value: GetMediaMetaDataResponse = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -5,7 +5,12 @@ The metadata of the library item.
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataResponseBody,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataResponseBody = {
|
||||
@@ -20,55 +25,80 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
mediaTagVersion: 1734362201,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -106,7 +136,8 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -134,6 +165,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -160,31 +192,60 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -199,50 +260,6 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -255,6 +272,32 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -6,23 +6,23 @@
|
||||
import { GetMediaMetaDataRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataRole = {
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||
@@ -3,11 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataStream, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataStream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -35,6 +36,7 @@ let value: GetMediaMetaDataStream = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -61,12 +63,13 @@ let value: GetMediaMetaDataStream = {
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `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.GetMediaMetaDataStreamType](../../../sdk/models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
@@ -91,6 +94,7 @@ let value: GetMediaMetaDataStream = {
|
||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
|
||||
26
docs/sdk/models/operations/getmediametadatastreamtype.md
Normal file
26
docs/sdk/models/operations/getmediametadatastreamtype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetMediaMetaDataStreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataStreamType = GetMediaMetaDataStreamType.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>` |
|
||||
26
docs/sdk/models/operations/getmediametadatatype.md
Normal file
26
docs/sdk/models/operations/getmediametadatatype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetMediaMetaDataType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataType = GetMediaMetaDataType.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>` |
|
||||
@@ -6,18 +6,18 @@
|
||||
import { GetMediaMetaDataUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataUltraBlurColors = {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `topLeft` | *string* | :heavy_check_mark: | The top-left color value. | 11333a |
|
||||
| `topRight` | *string* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
||||
| `bottomRight` | *string* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
||||
| `bottomLeft` | *string* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `topLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `topRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `bottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `bottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
@@ -6,23 +6,21 @@
|
||||
import { GetMediaMetaDataWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataWriter = {
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
36
docs/sdk/models/operations/getmediapostersmediacontainer.md
Normal file
36
docs/sdk/models/operations/getmediapostersmediacontainer.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# GetMediaPostersMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaPostersMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaPostersMediaContainer = {
|
||||
size: 50,
|
||||
mediaTagVersion: 1734362201,
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
metadata: [
|
||||
{
|
||||
key:
|
||||
"https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg",
|
||||
provider: "tmdb",
|
||||
ratingKey:
|
||||
"https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg",
|
||||
selected: true,
|
||||
thumb:
|
||||
"https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%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.GetMediaPostersMetadata](../../../sdk/models/operations/getmediapostersmetadata.md)[] | :heavy_check_mark: | N/A | |
|
||||
27
docs/sdk/models/operations/getmediapostersmetadata.md
Normal file
27
docs/sdk/models/operations/getmediapostersmetadata.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# GetMediaPostersMetadata
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaPostersMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaPostersMetadata = {
|
||||
key: "https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg",
|
||||
provider: "tmdb",
|
||||
ratingKey:
|
||||
"https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg",
|
||||
selected: true,
|
||||
thumb:
|
||||
"https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
|
||||
| `provider` | *string* | :heavy_minus_sign: | The provider of the poster. | tmdb |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The URL of the poster. | https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg |
|
||||
| `selected` | *boolean* | :heavy_check_mark: | Whether this is the selected poster. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The URL of the poster thumbnail. | https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%2Ejpg |
|
||||
17
docs/sdk/models/operations/getmediapostersrequest.md
Normal file
17
docs/sdk/models/operations/getmediapostersrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetMediaPostersRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaPostersRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaPostersRequest = {
|
||||
ratingKey: 16099,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| `ratingKey` | *number* | :heavy_check_mark: | the id of the library item to return the posters of. | 16099 |
|
||||
44
docs/sdk/models/operations/getmediapostersresponse.md
Normal file
44
docs/sdk/models/operations/getmediapostersresponse.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# GetMediaPostersResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaPostersResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaPostersResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 307,
|
||||
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/hntBJjqbv4m0Iyniqaztv9xaudI.jpg",
|
||||
provider: "tmdb",
|
||||
ratingKey:
|
||||
"https://image.tmdb.org/t/p/original/hntBJjqbv4m0Iyniqaztv9xaudI.jpg",
|
||||
selected: true,
|
||||
thumb:
|
||||
"https://images.plex.tv/photo?height=336&width=225&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FhntBJjqbv4m0Iyniqaztv9xaudI%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.GetMediaPostersResponseBody](../../../sdk/models/operations/getmediapostersresponsebody.md) | :heavy_minus_sign: | The available posters for the library item. |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user