Compare commits

..

8 Commits

Author SHA1 Message Date
speakeasybot
379a408d74 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.529.1 2025-04-06 00:12:51 +00:00
speakeasybot
2712820397 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.528.1 2025-04-03 00:12:07 +00:00
speakeasybot
c895213ae8 ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 19:44:01 +00:00
Luke Hagar
c473c9d326 Update workflow.yaml 2025-03-31 14:41:40 -05:00
speakeasybot
3c13bba9de ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 19:35:21 +00:00
speakeasybot
650c5043ef ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.526.6 2025-03-31 16:33:24 +00:00
Luke Hagar
0234804578 correcting label override key value 2025-03-31 11:30:53 -05:00
Luke Hagar
60d913c8f9 adjusting codesample labels 2025-03-28 16:58:29 -05:00
168 changed files with 3612 additions and 466 deletions

File diff suppressed because one or more lines are too long

View File

@@ -15,7 +15,7 @@ generation:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: false
typescript:
version: 0.35.1
version: 0.36.1
additionalDependencies:
dependencies: {}
devDependencies: {}

View File

@@ -1,4 +1,4 @@
speakeasyVersion: 1.513.4
speakeasyVersion: 1.529.1
sources:
my-source:
sourceNamespace: my-source
@@ -9,20 +9,20 @@ sources:
- main
plexapi:
sourceNamespace: plexapi
sourceRevisionDigest: sha256:2066ba94b55e21d651c79003e3cf402fb77c52a0969fc52310b3383fbed038f4
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
tags:
- latest
- speakeasy-sdk-regen-1741478971
- speakeasy-sdk-regen-1743898297
- 0.0.3
targets:
plexjs:
source: plexapi
sourceNamespace: plexapi
sourceRevisionDigest: sha256:2066ba94b55e21d651c79003e3cf402fb77c52a0969fc52310b3383fbed038f4
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
codeSamplesNamespace: code-samples-typescript-plexjs
codeSamplesRevisionDigest: sha256:562c355ca997be7103dd50d641d9264002668b79ccbed1d1c259a98c653ce99a
codeSamplesRevisionDigest: sha256:871b7aa4b65bfb8932c4593238410f8f50b425e8039c1edd716be8b5f253ef9a
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
@@ -43,3 +43,5 @@ workflow:
output: codeSamples.yaml
registry:
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
labelOverride:
fixedValue: PlexJS

View File

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

View File

