plexjs/docs/models/operations/createsubscriptionrequest.md

CreateSubscriptionRequest

Example Usage

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	➖	Indicates the client accepts the indicated media types
clientIdentifier	string	➖	An opaque identifier unique to the client	abc123
product	string	➖	The name of the client product	Plex for Roku
version	string	➖	The version of the client application	2.4.1
platform	string	➖	The platform of the client	Roku
platformVersion	string	➖	The version of the platform	4.3 build 1057
device	string	➖	A relatively friendly name for the client device	Roku 3
model	string	➖	A potentially less friendly identifier for the device model	4200X
deviceVendor	string	➖	The device vendor	Roku
deviceName	string	➖	A friendly name for the client	Living Room TV
marketplace	string	➖	The marketplace on which the client application is distributed	googlePlay
targetLibrarySectionID	number	➖	The library section into which we'll grab the media. Not actually required when the subscription is to a playlist.	1
targetSectionLocationID	number	➖	The section location into which to grab.	3
type	number	➖	The type of the thing we're subscribing too (e.g. show, season).	2
hints	operations.Hints	➖	Hints describing what we're looking for. Note: The hint ratingKey is required for downloading from a PMS remote.	{ "title": "Family Guy" }
prefs	operations.CreateSubscriptionPrefs	➖	Subscription preferences.	{ "minVideoQuality": 720 }
params	operations.Params	➖	Subscription parameters. - mediaProviderID: Required for downloads to indicate which MP the subscription will download into - source: Required for downloads to indicate the source of the downloaded content.	{ "mediaProviderID": 1 }