mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 | ||
|
|
1a8e227874 | ||
|
|
8360d057ab |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
/.speakeasy/reports
|
||||
/react-query
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
!/REACT_QUERY.md
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.mjs
|
||||
!/**/*.json
|
||||
!/**/*.map
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -7,13 +7,15 @@ generation:
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: false
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.32.5
|
||||
version: 0.35.3
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -23,6 +25,7 @@ typescript:
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableMCPServer: true
|
||||
enableReactQuery: false
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
@@ -36,6 +39,7 @@ typescript:
|
||||
shared: sdk/models/shared
|
||||
webhooks: sdk/models/webhooks
|
||||
inputModelSuffix: input
|
||||
jsonpath: legacy
|
||||
maxMethodParams: 4
|
||||
methodArguments: require-security-and-request
|
||||
moduleFormat: commonjs
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.484.1
|
||||
speakeasyVersion: 1.526.6
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
sourceRevisionDigest: sha256:277010613dd132c4b785bacddcba720038318ae87b0ce5e1eea3887cf8f22df4
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1738800605
|
||||
- speakeasy-sdk-regen-1743449645
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:e6ab335dd91a4165f4510e4a3af8a55819c6310b7e66251266d2384376f3ccae
|
||||
sourceBlobDigest: sha256:89d1b1133e400c89f0d06efe5e5168f5ba25a413e1ab8380d442d6b233e2e5a9
|
||||
sourceRevisionDigest: sha256:277010613dd132c4b785bacddcba720038318ae87b0ce5e1eea3887cf8f22df4
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:214b9a57e050598b3c15f0f8504a591973e8399cad8b8be2917772c3f75861a9
|
||||
codeSamplesRevisionDigest: sha256:f99618862675a8c5993740b2acb9b573110d9b506d2bc70e3180f0f7f393798f
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -43,3 +43,6 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
langOverride: TypeScript
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
@@ -17,3 +17,6 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
langOverride: TypeScript
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
44
README.md
44
README.md
@@ -159,15 +159,16 @@ run();
|
||||
* [getLibraryDetails](docs/sdks/library/README.md#getlibrarydetails) - Get Library Details
|
||||
* [deleteLibrary](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
* [getLibraryItems](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
* [getAllMediaLibrary](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||
* [getRefreshLibraryMetadata](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
* [getSearchLibrary](docs/sdks/library/README.md#getsearchlibrary) - Search Library
|
||||
* [getGenresLibrary](docs/sdks/library/README.md#getgenreslibrary) - Get Genres of library media
|
||||
* [getCountriesLibrary](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||
* [getActorsLibrary](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
* [getSearchAllLibraries](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
* [getMetaDataByRatingKey](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
@@ -342,13 +343,39 @@ In some rare cases, the SDK can fail to get a response from the server or even m
|
||||
### Server Variables
|
||||
|
||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||
* `protocol: models.ServerProtocol`
|
||||
* `ip: string`
|
||||
* `port: string`
|
||||
|
||||
| Variable | Parameter | Supported Values | Default | Description |
|
||||
| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||
| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
|
||||
|
||||
#### Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
protocol: "https",
|
||||
ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
|
||||
port: "40311",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -508,15 +535,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [`hubsGetLibraryHubs`](docs/sdks/hubs/README.md#getlibraryhubs) - Get library specific hubs
|
||||
- [`hubsGetRecentlyAdded`](docs/sdks/hubs/README.md#getrecentlyadded) - Get Recently Added
|
||||
- [`libraryDeleteLibrary`](docs/sdks/library/README.md#deletelibrary) - Delete Library Section
|
||||
- [`libraryGetActorsLibrary`](docs/sdks/library/README.md#getactorslibrary) - Get Actors of library media
|
||||
- [`libraryGetAllLibraries`](docs/sdks/library/README.md#getalllibraries) - Get All Libraries
|
||||
- [`libraryGetAllMediaLibrary`](docs/sdks/library/README.md#getallmedialibrary) - Get all media of library
|
||||
- [`libraryGetCountriesLibrary`](docs/sdks/library/README.md#getcountrieslibrary) - Get Countries of library media
|
||||
- [`libraryGetFileHash`](docs/sdks/library/README.md#getfilehash) - Get Hash Value
|
||||
- [`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
|
||||
- [`libraryGetMetaDataByRatingKey`](docs/sdks/library/README.md#getmetadatabyratingkey) - Get Metadata by RatingKey
|
||||
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
|
||||
62
RELEASES.md
62
RELEASES.md
@@ -1208,4 +1208,64 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.32.5] .
|
||||
### Releases
|
||||
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
|
||||
- [NPM v0.32.5] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.32.5 - .
|
||||
|
||||
## 2025-02-07 00:09:41
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.33.0] .
|
||||
### Releases
|
||||
- [NPM v0.33.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.33.0 - .
|
||||
|
||||
## 2025-02-10 00:10:04
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.487.1 (2.506.0) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.34.0] .
|
||||
### Releases
|
||||
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
|
||||
|
||||
## 2025-03-07 00:09:55
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.0] .
|
||||
### Releases
|
||||
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
|
||||
|
||||
## 2025-03-09 00:09:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.1] .
|
||||
### Releases
|
||||
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
|
||||
|
||||
## 2025-03-31 16:31:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.2] .
|
||||
### Releases
|
||||
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
|
||||
|
||||
## 2025-03-31 19:33:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.3] .
|
||||
### Releases
|
||||
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
|
||||
402
codeSamples.yaml
402
codeSamples.yaml
@@ -6,8 +6,8 @@ actions:
|
||||
- target: $["paths"]["/"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerCapabilities
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -26,8 +26,8 @@ actions:
|
||||
- target: $["paths"]["/:/prefs"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerPreferences
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -46,8 +46,8 @@ actions:
|
||||
- target: $["paths"]["/:/progress"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: updatePlayProgress
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -66,8 +66,8 @@ actions:
|
||||
- target: $["paths"]["/:/scrobble"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: markPlayed
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -86,8 +86,8 @@ actions:
|
||||
- target: $["paths"]["/:/timeline"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTimeline
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { State } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -118,8 +118,8 @@ actions:
|
||||
- target: $["paths"]["/:/unscrobble"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: markUnplayed
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -138,8 +138,8 @@ actions:
|
||||
- target: $["paths"]["/activities"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerActivities
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -158,8 +158,8 @@ actions:
|
||||
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: cancelServerActivities
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -178,8 +178,8 @@ actions:
|
||||
- target: $["paths"]["/butler"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopAllTasks
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -198,8 +198,8 @@ actions:
|
||||
- target: $["paths"]["/butler"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getButlerTasks
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -218,8 +218,8 @@ actions:
|
||||
- target: $["paths"]["/butler"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startAllTasks
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -238,8 +238,8 @@ actions:
|
||||
- target: $["paths"]["/butler/{taskName}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopTask
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -259,8 +259,8 @@ actions:
|
||||
- target: $["paths"]["/butler/{taskName}"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startTask
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -280,8 +280,8 @@ actions:
|
||||
- target: $["paths"]["/clients"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getAvailableClients
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -300,8 +300,8 @@ actions:
|
||||
- target: $["paths"]["/companions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getCompanionsData
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -320,8 +320,8 @@ actions:
|
||||
- target: $["paths"]["/devices"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getDevices
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -340,8 +340,8 @@ actions:
|
||||
- target: $["paths"]["/friends"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUserFriends
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -360,8 +360,8 @@ actions:
|
||||
- target: $["paths"]["/geoip"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getGeoData
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -378,8 +378,8 @@ actions:
|
||||
- target: $["paths"]["/home"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getHomeData
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -398,8 +398,8 @@ actions:
|
||||
- target: $["paths"]["/hubs"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getGlobalHubs
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -418,8 +418,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: added
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -443,8 +443,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: performSearch
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -463,8 +463,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/search/voice"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: performVoiceSearch
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -483,8 +483,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/sections/{sectionId}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getLibraryHubs
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -503,8 +503,8 @@ actions:
|
||||
- target: $["paths"]["/identity"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: identity
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -521,8 +521,8 @@ actions:
|
||||
- target: $["paths"]["/library/all/top"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTopWatchedContent
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -542,8 +542,8 @@ actions:
|
||||
- target: $["paths"]["/library/hashes"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getFileHash
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -562,8 +562,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: key
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -572,7 +572,22 @@ actions:
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getMetaDataByRatingKey(9518);
|
||||
const result = await plexAPI.library.getMediaMetaData({
|
||||
ratingKey: 9518,
|
||||
includeConcerts: true,
|
||||
includeExtras: true,
|
||||
includeOnDeck: true,
|
||||
includePopularLeaves: true,
|
||||
includePreferences: true,
|
||||
includeReviews: true,
|
||||
includeChapters: true,
|
||||
includeStations: true,
|
||||
includeExternalMedia: true,
|
||||
asyncAugmentMetadata: true,
|
||||
asyncCheckFiles: true,
|
||||
asyncRefreshAnalysis: true,
|
||||
asyncRefreshLocalMediaAgent: true,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -582,8 +597,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: image
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -609,8 +624,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getMetadataChildren
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -629,8 +644,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: image
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -652,32 +667,12 @@ actions:
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/onDeck"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getOnDeck
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getOnDeck();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -715,8 +710,8 @@ actions:
|
||||
- target: $["paths"]["/library/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: libraries
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -742,8 +737,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: libraries
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -762,8 +757,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: list
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -786,8 +781,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: deleteLibrary
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -806,8 +801,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: details
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -823,20 +818,66 @@ actions:
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getCountriesLibrary(9518);
|
||||
const result = await plexAPI.library.getActorsLibrary(9518, GetActorsLibraryQueryParamType.TvShow);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getAllMediaLibrary({
|
||||
sectionKey: 9518,
|
||||
type: GetAllMediaLibraryQueryParamType.TvShow,
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getCountriesLibrary(9518, GetCountriesLibraryQueryParamType.TvShow);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -846,17 +887,18 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/genre"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getGenresLibrary(9518);
|
||||
const result = await plexAPI.library.getGenresLibrary(9518, GetGenresLibraryQueryParamType.TvShow);
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -866,8 +908,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: metadata
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -887,8 +929,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -908,8 +950,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: items
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -933,8 +975,8 @@ actions:
|
||||
- target: $["paths"]["/log"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: logLine
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -954,8 +996,8 @@ actions:
|
||||
- target: $["paths"]["/log"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: logMultiLine
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -976,8 +1018,8 @@ actions:
|
||||
- target: $["paths"]["/log/networked"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: enablePaperTrail
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -996,8 +1038,8 @@ actions:
|
||||
- target: $["paths"]["/media/providers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: providers
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1016,8 +1058,8 @@ actions:
|
||||
- target: $["paths"]["/myplex/account"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getMyPlexAccount
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1036,8 +1078,8 @@ actions:
|
||||
- target: $["paths"]["/photo/:/transcode"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getResizedPhoto
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1065,8 +1107,8 @@ actions:
|
||||
- target: $["paths"]["/pins"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPin
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1089,8 +1131,8 @@ actions:
|
||||
- target: $["paths"]["/pins/{pinID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTokenByPinId
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1114,8 +1156,8 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylists
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1134,8 +1176,8 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: createPlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1160,8 +1202,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/upload"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: uploadPlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1181,8 +1223,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: deletePlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1201,8 +1243,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1221,8 +1263,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: updatePlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1241,8 +1283,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: clearPlaylistContents
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1261,8 +1303,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylistContents
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1282,8 +1324,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: addPlaylistContents
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1302,8 +1344,8 @@ actions:
|
||||
- target: $["paths"]["/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: resources
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1322,8 +1364,8 @@ actions:
|
||||
- target: $["paths"]["/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSearchResults
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1342,8 +1384,8 @@ actions:
|
||||
- target: $["paths"]["/security/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSourceConnectionInformation
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1362,8 +1404,8 @@ actions:
|
||||
- target: $["paths"]["/security/token"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTransientToken
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1383,8 +1425,8 @@ actions:
|
||||
- target: $["paths"]["/servers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerList
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1403,8 +1445,8 @@ actions:
|
||||
- target: $["paths"]["/statistics/bandwidth"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getBandwidthStatistics
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1423,8 +1465,8 @@ actions:
|
||||
- target: $["paths"]["/statistics/media"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getStatistics
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1443,8 +1485,8 @@ actions:
|
||||
- target: $["paths"]["/statistics/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getResourcesStatistics
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1463,8 +1505,8 @@ actions:
|
||||
- target: $["paths"]["/status/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSessions
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1483,8 +1525,8 @@ actions:
|
||||
- target: $["paths"]["/status/sessions/history/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSessionHistory
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1503,8 +1545,8 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTranscodeSessions
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1523,8 +1565,8 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopTranscodeSession
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1543,8 +1585,8 @@ actions:
|
||||
- target: $["paths"]["/updater/apply"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: applyUpdates
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1564,8 +1606,8 @@ actions:
|
||||
- target: $["paths"]["/updater/check"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: checkForUpdates
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1585,8 +1627,8 @@ actions:
|
||||
- target: $["paths"]["/updater/status"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUpdateStatus
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1605,8 +1647,8 @@ actions:
|
||||
- target: $["paths"]["/user"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTokenDetails
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1625,8 +1667,8 @@ actions:
|
||||
- target: $["paths"]["/users"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: users
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1657,8 +1699,8 @@ actions:
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: data
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1686,8 +1728,8 @@ actions:
|
||||
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startUniversalTranscode
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckUnauthorized
|
||||
# GetActorsLibraryBadRequest
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
@@ -14,5 +14,5 @@ import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckLibraryErrors](../../../sdk/models/errors/getondecklibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `errors` | [errors.GetActorsLibraryErrors](../../../sdk/models/errors/getactorslibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckErrors
|
||||
# GetActorsLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckErrors = {
|
||||
let value: GetActorsLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetOnDeckLibraryErrors
|
||||
# GetActorsLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetActorsLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckLibraryErrors = {
|
||||
let value: GetActorsLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getactorslibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetActorsLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetActorsLibraryLibraryErrors](../../../sdk/models/errors/getactorslibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllMediaLibraryErrors](../../../sdk/models/errors/getallmedialibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyErrors
|
||||
# GetAllMediaLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMetaDataByRatingKeyErrors = {
|
||||
let value: GetAllMediaLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
@@ -1,11 +1,11 @@
|
||||
# GetMetaDataByRatingKeyLibraryErrors
|
||||
# GetAllMediaLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMetaDataByRatingKeyLibraryErrors = {
|
||||
let value: GetAllMediaLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllMediaLibraryLibraryErrors](../../../sdk/models/errors/getallmedialibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
18
docs/sdk/models/errors/getmediametadatabadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMediaMetaDataErrors](../../../sdk/models/errors/getmediametadataerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadataerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMediaMetaDataErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
21
docs/sdk/models/errors/getmediametadatalibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetMediaMetaDataLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
18
docs/sdk/models/errors/getmediametadataunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMediaMetaDataLibraryErrors](../../../sdk/models/errors/getmediametadatalibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetaDataByRatingKeyBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMetaDataByRatingKeyErrors](../../../sdk/models/errors/getmetadatabyratingkeyerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetMetaDataByRatingKeyUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetMetaDataByRatingKeyLibraryErrors](../../../sdk/models/errors/getmetadatabyratingkeylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetOnDeckBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckErrors](../../../sdk/models/errors/getondeckerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 1856.36,
|
||||
playlistID: 2776.28,
|
||||
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: 507,
|
||||
statusCode: 307,
|
||||
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: 205,
|
||||
statusCode: 208,
|
||||
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: 863856,
|
||||
paymentMethodId: 903720,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 424,
|
||||
statusCode: 428,
|
||||
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: 8726.51,
|
||||
playlistID: 4246.85,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 207,
|
||||
statusCode: 204,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Collection = {
|
||||
tag: "Working NL Subs",
|
||||
tag: "My Awesome Collection",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
@@ -1,17 +1,23 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Country } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Country = {
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | country=19 |
|
||||
@@ -7,7 +7,7 @@ type of playlist to create
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -8,8 +8,8 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Audio,
|
||||
smart: Smart.Zero,
|
||||
uri: "https://general-possession.info/",
|
||||
smart: Smart.One,
|
||||
uri: "https://ajar-reward.biz/",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 100,
|
||||
statusCode: 205,
|
||||
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: 507,
|
||||
statusCode: 451,
|
||||
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: 6630.78,
|
||||
playlistID: 6874.88,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 200,
|
||||
statusCode: 226,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Director = {
|
||||
tag: "James Cameron",
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 508,
|
||||
statusCode: 304,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.All;
|
||||
let value: Filter = Filter.Released;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -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.Zero;
|
||||
let value: Force = Force.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -1,17 +1,23 @@
|
||||
# Genre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Genre = {
|
||||
tag: "Adventure",
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
24
docs/sdk/models/operations/getactorslibrarydirectory.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetActorsLibraryDirectory
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryDirectory } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryDirectory = {
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `fastKey` | *string* | :heavy_check_mark: | A fast lookup key for the actor relative url. | /library/sections/2/all?actor=134671 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the actor. | https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg |
|
||||
| `key` | *string* | :heavy_check_mark: | A unique key representing the actor. | 134671 |
|
||||
| `title` | *string* | :heavy_check_mark: | The name of the actor. | Aaron Paul |
|
||||
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
49
docs/sdk/models/operations/getactorslibrarymediacontainer.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# GetActorsLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryMediaContainer = {
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
viewMode: "131131",
|
||||
directory: [
|
||||
{
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
30
docs/sdk/models/operations/getactorslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# GetActorsLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryQueryParamType =
|
||||
GetActorsLibraryQueryParamType.TvShow;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
19
docs/sdk/models/operations/getactorslibraryrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetActorsLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryQueryParamType, GetActorsLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
type: GetActorsLibraryQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [operations.GetActorsLibraryQueryParamType](../../../sdk/models/operations/getactorslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
49
docs/sdk/models/operations/getactorslibraryresponse.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# GetActorsLibraryResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
viewMode: "131131",
|
||||
directory: [
|
||||
{
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetActorsLibraryResponseBody](../../../sdk/models/operations/getactorslibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
41
docs/sdk/models/operations/getactorslibraryresponsebody.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# GetActorsLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetActorsLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetActorsLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
viewMode: "131131",
|
||||
directory: [
|
||||
{
|
||||
fastKey: "/library/sections/2/all?actor=134671",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/e/people/e2a915b537ef720252b6d408bc1f91b3.jpg",
|
||||
key: "134671",
|
||||
title: "Aaron Paul",
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetActorsLibraryMediaContainer](../../../sdk/models/operations/getactorslibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -7,7 +7,7 @@ import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: GetAllLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 508,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryActiveDirection =
|
||||
GetAllMediaLibraryActiveDirection.Ascending;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryCollection
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryCollection = {
|
||||
tag: "My Awesome Collection",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
17
docs/sdk/models/operations/getallmedialibrarycountry.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycountry.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryCountry
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryCountry = {
|
||||
tag: "United States of America",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryDefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryDefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryDefaultDirection =
|
||||
GetAllMediaLibraryDefaultDirection.Ascending;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
17
docs/sdk/models/operations/getallmedialibrarydirector.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarydirector.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryDirector
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryDirector = {
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
23
docs/sdk/models/operations/getallmedialibraryfield.md
Normal file
23
docs/sdk/models/operations/getallmedialibraryfield.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryField
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryField } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryField = {
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||
24
docs/sdk/models/operations/getallmedialibraryfieldtype.md
Normal file
24
docs/sdk/models/operations/getallmedialibraryfieldtype.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetAllMediaLibraryFieldType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryFieldType = {
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | [operations.GetAllMediaLibraryOperator](../../../sdk/models/operations/getallmedialibraryoperator.md)[] | :heavy_check_mark: | N/A | |
|
||||
27
docs/sdk/models/operations/getallmedialibraryfilter.md
Normal file
27
docs/sdk/models/operations/getallmedialibraryfilter.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# GetAllMediaLibraryFilter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryFilter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryFilter = {
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
17
docs/sdk/models/operations/getallmedialibrarygenre.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarygenre.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryGenre
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGenre = {
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
17
docs/sdk/models/operations/getallmedialibraryguids.md
Normal file
17
docs/sdk/models/operations/getallmedialibraryguids.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryGuids
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryGuids } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGuids = {
|
||||
id: "tvdb://2337",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
||||
18
docs/sdk/models/operations/getallmedialibraryhasthumbnail.md
Normal file
18
docs/sdk/models/operations/getallmedialibraryhasthumbnail.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryHasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryHasThumbnail } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryHasThumbnail = GetAllMediaLibraryHasThumbnail.True;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
21
docs/sdk/models/operations/getallmedialibraryimage.md
Normal file
21
docs/sdk/models/operations/getallmedialibraryimage.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryImage
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryImage, GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryImage = {
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetAllMediaLibraryLibraryResponseType](../../../sdk/models/operations/getallmedialibrarylibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetAllMediaLibraryOptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.GetAllMediaLibraryOptimizedForStreaming1 =
|
||||
GetAllMediaLibraryOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryLibraryResponseType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryResponseType =
|
||||
GetAllMediaLibraryLibraryResponseType.Background;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
23
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
23
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryLibraryType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
121
docs/sdk/models/operations/getallmedialibrarymedia.md
Normal file
121
docs/sdk/models/operations/getallmedialibrarymedia.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# GetAllMediaLibraryMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMedia = {
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
307
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
Normal file
307
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
Normal file
@@ -0,0 +1,307 @@
|
||||
# GetAllMediaLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMediaContainer,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryMediaContainer = {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `totalSize` | *number* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *number* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `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 |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `meta` | [operations.GetAllMediaLibraryMeta](../../../sdk/models/operations/getallmedialibrarymeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
| `metadata` | [operations.GetAllMediaLibraryMetadata](../../../sdk/models/operations/getallmedialibrarymetadata.md)[] | :heavy_minus_sign: | An array of metadata items. | |
|
||||
68
docs/sdk/models/operations/getallmedialibrarymeta.md
Normal file
68
docs/sdk/models/operations/getallmedialibrarymeta.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# GetAllMediaLibraryMeta
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMeta = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.GetAllMediaLibraryType](../../../sdk/models/operations/getallmedialibrarytype.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | [operations.GetAllMediaLibraryFieldType](../../../sdk/models/operations/getallmedialibraryfieldtype.md)[] | :heavy_minus_sign: | N/A |
|
||||
@@ -1,101 +1,175 @@
|
||||
# GetMetaDataByRatingKeyMetadata
|
||||
# GetAllMediaLibraryMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMetaDataByRatingKeyMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMetadata,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMetaDataByRatingKeyMetadata = {
|
||||
ratingKey: "17",
|
||||
key: "/library/metadata/17",
|
||||
guid: "plex://movie/5d77683f6f4521001ea9dc53",
|
||||
studio: "Universal Pictures",
|
||||
type: "movie",
|
||||
title: "Serenity",
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
let value: GetAllMediaLibraryMetadata = {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
|
||||
rating: 8.2,
|
||||
audienceRating: 9.1,
|
||||
year: 2005,
|
||||
tagline: "They aim to misbehave.",
|
||||
thumb: "/library/metadata/17/thumb/1705637165",
|
||||
art: "/library/metadata/17/art/1705637165",
|
||||
duration: 141417,
|
||||
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"),
|
||||
addedAt: 1705637164,
|
||||
updatedAt: 1705637165,
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
hasPremiumPrimaryExtra: "1",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 15,
|
||||
duration: 141417,
|
||||
bitrate: 2278,
|
||||
width: 1920,
|
||||
height: 814,
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "h264",
|
||||
videoResolution: "1080",
|
||||
container: "mp4",
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
optimizedForStreaming: 0,
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
videoProfile: "high",
|
||||
part: [
|
||||
{
|
||||
id: 15,
|
||||
key: "/library/parts/15/1705637151/file.mp4",
|
||||
duration: 141417,
|
||||
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
size: 40271948,
|
||||
audioProfile: "lc",
|
||||
container: "mp4",
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "high",
|
||||
stream: [
|
||||
{
|
||||
id: 29,
|
||||
streamType: 2,
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "aac",
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 128,
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "14520",
|
||||
codedHeight: 816,
|
||||
codedWidth: 1920,
|
||||
colorPrimaries: "bt709",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt709",
|
||||
colorTrc: "bt709",
|
||||
frameRate: 24,
|
||||
hasScalingMatrix: false,
|
||||
height: 814,
|
||||
level: 40,
|
||||
profile: "lc",
|
||||
refFrames: 4,
|
||||
scanType: "progressive",
|
||||
streamIdentifier: "1",
|
||||
width: 1920,
|
||||
displayTitle: "English (AAC Stereo)",
|
||||
extendedDisplayTitle: "English (AAC Stereo)",
|
||||
selected: true,
|
||||
channels: 2,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
samplingRate: 44100,
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -104,69 +178,37 @@ let value: GetMetaDataByRatingKeyMetadata = {
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
id: 184,
|
||||
filter: "genre=184",
|
||||
tag: "Thriller",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 116,
|
||||
filter: "country=116",
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
ratings: [
|
||||
collection: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 7.4,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 130,
|
||||
filter: "director=130",
|
||||
tag: "Joss Whedon",
|
||||
tagKey: "5d776828880197001ec90e8f",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 132,
|
||||
filter: "writer=132",
|
||||
tag: "Joss Whedon",
|
||||
tagKey: "5d776828880197001ec90e8f",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 220,
|
||||
filter: "actor=220",
|
||||
tag: "Dennis Keiffer",
|
||||
tagKey: "5d77683554f42c001f8c4708",
|
||||
role: "Bar Guy (uncredited)",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 221,
|
||||
filter: "producer=221",
|
||||
tag: "Barry Mendel",
|
||||
tagKey: "5d776826961905001eb90e2b",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg",
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -174,43 +216,69 @@ let value: GetMetaDataByRatingKeyMetadata = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 17 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | Universal Pictures |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Serenity |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The name of the album artist for the track when audio, and the name of the TV show for the episode when video. | |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The name of the album for the track when audio, and the name of the season for the episode when TV show. | |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The orginal untranslated name of the media item when non-english. | |
|
||||
| `index` | *number* | :heavy_minus_sign: | The index starting from 0 of this media item in the MetaData array. | |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The parent index starting from 0 of this media item in the parent MetaData array. | |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2005 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 141417 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `media` | [operations.GetMetaDataByRatingKeyMedia](../../../sdk/models/operations/getmetadatabyratingkeymedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.GetMetaDataByRatingKeyGenre](../../../sdk/models/operations/getmetadatabyratingkeygenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetMetaDataByRatingKeyCountry](../../../sdk/models/operations/getmetadatabyratingkeycountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetMetaDataByRatingKeyDirector](../../../sdk/models/operations/getmetadatabyratingkeydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetMetaDataByRatingKeyWriter](../../../sdk/models/operations/getmetadatabyratingkeywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetMetaDataByRatingKeyRole](../../../sdk/models/operations/getmetadatabyratingkeyrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `type` | [operations.GetAllMediaLibraryLibraryType](../../../sdk/models/operations/getallmedialibrarylibrarytype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||
| `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `createdAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||
| `createdAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | [operations.GetAllMediaLibraryImage](../../../sdk/models/operations/getallmedialibraryimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [operations.GetAllMediaLibraryUltraBlurColors](../../../sdk/models/operations/getallmedialibraryultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `media` | [operations.GetAllMediaLibraryMedia](../../../sdk/models/operations/getallmedialibrarymedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.GetAllMediaLibraryGenre](../../../sdk/models/operations/getallmedialibrarygenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetAllMediaLibraryCountry](../../../sdk/models/operations/getallmedialibrarycountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetAllMediaLibraryGuids](../../../sdk/models/operations/getallmedialibraryguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
19
docs/sdk/models/operations/getallmedialibraryoperator.md
Normal file
19
docs/sdk/models/operations/getallmedialibraryoperator.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryOperator
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryOperator = {
|
||||
key: "=",
|
||||
title: "is",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.OptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryOptimizedForStreaming1
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryOptimizedForStreaming1 =
|
||||
GetAllMediaLibraryOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
97
docs/sdk/models/operations/getallmedialibrarypart.md
Normal file
97
docs/sdk/models/operations/getallmedialibrarypart.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# GetAllMediaLibraryPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryPart = {
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *operations.GetAllMediaLibraryLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `hasThumbnail` | [operations.GetAllMediaLibraryHasThumbnail](../../../sdk/models/operations/getallmedialibraryhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | [operations.GetAllMediaLibraryStream](../../../sdk/models/operations/getallmedialibrarystream.md)[] | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryQueryParamIncludeMeta
|
||||
|
||||
Adds the Meta object to the response
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryQueryParamIncludeMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryQueryParamIncludeMeta =
|
||||
GetAllMediaLibraryQueryParamIncludeMeta.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -0,0 +1,30 @@
|
||||
# GetAllMediaLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryQueryParamType =
|
||||
GetAllMediaLibraryQueryParamType.TvShow;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
26
docs/sdk/models/operations/getallmedialibraryrequest.md
Normal file
26
docs/sdk/models/operations/getallmedialibraryrequest.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetAllMediaLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryQueryParamType, GetAllMediaLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
type: GetAllMediaLibraryQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [operations.GetAllMediaLibraryQueryParamType](../../../sdk/models/operations/getallmedialibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `includeMeta` | [operations.GetAllMediaLibraryQueryParamIncludeMeta](../../../sdk/models/operations/getallmedialibraryqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `includeGuids` | [operations.QueryParamIncludeGuids](../../../sdk/models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||
| `includeAdvanced` | [operations.IncludeAdvanced](../../../sdk/models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeCollections` | [operations.QueryParamIncludeCollections](../../../sdk/models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeExternalMedia` | [operations.QueryParamIncludeExternalMedia](../../../sdk/models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
301
docs/sdk/models/operations/getallmedialibraryresponse.md
Normal file
301
docs/sdk/models/operations/getallmedialibraryresponse.md
Normal file
@@ -0,0 +1,301 @@
|
||||
# GetAllMediaLibraryResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponse,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## 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.GetAllMediaLibraryResponseBody](../../../sdk/models/operations/getallmedialibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
293
docs/sdk/models/operations/getallmedialibraryresponsebody.md
Normal file
293
docs/sdk/models/operations/getallmedialibraryresponsebody.md
Normal file
@@ -0,0 +1,293 @@
|
||||
# GetAllMediaLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponseBody,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetAllMediaLibraryMediaContainer](../../../sdk/models/operations/getallmedialibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
17
docs/sdk/models/operations/getallmedialibraryrole.md
Normal file
17
docs/sdk/models/operations/getallmedialibraryrole.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryRole
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryRole = {
|
||||
tag: "Teller",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
29
docs/sdk/models/operations/getallmedialibrarysort.md
Normal file
29
docs/sdk/models/operations/getallmedialibrarysort.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# GetAllMediaLibrarySort
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibrarySort = {
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `activeDirection` | [operations.GetAllMediaLibraryActiveDirection](../../../sdk/models/operations/getallmedialibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `defaultDirection` | [operations.GetAllMediaLibraryDefaultDirection](../../../sdk/models/operations/getallmedialibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `descKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `firstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||
113
docs/sdk/models/operations/getallmedialibrarystream.md
Normal file
113
docs/sdk/models/operations/getallmedialibrarystream.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# GetAllMediaLibraryStream
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryStream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
56
docs/sdk/models/operations/getallmedialibrarytype.md
Normal file
56
docs/sdk/models/operations/getallmedialibrarytype.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# GetAllMediaLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | [operations.GetAllMediaLibraryFilter](../../../sdk/models/operations/getallmedialibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | [operations.GetAllMediaLibrarySort](../../../sdk/models/operations/getallmedialibrarysort.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | [operations.GetAllMediaLibraryField](../../../sdk/models/operations/getallmedialibraryfield.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryUltraBlurColors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryUltraBlurColors = {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `topLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `topRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `bottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `bottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
17
docs/sdk/models/operations/getallmedialibrarywriter.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarywriter.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryWriter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryWriter = {
|
||||
tag: "Jamie P. Hanson",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 423,
|
||||
statusCode: 205,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,16 +7,16 @@ import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/
|
||||
|
||||
let value: GetCountriesLibraryMediaContainer = {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Country",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
@@ -32,18 +32,16 @@ let value: GetCountriesLibraryMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `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 |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,30 @@
|
||||
# GetCountriesLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetCountriesLibraryQueryParamType =
|
||||
GetCountriesLibraryQueryParamType.TvShow;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
@@ -3,15 +3,17 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetCountriesLibraryQueryParamType, GetCountriesLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetCountriesLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
type: GetCountriesLibraryQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [operations.GetCountriesLibraryQueryParamType](../../../sdk/models/operations/getcountrieslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
@@ -7,23 +7,23 @@ import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetCountriesLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
statusCode: 404,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Country",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -10,16 +10,16 @@ import { GetCountriesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/op
|
||||
let value: GetCountriesLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Country",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetFileHashResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 305,
|
||||
statusCode: 308,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,16 +7,16 @@ import { GetGenresLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetGenresLibraryMediaContainer = {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Shows (Reality)",
|
||||
title2: "By Genre",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
@@ -33,18 +33,16 @@ let value: GetGenresLibraryMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
||||
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `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 |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
30
docs/sdk/models/operations/getgenreslibraryqueryparamtype.md
Normal file
30
docs/sdk/models/operations/getgenreslibraryqueryparamtype.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# GetGenresLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetGenresLibraryQueryParamType =
|
||||
GetGenresLibraryQueryParamType.TvShow;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
@@ -3,15 +3,17 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetGenresLibraryQueryParamType, GetGenresLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetGenresLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
type: GetGenresLibraryQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| `type` | [operations.GetGenresLibraryQueryParamType](../../../sdk/models/operations/getgenreslibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
@@ -7,23 +7,23 @@ import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetGenresLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 506,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Shows (Reality)",
|
||||
title2: "By Genre",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -10,16 +10,16 @@ import { GetGenresLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/opera
|
||||
let value: GetGenresLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Shows (Reality)",
|
||||
title2: "By Genre",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
||||
|
||||
let value: GetLibraryDetailsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 103,
|
||||
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: 6063.93,
|
||||
sectionId: 2900.77,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetLibraryHubsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 412,
|
||||
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
Reference in New Issue
Block a user