@@ -54,6 +54,7 @@ The following SDKs are generated from the OpenAPI Specification. They are automa
* [Authentication](#authentication)
* [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

View File

@@ -1249,3 +1249,53 @@ Based on:
- [typescript v0.35.1] .
### Releases
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
## 2025-03-31 16:31:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.2] .
### Releases
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
## 2025-03-31 19:33:46
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.3] .
### Releases
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
## 2025-03-31 19:42:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.35.4] .
### Releases
- [NPM v0.35.4] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.4 - .
## 2025-04-03 00:10:29
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.528.1 (2.565.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.36.0] .
### Releases
- [NPM v0.36.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.0 - .
## 2025-04-06 00:11:19
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.529.1 (2.566.5) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.36.1] .
### Releases
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .

View File

@@ -7,7 +7,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getServerCapabilities
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -27,7 +27,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getServerPreferences
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -47,7 +47,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: updatePlayProgress
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -67,7 +67,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: markPlayed
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -87,7 +87,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getTimeline
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { State } from "@lukehagar/plexjs/sdk/models/operations";
@@ -119,7 +119,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: markUnplayed
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -139,7 +139,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getServerActivities
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -159,7 +159,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: cancelServerActivities
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -179,7 +179,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: stopAllTasks
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -199,7 +199,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getButlerTasks
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -219,7 +219,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: startAllTasks
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -239,7 +239,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: stopTask
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
@@ -260,7 +260,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: startTask
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
@@ -281,7 +281,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getAvailableClients
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -301,7 +301,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getCompanionsData
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -321,7 +321,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getDevices
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -341,7 +341,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getUserFriends
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -361,7 +361,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getGeoData
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -379,7 +379,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getHomeData
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -399,7 +399,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getGlobalHubs
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -419,7 +419,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-recently-added
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
@@ -444,7 +444,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: performSearch
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -464,7 +464,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: performVoiceSearch
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -484,7 +484,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getLibraryHubs
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -504,7 +504,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-server-identity
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -522,7 +522,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getTopWatchedContent
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -543,7 +543,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getFileHash
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -563,7 +563,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-media-meta-data
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -593,12 +593,52 @@ actions:
console.log(result);
}
run();
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["get"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getMediaArts(16099);
// Handle the result
console.log(result);
}
run();
- target: $["paths"]["/library/metadata/{ratingKey}/arts"]["post"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
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
label: get-banner-image
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -625,7 +665,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getMetadataChildren
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -640,12 +680,52 @@ actions:
console.log(result);
}
run();
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["get"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
const plexAPI = new PlexAPI({
accessToken: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await plexAPI.library.getMediaPosters(16099);
// Handle the result
console.log(result);
}
run();
- target: $["paths"]["/library/metadata/{ratingKey}/posters"]["post"]
update:
x-codeSamples:
- lang: typescript
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
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
label: get-thumb-image
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -672,7 +752,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-recently-added-library
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -711,7 +791,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-search-all-libraries
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
@@ -738,7 +818,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-all-libraries
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -758,7 +838,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-watch-list
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
@@ -782,7 +862,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: deleteLibrary
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -802,7 +882,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-library-details
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -822,7 +902,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-actors-library
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -843,7 +923,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-all-media-library
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -867,7 +947,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-countries-library
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -888,7 +968,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-genres-library
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -909,7 +989,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-refresh-library-metadata
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
@@ -930,7 +1010,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-search-library
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -951,7 +1031,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-library-items
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
@@ -976,7 +1056,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: logLine
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
@@ -997,7 +1077,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: logMultiLine
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1019,7 +1099,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: enablePaperTrail
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1039,7 +1119,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-media-providers
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1059,7 +1139,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getMyPlexAccount
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1079,7 +1159,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getResizedPhoto
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1108,7 +1188,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getPin
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1132,7 +1212,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getTokenByPinId
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1157,7 +1237,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getPlaylists
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1177,7 +1257,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: createPlaylist
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1203,7 +1283,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: uploadPlaylist
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1224,7 +1304,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: deletePlaylist
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1244,7 +1324,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getPlaylist
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1264,7 +1344,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: updatePlaylist
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1284,7 +1364,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: clearPlaylistContents
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1304,7 +1384,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getPlaylistContents
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1325,7 +1405,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: addPlaylistContents
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1345,7 +1425,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-server-resources
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1365,7 +1445,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getSearchResults
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1385,7 +1465,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getSourceConnectionInformation
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1405,7 +1485,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getTransientToken
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1426,7 +1506,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getServerList
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1446,7 +1526,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getBandwidthStatistics
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1466,7 +1546,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getStatistics
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1486,7 +1566,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getResourcesStatistics
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1506,7 +1586,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getSessions
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1526,7 +1606,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getSessionHistory
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1546,7 +1626,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getTranscodeSessions
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1566,7 +1646,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: stopTranscodeSession
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1586,7 +1666,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: applyUpdates
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1607,7 +1687,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: checkForUpdates
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
@@ -1628,7 +1708,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getUpdateStatus
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1648,7 +1728,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: getTokenDetails
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1668,7 +1748,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: get-users
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1700,7 +1780,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: post-users-sign-in-data
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";
@@ -1729,7 +1809,7 @@ actions:
update:
x-codeSamples:
- lang: typescript
label: startUniversalTranscode
label: PlexJS
source: |-
import { PlexAPI } from "@lukehagar/plexjs";

View File

@@ -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,
};

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

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

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

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

View File

@@ -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" },
}),

View File

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

View File

@@ -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",
};
```

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

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

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -7,7 +7,7 @@ Filter
```typescript
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
let value: Filter = Filter.Released;
let value: Filter = Filter.Available;
```
## Values

View File

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

View File

@@ -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" },
}),

View File

@@ -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",
},
],
};
@@ -39,24 +38,24 @@ let value: GetAllLibrariesDirectory = {
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
| `composite` | *string* | :heavy_check_mark: | N/A | /library/sections/1/composite/1705615584 |
| `filters` | *boolean* | :heavy_check_mark: | N/A | true |
| `refreshing` | *boolean* | :heavy_check_mark: | N/A | false |
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
| `key` | *string* | :heavy_check_mark: | N/A | 1 |
| `type` | *string* | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | N/A | Movies |
| `agent` | *string* | :heavy_check_mark: | N/A | tv.plex.agents.movie |
| `scanner` | *string* | :heavy_check_mark: | N/A | Plex Movie |
| `language` | *string* | :heavy_check_mark: | N/A | en-US |
| `uuid` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `createdAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `content` | *boolean* | :heavy_check_mark: | N/A | true |
| `directory` | *boolean* | :heavy_check_mark: | N/A | true |
| `contentChangedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
| `hidden` | *number* | :heavy_check_mark: | N/A | 0 |
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
| `contentChangedAt` | *number* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 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 | |

View File

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

View File

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

View File

@@ -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",
},
],
},

View File

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

View File

@@ -0,0 +1,22 @@
# GetAllLibrariesType
The library type
## Example Usage
```typescript
import { GetAllLibrariesType } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetAllLibrariesType = GetAllLibrariesType.Movie;
```
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -6,7 +6,7 @@
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetLibraryHubsRequest = {
sectionId: 2900.77,
sectionId: 7247.75,
};
```

View File

@@ -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" },
}),

View File

@@ -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,
};

View File

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

View File

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

View File

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

View File

