mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
763aa8e800 | ||
|
|
7a950ea773 | ||
|
|
379a408d74 | ||
|
|
2712820397 | ||
|
|
c895213ae8 | ||
|
|
c473c9d326 | ||
|
|
3c13bba9de |
File diff suppressed because one or more lines are too long
@@ -15,7 +15,7 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.35.2
|
||||
version: 0.37.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.526.6
|
||||
speakeasyVersion: 1.535.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:cffb18feaa0523b300655a6f0073caad99133b143f5a420fddbb1e1efe47bcaf
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
|
||||
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1743438725
|
||||
- speakeasy-sdk-regen-1745021437
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:cffb18feaa0523b300655a6f0073caad99133b143f5a420fddbb1e1efe47bcaf
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
sourceRevisionDigest: sha256:b2f9599237ceb13cf8f9c1693e38b290177b65fb389cebf0c3c60b8ef4778615
|
||||
sourceBlobDigest: sha256:f8df9ef88ada992cd981d601e6c0b45cc82db76aba3d915c2f9d08f90c81ced9
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:1e82144ee5f8b57f2ee0633b982f4dd97305e92b7810d3ea83a6960fb89390cf
|
||||
codeSamplesRevisionDigest: sha256:86b4c9afc42dfef089cf6e9c6ad9f7df1060563fa04a7b1cdaa1f88b4c8cd902
|
||||
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
|
||||
|
||||
45
README.md
45
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,42 @@ 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";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(
|
||||
2268,
|
||||
"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
|
||||
|
||||
|
||||
60
RELEASES.md
60
RELEASES.md
@@ -1259,3 +1259,63 @@ 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 - .
|
||||
240
codeSamples.yaml
240
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,51 @@ 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";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(2268, "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 +664,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 +680,51 @@ 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";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaPoster(2268, "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 +751,7 @@ actions:
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -710,7 +790,7 @@ actions:
|
||||
- target: $["paths"]["/library/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -737,7 +817,7 @@ actions:
|
||||
- target: $["paths"]["/library/sections"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -757,7 +837,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 +861,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 +881,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 +901,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 +922,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 +946,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 +967,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 +988,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 +1009,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 +1030,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 +1055,7 @@ actions:
|
||||
- target: $["paths"]["/log"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -996,7 +1076,7 @@ actions:
|
||||
- target: $["paths"]["/log"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1018,7 +1098,7 @@ actions:
|
||||
- target: $["paths"]["/log/networked"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1038,7 +1118,7 @@ actions:
|
||||
- target: $["paths"]["/media/providers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1058,7 +1138,7 @@ actions:
|
||||
- target: $["paths"]["/myplex/account"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1078,7 +1158,7 @@ actions:
|
||||
- target: $["paths"]["/photo/:/transcode"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1107,7 +1187,7 @@ actions:
|
||||
- target: $["paths"]["/pins"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1131,7 +1211,7 @@ actions:
|
||||
- target: $["paths"]["/pins/{pinID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1156,7 +1236,7 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1176,7 +1256,7 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1202,7 +1282,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/upload"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1223,7 +1303,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1243,7 +1323,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1263,7 +1343,7 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1283,7 +1363,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 +1383,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 +1404,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 +1424,7 @@ actions:
|
||||
- target: $["paths"]["/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1364,7 +1444,7 @@ actions:
|
||||
- target: $["paths"]["/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1384,7 +1464,7 @@ actions:
|
||||
- target: $["paths"]["/security/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1404,7 +1484,7 @@ actions:
|
||||
- target: $["paths"]["/security/token"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1425,7 +1505,7 @@ actions:
|
||||
- target: $["paths"]["/servers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1445,7 +1525,7 @@ actions:
|
||||
- target: $["paths"]["/statistics/bandwidth"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1465,7 +1545,7 @@ actions:
|
||||
- target: $["paths"]["/statistics/media"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1485,7 +1565,7 @@ actions:
|
||||
- target: $["paths"]["/statistics/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1505,7 +1585,7 @@ actions:
|
||||
- target: $["paths"]["/status/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1525,7 +1605,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 +1625,7 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1565,7 +1645,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 +1665,7 @@ actions:
|
||||
- target: $["paths"]["/updater/apply"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1606,7 +1686,7 @@ actions:
|
||||
- target: $["paths"]["/updater/check"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1627,7 +1707,7 @@ actions:
|
||||
- target: $["paths"]["/updater/status"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1647,7 +1727,7 @@ actions:
|
||||
- target: $["paths"]["/user"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1667,7 +1747,7 @@ actions:
|
||||
- target: $["paths"]["/users"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1699,7 +1779,7 @@ actions:
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
- lang: typescript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
@@ -1728,7 +1808,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" },
|
||||
}),
|
||||
|
||||
@@ -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" },
|
||||
}),
|
||||
|
||||
@@ -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
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
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
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
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
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
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>` |
|
||||
@@ -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
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
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
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
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,12 +19,15 @@ let value: GetActorsLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `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",
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -37,26 +36,26 @@ 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 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `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 |
|
||||
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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_minus_sign: | N/A | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `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: | N/A | 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------- | --------------------------- | --------------------------- | --------------------------- | --------------------------- |
|
||||
| `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
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
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
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
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>` |
|
||||
@@ -19,12 +19,15 @@ let value: GetAllMediaLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -12,7 +12,7 @@ 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" },
|
||||
}),
|
||||
|
||||
@@ -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,12 +19,15 @@ let value: GetCountriesLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `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,12 +19,15 @@ let value: GetGenresLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `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" },
|
||||
}),
|
||||
|
||||
@@ -12,7 +12,7 @@ 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 |
|
||||
| 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
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
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
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
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,12 +18,15 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `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 |
|
||||
@@ -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`
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -8,7 +8,7 @@ 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" },
|
||||
}),
|
||||
|
||||
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. |
|
||||
36
docs/sdk/models/operations/getmediapostersresponsebody.md
Normal file
36
docs/sdk/models/operations/getmediapostersresponsebody.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# GetMediaPostersResponseBody
|
||||
|
||||
The available posters for the library item.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaPostersResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaPostersResponseBody = {
|
||||
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 |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetMediaPostersMediaContainer](../../../sdk/models/operations/getmediapostersmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -7,7 +7,7 @@ import { GetMediaProvidersResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
||||
|
||||
let value: GetMediaProvidersResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 511,
|
||||
statusCode: 102,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMetadataChildrenRequest = {
|
||||
ratingKey: 3119.45,
|
||||
ratingKey: 786.26,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetMetadataChildrenResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 202,
|
||||
statusCode: 305,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMyPlexAccountResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetMyPlexAccountResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 415,
|
||||
statusCode: 504,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPinResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPinResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 208,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -19,12 +19,15 @@ let value: GetPlaylistContentsQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistContentsRequest = {
|
||||
playlistID: 5182.01,
|
||||
playlistID: 4951.47,
|
||||
type: GetPlaylistContentsQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 100,
|
||||
statusCode: 426,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistRequest = {
|
||||
playlistID: 7980.47,
|
||||
playlistID: 7763.65,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 307,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 503,
|
||||
statusCode: 306,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -11,9 +11,12 @@ let value: GetRecentlyAddedHubsResponseType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
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: GetRecentlyAddedHubsType = GetRecentlyAddedHubsType.Movie;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
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>` |
|
||||
@@ -7,7 +7,7 @@ import { GetRecentlyAddedLibraryResponse } from "@lukehagar/plexjs/sdk/models/op
|
||||
|
||||
let value: GetRecentlyAddedLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 204,
|
||||
statusCode: 208,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -9,7 +9,7 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
```typescript
|
||||
const value: operations.GetRecentlyAddedOptimizedForStreaming1 =
|
||||
GetRecentlyAddedOptimizedForStreaming1.One;
|
||||
GetRecentlyAddedOptimizedForStreaming1.Zero;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetRecentlyAddedRequest, Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedRequest = {
|
||||
contentDirectoryID: 501324,
|
||||
contentDirectoryID: 995290,
|
||||
sectionID: 2,
|
||||
type: Type.TvShow,
|
||||
};
|
||||
|
||||
@@ -12,7 +12,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetRecentlyAddedResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 301,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetRefreshLibraryMetadataResponse } from "@lukehagar/plexjs/sdk/models/
|
||||
|
||||
let value: GetRefreshLibraryMetadataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 428,
|
||||
statusCode: 204,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -9,9 +9,9 @@ let value: GetResizedPhotoRequest = {
|
||||
width: 110,
|
||||
height: 165,
|
||||
opacity: 100,
|
||||
blur: 0,
|
||||
blur: 20,
|
||||
minSize: MinSize.Zero,
|
||||
upscale: Upscale.Zero,
|
||||
upscale: Upscale.One,
|
||||
url: "/library/metadata/49564/thumb/1654258204",
|
||||
};
|
||||
```
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetResourcesStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 424,
|
||||
statusCode: 226,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -13,7 +13,10 @@ let value: GetSearchAllLibrariesEnableCreditsMarkerGeneration =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,8 +13,11 @@ let value: GetSearchAllLibrariesEpisodeSort =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
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>` |
|
||||
@@ -13,8 +13,11 @@ let value: GetSearchAllLibrariesFlattenSeasons =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
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>` |
|
||||
@@ -11,9 +11,12 @@ let value: GetSearchAllLibrariesLibraryType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
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>` |
|
||||
@@ -15,10 +15,10 @@ import {
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetSearchAllLibrariesMediaContainer = {
|
||||
size: 2239.24,
|
||||
size: 1598.12,
|
||||
searchResult: [
|
||||
{
|
||||
score: 3453.52,
|
||||
score: 1566.25,
|
||||
metadata: {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
|
||||
@@ -9,7 +9,7 @@ let value: GetSearchAllLibrariesRequest = {
|
||||
query: "<value>",
|
||||
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
|
||||
searchTypes: [
|
||||
SearchTypes.Movies,
|
||||
SearchTypes.People,
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user