plexjs/docs/models/operations/createcollectionrequest.md

CreateCollectionRequest

Example Usage

import { CreateCollectionRequest } from "@lukehagar/plexjs/models/operations";
import { MediaType } from "@lukehagar/plexjs/models/shared";

let value: CreateCollectionRequest = {
  sectionId: "<id>",
  type: MediaType.TvShow,
};

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
sectionId	string	✔️	The section where this collection will be created
title	string	➖	The title to filter by or assign
smart	boolean	➖	Whether this is a smart collection/playlist
uri	string	➖	The URI for processing the smart collection. Required for a smart collection
type	shared.MediaType	➖	The type of media to retrieve or filter by. 1 = movie 2 = show 3 = season 4 = episode 5 = artist 6 = album 7 = track 8 = photo_album 9 = photo E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2