mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
38 lines
21 KiB
Markdown
38 lines
21 KiB
Markdown
# CreateSubscriptionRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { CreateSubscriptionRequest } from "@lukehagar/plexjs/models/operations";
|
|
|
|
let value: CreateSubscriptionRequest = {
|
|
targetLibrarySectionID: 1,
|
|
targetSectionLocationID: 3,
|
|
type: 2,
|
|
hints: {},
|
|
prefs: {},
|
|
params: {},
|
|
};
|
|
```
|
|
|
|
## 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 |
|
|
| `targetLibrarySectionID` | *number* | :heavy_minus_sign: | The library section into which we'll grab the media. Not actually required when the subscription is to a playlist. | 1 |
|
|
| `targetSectionLocationID` | *number* | :heavy_minus_sign: | The section location into which to grab. | 3 |
|
|
| `type` | *number* | :heavy_minus_sign: | The type of the thing we're subscribing too (e.g. show, season). | 2 |
|
|
| `hints` | [operations.Hints](../../models/operations/hints.md) | :heavy_minus_sign: | Hints describing what we're looking for. Note: The hint `ratingKey` is required for downloading from a PMS remote. | {<br/>"title": "Family Guy"<br/>} |
|
|
| `prefs` | [operations.CreateSubscriptionPrefs](../../models/operations/createsubscriptionprefs.md) | :heavy_minus_sign: | Subscription preferences. | {<br/>"minVideoQuality": 720<br/>} |
|
|
| `params` | [operations.Params](../../models/operations/params.md) | :heavy_minus_sign: | Subscription parameters.<br/> - `mediaProviderID`: Required for downloads to indicate which MP the subscription will download into<br/> - `source`: Required for downloads to indicate the source of the downloaded content.<br/> | {<br/>"mediaProviderID": 1<br/>} | |