n8n/packages/nodes-base/nodes/Google/YouTube/PlaylistItemDescription.ts
Iván Ovejero 0764c49dcf
🔥 Remove line breaks from param descriptions (#2473)
* 🔥 Remove line breaks from param descriptions

* 🔥 Remove more line breaks

* 🎨 Fix spacing for list item in tooltip

*  Apply multiline with <p> tags

*  Improve <code> and <a> tags

* ✏️ Improve grammar and spelling

*  Add missing <p> tags

* ✏️ Make "multiple" phrasing consistent

*  Fix unneeded quote escapes

*  Encode angle brackets

*  Fix typo and copy-paste artifact
2021-11-25 18:10:06 +01:00

405 lines
8.3 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const playlistItemOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'playlistItem',
],
},
},
options: [
{
name: 'Add',
value: 'add',
description: 'Add an item to a playlist',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a item from a playlist',
},
{
name: 'Get',
value: 'get',
description: `Get a playlist's item`,
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all playlist items',
},
],
default: 'add',
description: 'The operation to perform.',
},
] as INodeProperties[];
export const playlistItemFields = [
/* -------------------------------------------------------------------------- */
/* playlistItem:add */
/* -------------------------------------------------------------------------- */
{
displayName: 'Playlist ID',
name: 'playlistId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getPlaylists',
},
required: true,
displayOptions: {
show: {
operation: [
'add',
],
resource: [
'playlistItem',
],
},
},
default: '',
},
{
displayName: 'Video ID',
name: 'videoId',
type: 'string',
required: true,
displayOptions: {
show: {
operation: [
'add',
],
resource: [
'playlistItem',
],
},
},
default: '',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: [
'add',
],
resource: [
'playlistItem',
],
},
},
options: [
{
displayName: 'End At',
name: 'endAt',
type: 'dateTime',
default: '',
description: `The time, measured in seconds from the start of the video, when the video should stop playing.`,
},
{
displayName: 'Note',
name: 'note',
type: 'string',
default: '',
description: `A user-generated note for this item. The property value has a maximum length of 280 characters.`,
},
{
displayName: 'On Behalf Of Content Owner',
name: 'onBehalfOfContentOwner',
type: 'string',
default: '',
description: `The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value`,
},
{
displayName: 'Position',
name: 'position',
type: 'number',
typeOptions: {
minValue: 0,
},
default: '',
description: `The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.`,
},
{
displayName: 'Start At',
name: 'startAt',
type: 'dateTime',
default: '',
description: `The time, measured in seconds from the start of the video, when the video should start playing.`,
},
],
},
/* -------------------------------------------------------------------------- */
/* playlistItem:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Playlist Item ID',
name: 'playlistItemId',
type: 'string',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'playlistItem',
],
},
},
default: '',
},
{
displayName: 'Fields',
name: 'part',
type: 'multiOptions',
options: [
{
name: '*',
value: '*',
},
{
name: 'Content Details',
value: 'contentDetails',
},
{
name: 'ID',
value: 'id',
},
{
name: 'Snippet',
value: 'snippet',
},
{
name: 'Status',
value: 'status',
},
],
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'playlistItem',
],
},
},
description: 'The fields parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include.',
default: ['*'],
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'playlistItem',
],
},
},
options: [
{
displayName: 'On Behalf Of Content Owner',
name: 'onBehalfOfContentOwner',
type: 'string',
default: '',
description: `The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value`,
},
],
},
/* -------------------------------------------------------------------------- */
/* playlistItem:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Playlist Item ID',
name: 'playlistItemId',
type: 'string',
required: true,
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'playlistItem',
],
},
},
default: '',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'playlistItem',
],
},
},
options: [
{
displayName: 'On Behalf Of Content Owner',
name: 'onBehalfOfContentOwner',
type: 'string',
default: '',
description: `The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value`,
},
],
},
/* -------------------------------------------------------------------------- */
/* playlistItem:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Playlist ID',
name: 'playlistId',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getPlaylists',
},
required: true,
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'playlistItem',
],
},
},
default: '',
},
{
displayName: 'Fields',
name: 'part',
type: 'multiOptions',
options: [
{
name: '*',
value: '*',
},
{
name: 'Content Details',
value: 'contentDetails',
},
{
name: 'ID',
value: 'id',
},
{
name: 'Snippet',
value: 'snippet',
},
{
name: 'Status',
value: 'status',
},
],
required: true,
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'playlistItem',
],
},
},
description: 'The fields parameter specifies a comma-separated list of one or more playlistItem resource properties that the API response will include.',
default: ['*'],
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'playlistItem',
],
},
},
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: [
'playlistItem',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 50,
},
default: 25,
description: 'How many results to return.',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'playlistItem',
],
},
},
options: [
{
displayName: 'On Behalf Of Content Owner',
name: 'onBehalfOfContentOwner',
type: 'string',
default: '',
description: `The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value`,
},
],
},
] as INodeProperties[];