n8n/packages/nodes-base/nodes/Google/YouTube/PlaylistDescription.ts

520 lines
12 KiB
TypeScript
Raw Normal View History

import { INodeProperties } from 'n8n-workflow';
2020-08-09 14:39:28 -07:00
export const playlistOperations: INodeProperties[] = [
2020-08-09 14:39:28 -07:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
2020-08-09 14:39:28 -07:00
displayOptions: {
show: {
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a playlist',
action: 'Create a playlist',
2020-08-09 14:39:28 -07:00
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a playlist',
action: 'Delete a playlist',
2020-08-09 14:39:28 -07:00
},
2020-08-11 13:07:23 -07:00
{
name: 'Get',
value: 'get',
description: 'Get a playlist',
action: 'Get a playlist',
2020-08-11 13:07:23 -07:00
},
2020-08-09 14:39:28 -07:00
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all playlists',
action: 'Get all playlists',
2020-08-09 14:39:28 -07:00
},
{
name: 'Update',
value: 'update',
description: 'Update a playlist',
action: 'Update a playlist',
2020-08-09 14:39:28 -07:00
},
],
default: 'getAll',
2020-10-22 06:46:03 -07:00
},
];
2020-08-09 14:39:28 -07:00
export const playlistFields: INodeProperties[] = [
2020-08-09 14:39:28 -07:00
/* -------------------------------------------------------------------------- */
/* playlist:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
displayOptions: {
show: {
operation: ['create'],
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
default: '',
description: "The playlist's title",
2020-08-09 14:39:28 -07:00
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: ['create'],
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
options: [
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: "The playlist's description",
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: 'unlisted',
2020-08-09 14:39:28 -07:00
},
],
default: '',
description: "The playlist's privacy status",
2020-08-09 14:39:28 -07:00
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
description:
'Keyword tags associated with the playlist. Mulplie can be defined separated by comma.',
2020-08-09 14:39:28 -07:00
},
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
displayName: 'Default Language Name or ID',
2020-08-09 14:39:28 -07:00
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. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
2020-08-09 14:39:28 -07:00
},
{
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. 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.',
2020-08-09 14:39:28 -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 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
},
],
},
/* -------------------------------------------------------------------------- */
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'],
2020-08-11 13:07:23 -07:00
},
},
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'],
2020-08-11 13:07:23 -07:00
},
},
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'],
2020-08-11 13:07:23 -07:00
},
},
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",
2020-08-11 13:07:23 -07:00
},
{
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-11 13:07:23 -07:00
},
],
},
/* -------------------------------------------------------------------------- */
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'],
2020-08-09 14:39:28 -07:00
},
},
default: '',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: ['delete'],
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
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",
2020-08-09 14:39:28 -07:00
},
],
},
/* -------------------------------------------------------------------------- */
/* 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'],
2020-08-09 14:39:28 -07:00
},
},
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'],
2020-08-09 14:39:28 -07:00
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
2020-08-09 14:39:28 -07:00
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: ['getAll'],
resource: ['playlist'],
returnAll: [false],
2020-08-09 14:39:28 -07:00
},
},
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,
description: 'Max number of results to return',
2020-08-09 14:39:28 -07:00
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: ['getAll'],
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
options: [
{
displayName: 'Channel ID',
name: 'channelId',
type: 'string',
default: '',
description:
"This value indicates that the API should only return the specified channel's playlists",
2020-08-09 14:39:28 -07:00
},
{
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.",
2020-08-09 14:39:28 -07:00
},
],
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
operation: ['getAll'],
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
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. 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.',
2020-08-09 14:39:28 -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 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
},
],
},
/* -------------------------------------------------------------------------- */
/* playlist:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Playlist ID',
name: 'playlistId',
type: 'string',
required: true,
displayOptions: {
show: {
operation: ['update'],
resource: ['playlist'],
2020-08-09 14:39:28 -07:00
},
},
default: '',
description: "The playlist's title",
2020-08-09 14:39:28 -07:00
},
2020-08-11 13:07:23 -07:00
{
displayName: 'Title',
name: 'title',
type: 'string',
required: true,
displayOptions: {
show: {
operation: ['update'],
resource: ['playlist'],
2020-08-11 13:07:23 -07:00
},
},
default: '',
description: "The playlist's title",
2020-08-11 13:07:23 -07:00
},
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'],
2020-08-09 14:39:28 -07:00
},
},
options: [
2020-08-11 13:07:23 -07:00
{
refactor: Apply more `eslint-plugin-n8n-nodes-base` autofixable rules (#3432) * :zap: Update `lintfix` script * :shirt: Remove unneeded lint exceptions * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-description-miscased-url` (#3441) * :shirt: Apply `rule node-param-placeholder-miscased-id` (#3443) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-wrong-for-upsert` (#3446) * :shirt: Apply `node-param-min-value-wrong-for-limit` (#3442) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-wrong-for-dynamic-options` (#3454) * :hammer: fix * :zap: Fix `Assigned To` fields Co-authored-by: Michael Kret <michael.k@radency.com> * :shirt: Apply `rule node-param-default-wrong-for-number` (#3453) * :shirt: Apply `node-param-default-wrong-for-string` (#3452) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * Apply `node-param-display-name-miscased` (#3449) * :hammer: fix * :hammer: exceptions * :zap: review fixes * :shirt: Apply `node-param-description-lowercase-first-char` (#3451) * :zap: fix * :zap: review fixes * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-dynamic-options` (#3456) * Rule working as intended * Add rule * :fire: Remove repetitions * :shirt: Add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Small fix for `node-param-description-wrong-for-dynamic-options` * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3460) * :shirt: Apply `node-param-description-line-break-html-tag` (#3462) * :shirt: Run baseline `lintfix` * :shirt: Apply `node-param-options-type-unsorted-items` (#3459) * :zap: fix * :hammer: exceptions * Add exception for Salesmate and Zoom Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Restore `lintfix` command Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
2022-06-03 10:23:49 -07:00
displayName: 'Default Language Name or ID',
2020-08-11 13:07:23 -07:00
name: 'defaultLanguage',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getLanguages',
},
default: '',
description:
'The language of the text in the playlist resource\'s title and description properties. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
2020-08-11 13:07:23 -07:00
},
2020-08-09 14:39:28 -07:00
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: "The playlist's description",
2020-08-09 14:39:28 -07:00
},
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 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
},
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: 'unlisted',
2020-08-09 14:39:28 -07:00
},
],
default: '',
description: "The playlist's privacy status",
2020-08-09 14:39:28 -07:00
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
description:
'Keyword tags associated with the playlist. Mulplie can be defined separated by comma.',
2020-08-09 14:39:28 -07:00
},
],
},
];