@@ -0,0 +1,44 @@
# GetMediaArtsResponse
## Example Usage
```typescript
import { GetMediaArtsResponse } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMediaArtsResponse = {
contentType: "<value>",
statusCode: 301,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 50,
mediaTagVersion: 1734362201,
mediaTagPrefix: "/system/bundle/media/flags/",
identifier: "com.plexapp.plugins.library",
metadata: [
{
key:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
provider: "tmdb",
ratingKey:
"https://image.tmdb.org/t/p/original/ixgFmf1X59PUZam2qbAfskx2gQr.jpg",
selected: true,
thumb:
"https://images.plex.tv/photo?height=270&width=480&minSize=1&upscale=1&url=https%3A%2F%2Fimage%2Etmdb%2Eorg%2Ft%2Fp%2Foriginal%2FixgFmf1X59PUZam2qbAfskx2gQr%2Ejpg",
},
],
},
},
};
```
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `object` | [operations.GetMediaArtsResponseBody](../../../sdk/models/operations/getmediaartsresponsebody.md) | :heavy_minus_sign: | The available background artwork for the library item. |

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

View File

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

View File

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

View File

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

View File

@@ -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" },
}),

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

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

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

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

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

View File

@@ -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" },
}),

View File

@@ -6,7 +6,7 @@
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetMetadataChildrenRequest = {
ratingKey: 3119.45,
ratingKey: 786.26,
};
```

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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,
};
```

View File

@@ -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" },
}),

View File

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

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

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

View File

@@ -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,
};

View File

@@ -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" },
}),

View File

@@ -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" },
}),

View File

@@ -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",
};
```

View File

@@ -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" },
}),

View File

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

View File

@@ -9,7 +9,7 @@ let value: GetSearchAllLibrariesRequest = {
query: "<value>",
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
searchTypes: [
SearchTypes.Movies,
SearchTypes.People,
],
};
```

View File

@@ -16,16 +16,16 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetSearchAllLibrariesResponse = {
contentType: "<value>",
statusCode: 100,
statusCode: 101,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
object: {
mediaContainer: {
size: 6214.79,
size: 9603.99,
searchResult: [
{
score: 5772.29,
score: 6503,
metadata: {
ratingKey: "58683",
key: "/library/metadata/58683",

View File

@@ -18,10 +18,10 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetSearchAllLibrariesResponseBody = {
mediaContainer: {
size: 9280.82,
size: 8897.34,
searchResult: [
{
score: 7044.15,
score: 1602.08,
metadata: {
ratingKey: "58683",
key: "/library/metadata/58683",

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -7,14 +7,14 @@ import { GetServerResourcesResponse, Protocol } from "@lukehagar/plexjs/sdk/mode
let value: GetServerResourcesResponse = {
contentType: "<value>",
statusCode: 102,
statusCode: 303,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
plexDevices: [
{
name: "<value>",
product: "Generic Cotton Pants",
product: "Gorgeous Steel Chair",
productVersion: "<value>",
platform: "<value>",
platformVersion: "<value>",
@@ -23,7 +23,7 @@ let value: GetServerResourcesResponse = {
createdAt: new Date("2019-06-24T11:38:02Z"),
lastSeenAt: new Date("2019-06-24T11:38:02Z"),
provides: "<value>",
ownerId: 828940,
ownerId: 399166,
sourceTitle: "<value>",
publicAddress: "<value>",
accessToken: "<value>",
@@ -39,9 +39,9 @@ let value: GetServerResourcesResponse = {
connections: [
{
protocol: Protocol.Http,
address: "72792 Medhurst Mountains",
port: 14619,
uri: "https://kaleidoscopic-status.net",
address: "29059 Ward Lake",
port: 52102,
uri: "https://old-validity.info",
local: false,
relay: false,
iPv6: false,

View File

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

View File

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

View File

@@ -6,7 +6,7 @@
import { GetSourceConnectionInformationRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSourceConnectionInformationRequest = {
source: "server://client-identifier",
source: "provider://provider-identifier",
};
```

View File

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

View File

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

View File

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

View File

@@ -6,7 +6,7 @@
import { GetTokenByPinIdRequest } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetTokenByPinIdRequest = {
pinID: 396506,
pinID: 721343,
clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
clientName: "Plex for Roku",
deviceNickname: "Roku 3",

View File

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

View File

@@ -13,7 +13,7 @@ import {
let value: GetTokenDetailsResponse = {
contentType: "<value>",
statusCode: 508,
statusCode: 200,
rawResponse: new Response("{\"message\": \"hello world\"}", {
headers: { "Content-Type": "application/json" },
}),
@@ -31,7 +31,7 @@ let value: GetTokenDetailsResponse = {
homeSize: 1,
id: 13692262,
joinedAt: 1556281940,
locale: "pl",
locale: "nl",
mailingListStatus: MailingListStatus.Active,
maxHomeSize: 15,
profile: {

View File

@@ -27,7 +27,7 @@ let value: GetTokenDetailsUserPlexAccount = {
homeSize: 1,
id: 13692262,
joinedAt: 1556281940,
locale: "ja",
locale: "zh",
mailingListStatus: MailingListStatus.Active,
maxHomeSize: 15,
profile: {

View File

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

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