mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
46 lines
34 KiB
Markdown
46 lines
34 KiB
Markdown
# ModifyPlaylistGeneratorRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { ModifyPlaylistGeneratorRequest, ModifyPlaylistGeneratorScope } from "@lukehagar/plexjs/models/operations";
|
|
|
|
let value: ModifyPlaylistGeneratorRequest = {
|
|
playlistId: 314072,
|
|
generatorId: 848744,
|
|
item: {
|
|
location: {
|
|
uri:
|
|
"library://82503060-0d68-4603-b594-8b071d54819e/item/%2Flibrary%2Fmetadata%2F146",
|
|
},
|
|
locationID: -1,
|
|
policy: {
|
|
value: NaN,
|
|
scope: ModifyPlaylistGeneratorScope.All,
|
|
},
|
|
target: "",
|
|
targetTagID: 1,
|
|
title: "Jack-Jack Attack",
|
|
type: 42,
|
|
},
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `accepts` | [shared.Accepts](../../models/shared/accepts.md) | :heavy_minus_sign: | Indicates the client accepts the indicated media types | |
|
|
| `clientIdentifier` | *string* | :heavy_minus_sign: | An opaque identifier unique to the client | abc123 |
|
|
| `product` | *string* | :heavy_minus_sign: | The name of the client product | Plex for Roku |
|
|
| `version` | *string* | :heavy_minus_sign: | The version of the client application | 2.4.1 |
|
|
| `platform` | *string* | :heavy_minus_sign: | The platform of the client | Roku |
|
|
| `platformVersion` | *string* | :heavy_minus_sign: | The version of the platform | 4.3 build 1057 |
|
|
| `device` | *string* | :heavy_minus_sign: | A relatively friendly name for the client device | Roku 3 |
|
|
| `model` | *string* | :heavy_minus_sign: | A potentially less friendly identifier for the device model | 4200X |
|
|
| `deviceVendor` | *string* | :heavy_minus_sign: | The device vendor | Roku |
|
|
| `deviceName` | *string* | :heavy_minus_sign: | A friendly name for the client | Living Room TV |
|
|
| `marketplace` | *string* | :heavy_minus_sign: | The marketplace on which the client application is distributed | googlePlay |
|
|
| `playlistId` | *number* | :heavy_check_mark: | The ID of the playlist | |
|
|
| `generatorId` | *number* | :heavy_check_mark: | The generator item ID to modify. | |
|
|
| `item` | [operations.ModifyPlaylistGeneratorItem](../../models/operations/modifyplaylistgeneratoritem.md) | :heavy_minus_sign: | Note: OpenAPI cannot properly render this query parameter example ([See GHI](https://github.com/OAI/OpenAPI-Specification/issues/1706)). It should be rendered as:<br/><br/>Item[type]=42&Item[title]=Jack-Jack Attack&Item[target]=&Item[targetTagID]=1&Item[locationID]=-1&Item[Location][uri]=library://82503060-0d68-4603-b594-8b071d54819e/item//library/metadata/146&Item[Policy][scope]=all&Item[Policy][value]=&Item[Policy][unwatched]=0<br/> | {<br/>"Location": {<br/>"uri": "library://82503060-0d68-4603-b594-8b071d54819e/item/%2Flibrary%2Fmetadata%2F146"<br/>},<br/>"locationID": -1,<br/>"Policy": {<br/>"value": "",<br/>"scope": "all",<br/>"unwatched": 0<br/>},<br/>"target": "",<br/>"targetTagID": 1,<br/>"title": "Jack-Jack Attack",<br/>"type": 42<br/>} | |