2020-08-09 14:39:28 -07:00
import {
INodeProperties ,
} from 'n8n-workflow' ;
export const playlistOperations = [
{
displayName : 'Operation' ,
name : 'operation' ,
type : 'options' ,
displayOptions : {
show : {
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
{
name : 'Create' ,
value : 'create' ,
description : 'Create a playlist' ,
} ,
{
name : 'Delete' ,
value : 'delete' ,
description : 'Delete a playlist' ,
} ,
2020-08-11 13:07:23 -07:00
{
name : 'Get' ,
value : 'get' ,
description : 'Get a playlist' ,
} ,
2020-08-09 14:39:28 -07:00
{
name : 'Get All' ,
value : 'getAll' ,
description : 'Retrieve all playlists' ,
} ,
{
name : 'Update' ,
value : 'update' ,
description : 'Update a playlist' ,
} ,
] ,
default : 'getAll' ,
description : 'The operation to perform.'
}
] as INodeProperties [ ] ;
export const playlistFields = [
/* -------------------------------------------------------------------------- */
/* playlist:create */
/* -------------------------------------------------------------------------- */
{
displayName : 'Title' ,
name : 'title' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
operation : [
'create' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
default : '' ,
description : ` The playlist's title. ` ,
} ,
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
placeholder : 'Add Option' ,
default : { } ,
displayOptions : {
show : {
operation : [
'create' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
{
displayName : 'Description' ,
name : 'description' ,
type : 'string' ,
default : '' ,
description : ` The playlist's description. ` ,
} ,
{
displayName : 'Privacy Status' ,
name : 'privacyStatus' ,
type : 'options' ,
options : [
{
name : 'Private' ,
value : 'private' ,
} ,
{
name : 'Public' ,
value : 'public' ,
} ,
{
name : 'Unlisted' ,
value : 'unlistef' ,
} ,
] ,
default : '' ,
description : ` The playlist's privacy status. ` ,
} ,
{
displayName : 'Tags' ,
name : 'tags' ,
type : 'string' ,
default : '' ,
description : ` Keyword tags associated with the playlist. Mulplie can be defined separated by comma ` ,
} ,
{
displayName : 'Default Language' ,
name : 'defaultLanguage' ,
2020-08-11 13:07:23 -07:00
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getLanguages' ,
} ,
2020-08-09 14:39:28 -07:00
default : '' ,
description : ` The language of the text in the playlist resource's title and description properties. ` ,
} ,
{
displayName : 'On Behalf Of Content Owner Channel' ,
name : 'onBehalfOfContentOwnerChannel' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added.<br>
This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter , and it can only be used in conjunction with that parameter . ` ,
} ,
{
displayName : 'On Behalf Of Content Owner' ,
name : 'onBehalfOfContentOwner' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify<br>
a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value ` ,
} ,
] ,
} ,
/* -------------------------------------------------------------------------- */
2020-08-11 13:07:23 -07:00
/* playlist:get */
/* -------------------------------------------------------------------------- */
{
displayName : 'Playlist ID' ,
name : 'playlistId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
operation : [
'get' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Fields' ,
name : 'part' ,
type : 'multiOptions' ,
options : [
2020-08-14 15:36:47 -07:00
{
name : '*' ,
value : '*' ,
} ,
2020-08-11 13:07:23 -07:00
{
name : 'Content Details' ,
value : 'contentDetails' ,
} ,
{
name : 'ID' ,
value : 'id' ,
} ,
{
name : 'Localizations' ,
value : 'localizations' ,
} ,
{
name : 'Player' ,
value : 'player' ,
} ,
{
name : 'Snippet' ,
value : 'snippet' ,
} ,
{
name : 'Status' ,
value : 'status' ,
} ,
] ,
required : true ,
displayOptions : {
show : {
operation : [
'get' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
description : 'The fields parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include.' ,
2020-08-15 19:36:11 -07:00
default : [ '*' ] ,
2020-08-11 13:07:23 -07:00
} ,
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
placeholder : 'Add Option' ,
default : { } ,
displayOptions : {
show : {
operation : [
'get' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
{
displayName : 'On Behalf Of Content Owner' ,
name : 'onBehalfOfContentOwner' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify<br>
a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value ` ,
} ,
{
displayName : 'On Behalf Of Content Owner Channel' ,
name : 'onBehalfOfContentOwnerChannel' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added ` ,
} ,
] ,
} ,
/* -------------------------------------------------------------------------- */
2020-08-09 14:39:28 -07:00
/* playlist:delete */
/* -------------------------------------------------------------------------- */
{
displayName : 'Playlist ID' ,
name : 'playlistId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
operation : [
'delete' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
placeholder : 'Add Option' ,
default : { } ,
displayOptions : {
show : {
operation : [
'delete' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
{
displayName : 'On Behalf Of Content Owner' ,
name : 'onBehalfOfContentOwner' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify<br>
a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value ` ,
} ,
] ,
} ,
/* -------------------------------------------------------------------------- */
/* playlist:getAll */
/* -------------------------------------------------------------------------- */
{
displayName : 'Fields' ,
name : 'part' ,
type : 'multiOptions' ,
options : [
2020-08-14 15:36:47 -07:00
{
name : '*' ,
value : '*' ,
} ,
2020-08-09 14:39:28 -07:00
{
name : 'Content Details' ,
value : 'contentDetails' ,
} ,
{
name : 'ID' ,
value : 'id' ,
} ,
{
name : 'Localizations' ,
value : 'localizations' ,
} ,
{
name : 'Player' ,
value : 'player' ,
} ,
{
name : 'Snippet' ,
value : 'snippet' ,
} ,
{
name : 'Status' ,
value : 'status' ,
} ,
] ,
required : true ,
displayOptions : {
show : {
operation : [
'getAll' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
description : 'The fields parameter specifies a comma-separated list of one or more playlist resource properties that the API response will include.' ,
2020-08-15 19:36:11 -07:00
default : [ '*' ] ,
2020-08-09 14:39:28 -07:00
} ,
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
displayOptions : {
show : {
operation : [
'getAll' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
default : false ,
description : 'If all results should be returned or only up to a given limit.' ,
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
displayOptions : {
show : {
operation : [
'getAll' ,
] ,
resource : [
'playlist' ,
] ,
returnAll : [
false ,
] ,
} ,
} ,
typeOptions : {
minValue : 1 ,
2020-08-14 15:36:47 -07:00
maxValue : 50 ,
2020-08-09 14:39:28 -07:00
} ,
2020-08-14 15:36:47 -07:00
default : 25 ,
2020-08-09 14:39:28 -07:00
description : 'How many results to return.' ,
} ,
{
displayName : 'Filters' ,
name : 'filters' ,
type : 'collection' ,
placeholder : 'Add Option' ,
default : { } ,
displayOptions : {
show : {
operation : [
'getAll' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
{
displayName : 'Channel ID' ,
name : 'channelId' ,
type : 'string' ,
default : '' ,
description : ` This value indicates that the API should only return the specified channel's playlists. ` ,
} ,
{
displayName : 'ID' ,
name : 'id' ,
type : 'string' ,
default : '' ,
description : ` The id parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a playlist resource, the id property specifies the playlist's YouTube playlist ID. ` ,
} ,
] ,
} ,
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
placeholder : 'Add Option' ,
default : { } ,
displayOptions : {
show : {
operation : [
'getAll' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
{
displayName : 'On Behalf Of Content Owner Channel' ,
name : 'onBehalfOfContentOwnerChannel' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added.<br>
This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter , and it can only be used in conjunction with that parameter . ` ,
} ,
{
displayName : 'On Behalf Of Content Owner' ,
name : 'onBehalfOfContentOwner' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify<br>
a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value ` ,
} ,
] ,
} ,
/* -------------------------------------------------------------------------- */
/* playlist:update */
/* -------------------------------------------------------------------------- */
{
displayName : 'Playlist ID' ,
name : 'playlistId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
operation : [
'update' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
default : '' ,
description : ` The playlist's title. ` ,
} ,
2020-08-11 13:07:23 -07:00
{
displayName : 'Title' ,
name : 'title' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
operation : [
'update' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
default : '' ,
description : ` The playlist's title. ` ,
} ,
2020-08-09 14:39:28 -07:00
{
displayName : 'Update Fields' ,
name : 'updateFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
operation : [
'update' ,
] ,
resource : [
'playlist' ,
] ,
} ,
} ,
options : [
2020-08-11 13:07:23 -07:00
{
displayName : 'Default Language' ,
name : 'defaultLanguage' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getLanguages' ,
} ,
default : '' ,
description : ` The language of the text in the playlist resource's title and description properties. ` ,
} ,
2020-08-09 14:39:28 -07:00
{
displayName : 'Description' ,
name : 'description' ,
type : 'string' ,
default : '' ,
description : ` The playlist's description. ` ,
} ,
2020-08-11 13:07:23 -07:00
{
displayName : 'On Behalf Of Content Owner' ,
name : 'onBehalfOfContentOwner' ,
type : 'string' ,
default : '' ,
description : ` The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify<br>
a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value ` ,
} ,
2020-08-09 14:39:28 -07:00
{
displayName : 'Privacy Status' ,
name : 'privacyStatus' ,
type : 'options' ,
options : [
{
name : 'Private' ,
value : 'private' ,
} ,
{
name : 'Public' ,
value : 'public' ,
} ,
{
name : 'Unlisted' ,
value : 'unlistef' ,
} ,
] ,
default : '' ,
description : ` The playlist's privacy status. ` ,
} ,
{
displayName : 'Tags' ,
name : 'tags' ,
type : 'string' ,
default : '' ,
description : ` Keyword tags associated with the playlist. Mulplie can be defined separated by comma ` ,
} ,
] ,
} ,
] as INodeProperties [ ] ;