n8n/packages/nodes-base/nodes/Flow/TaskDescription.ts

672 lines
14 KiB
TypeScript
Raw Normal View History

2021-01-13 11:20:30 -08:00
import { INodeProperties } from 'n8n-workflow';
2019-12-06 09:04:50 -08:00
export const taskOpeations: INodeProperties[] = [
2019-12-06 09:04:50 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'task',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a new task',
},
{
name: 'Update',
value: 'update',
description: 'Update a task',
2019-12-06 09:04:50 -08:00
},
{
name: 'Get',
value: 'get',
description: 'Get a task',
2019-12-06 09:04:50 -08:00
},
{
name: 'Get All',
value: 'getAll',
description: 'Get all the tasks',
},
],
default: 'create',
description: 'The operation to perform.',
},
];
2019-12-06 09:04:50 -08:00
export const taskFields: INodeProperties[] = [
2019-12-06 09:04:50 -08:00
/* -------------------------------------------------------------------------- */
/* task:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Workspace ID',
name: 'workspaceId',
type: 'string',
default: '',
2019-12-06 09:04:50 -08:00
required: true,
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'create',
],
2019-12-06 09:04:50 -08:00
},
},
description: 'Create resources under the given workspace.',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
2019-12-06 09:04:50 -08:00
required: true,
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'create',
],
2019-12-06 09:04:50 -08:00
},
},
description: 'The title of the task.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Owner ID',
name: 'ownerid',
type: 'string',
required: false,
default: '',
description: 'The ID of the account to whom this task will be assigned.',
},
{
displayName: 'List ID',
name: 'listID',
type: 'string',
2020-01-04 20:19:10 -08:00
default: '',
2019-12-06 09:04:50 -08:00
required : false,
description: 'Put the new task in a list ("project"). Omit this param to have the task be private.',
},
{
displayName: 'Starts On',
name: 'startsOn',
type: 'dateTime',
default: '',
required : false,
description: 'The date on which the task should start.',
},
{
displayName: 'Due On',
name: 'dueOn',
type: 'dateTime',
default: '',
required : false,
description: 'The date on which the task should be due.',
},
{
displayName: 'Mirror Parent Subscribers',
name: 'mirrorParentSubscribers',
type: 'boolean',
default: false,
required : false,
description: `If this task will be a subtask, and this is true, the parent tasks's subscribers will be mirrored to this one.`,
},
{
displayName: 'Mirror Parent Tags',
name: 'mirrorParentTags',
type: 'boolean',
default: false,
required : false,
description: `If this task will be a subtask, and this is true, the parent tasks's tags will be mirrored to this one.`,
},
{
displayName: 'Note Content',
name: 'noteContent',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
required : false,
description: `Provide the content for the task's note.`,
},
{
displayName: 'Note Mime Type',
name: 'noteMimeType',
type: 'options',
default: 'text/plain',
2019-12-06 09:04:50 -08:00
options: [
{
name: 'text/plain',
value: 'text/plain',
},
{
name: 'text/x-markdown',
value: 'text/x-markdown',
},
{
name: 'text/html',
value: 'text/html',
2020-10-22 06:46:03 -07:00
},
2019-12-06 09:04:50 -08:00
],
description: `Identify which markup language is used to format the given note`,
},
{
displayName: 'Parent ID',
name: 'parentId',
type: 'string',
default: '',
required : false,
description: `If provided, this task will become a subtask of the given task.`,
},
{
displayName: 'Position List',
name: 'positionList',
type: 'number',
default: 0,
required : false,
description: `Determines the sort order when showing tasks in, or grouped by, a list.`,
},
{
displayName: 'Position Upcoming',
name: 'positionUpcoming',
type: 'number',
default: 0,
required : false,
description: `Determines the sort order when showing tasks grouped by their due_date.`,
},
{
displayName: 'Position',
name: 'position',
type: 'number',
default: 0,
required : false,
description: `Determines the sort order of tasks.`,
},
{
displayName: 'Section ID',
name: 'sectionId',
type: 'string',
default: '',
required : false,
description: `Specify which section under which to create this task.`,
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
required : false,
:zap: Remove unnessasry <br/> (#2340) * introduce analytics * add user survey backend * add user survey backend * set answers on survey submit Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * change name to personalization * lint Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * N8n 2495 add personalization modal (#2280) * update modals * add onboarding modal * implement questions * introduce analytics * simplify impl * implement survey handling * add personalized cateogry * update modal behavior * add thank you view * handle empty cases * rename modal * standarize modal names * update image, add tags to headings * remove unused file * remove unused interfaces * clean up footer spacing * introduce analytics * refactor to fix bug * update endpoint * set min height * update stories * update naming from questions to survey * remove spacing after core categories * fix bug in logic * sort nodes * rename types * merge with be * rename userSurvey * clean up rest api * use constants for keys * use survey keys * clean up types * move personalization to its own file Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> * update parameter inputs to be multiline * update spacing * Survey new options (#2300) * split up options * fix quotes * remove unused import * refactor node credentials * add user created workflow event (#2301) * update multi params * simplify env vars * fix versionCli on FE * update personalization env * clean up node detail settings * fix event User opened Credentials panel * fix font sizes across modals * clean up input spacing * fix select modal spacing * increase spacing * fix input copy * fix webhook, tab spacing, retry button * fix button sizes * fix button size * add mini xlarge sizes * fix webhook spacing * fix nodes panel event * fix workflow id in workflow execute event * improve telemetry error logging * fix config and stop process events * add flush call on n8n stop * ready for release * fix input error highlighting * revert change * update toggle spacing * fix delete positioning * keep tooltip while focused * set strict size * increase left spacing * fix sort icons * remove unnessasry <br/> * remove unnessary break * remove unnessary margin * clean unused functionality * remove unnessary css * remove duplicate tracking * only show tooltip when hovering over label * remove extra space * add br * remove extra space * clean up commas * clean up commas * remove extra space * remove extra space * rewrite desc * add commas * add space * remove extra space * add space * add dot * update credentials section * use includes Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-10-27 13:00:13 -07:00
description: `A list of tag names to apply to the new task separated by a comma (,)`,
2019-12-06 09:04:50 -08:00
},
],
},
/* -------------------------------------------------------------------------- */
/* task:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Workspace ID',
name: 'workspaceId',
type: 'string',
default: '',
2019-12-06 09:04:50 -08:00
required: true,
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'update',
],
2019-12-06 09:04:50 -08:00
},
},
description: 'Create resources under the given workspace.',
},
{
displayName: 'Task ID',
name: 'taskId',
type: 'string',
default: '',
2019-12-06 09:04:50 -08:00
required: true,
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'update',
],
2019-12-06 09:04:50 -08:00
},
},
description: '',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Update Field',
default: {},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'The title of the task.',
},
{
displayName: 'Completed',
name: 'completed',
type: 'boolean',
default: false,
description: `If set to true, will complete the task.`,
},
{
displayName: 'Owner ID',
name: 'ownerid',
type: 'string',
default: '',
description: 'The ID of the account to whom this task will be assigned.',
},
{
displayName: 'List ID',
name: 'listID',
type: 'string',
default: '',
description: 'Put the new task in a list ("project"). Omit this param to have the task be private.',
},
{
displayName: 'Starts On',
name: 'startsOn',
type: 'dateTime',
default: '',
description: 'The date on which the task should start.',
},
{
displayName: 'Due On',
name: 'dueOn',
type: 'dateTime',
default: '',
description: 'The date on which the task should be due.',
},
{
displayName: 'Mirror Parent Subscribers',
name: 'mirrorParentSubscribers',
type: 'boolean',
default: false,
required : false,
description: `If this task will be a subtask, and this is true, the parent tasks's subscribers will be mirrored to this one.`,
},
{
displayName: 'Mirror Parent Tags',
name: 'mirrorParentTags',
type: 'boolean',
default: false,
description: `If this task will be a subtask, and this is true, the parent tasks's tags will be mirrored to this one.`,
},
{
displayName: 'Note Content',
name: 'noteContent',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
description: `Provide the content for the task's note.`,
},
{
displayName: 'Note Mime Type',
name: 'noteMimeType',
type: 'options',
default: 'text/plain',
2019-12-06 09:04:50 -08:00
options: [
{
name: 'text/plain',
value: 'text/plain',
},
{
name: 'text/x-markdown',
value: 'text/x-markdown',
},
{
name: 'text/html',
value: 'text/html',
2020-10-22 06:46:03 -07:00
},
2019-12-06 09:04:50 -08:00
],
description: `Identify which markup language is used to format the given note`,
},
{
displayName: 'Parent ID',
name: 'parentId',
type: 'string',
default: '',
description: `If provided, this task will become a subtask of the given task.`,
},
{
displayName: 'Position List',
name: 'positionList',
type: 'number',
default: 0,
description: `Determines the sort order when showing tasks in, or grouped by, a list.`,
},
{
displayName: 'Position Upcoming',
name: 'positionUpcoming',
type: 'number',
default: 0,
description: `Determines the sort order when showing tasks grouped by their due_date.`,
},
{
displayName: 'Position',
name: 'position',
type: 'number',
default: 0,
description: `Determines the sort order of tasks.`,
},
{
displayName: 'Section ID',
name: 'sectionId',
type: 'string',
default: '',
description: `Specify which section under which to create this task.`,
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
:zap: Remove unnessasry <br/> (#2340) * introduce analytics * add user survey backend * add user survey backend * set answers on survey submit Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * change name to personalization * lint Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * N8n 2495 add personalization modal (#2280) * update modals * add onboarding modal * implement questions * introduce analytics * simplify impl * implement survey handling * add personalized cateogry * update modal behavior * add thank you view * handle empty cases * rename modal * standarize modal names * update image, add tags to headings * remove unused file * remove unused interfaces * clean up footer spacing * introduce analytics * refactor to fix bug * update endpoint * set min height * update stories * update naming from questions to survey * remove spacing after core categories * fix bug in logic * sort nodes * rename types * merge with be * rename userSurvey * clean up rest api * use constants for keys * use survey keys * clean up types * move personalization to its own file Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> * update parameter inputs to be multiline * update spacing * Survey new options (#2300) * split up options * fix quotes * remove unused import * refactor node credentials * add user created workflow event (#2301) * update multi params * simplify env vars * fix versionCli on FE * update personalization env * clean up node detail settings * fix event User opened Credentials panel * fix font sizes across modals * clean up input spacing * fix select modal spacing * increase spacing * fix input copy * fix webhook, tab spacing, retry button * fix button sizes * fix button size * add mini xlarge sizes * fix webhook spacing * fix nodes panel event * fix workflow id in workflow execute event * improve telemetry error logging * fix config and stop process events * add flush call on n8n stop * ready for release * fix input error highlighting * revert change * update toggle spacing * fix delete positioning * keep tooltip while focused * set strict size * increase left spacing * fix sort icons * remove unnessasry <br/> * remove unnessary break * remove unnessary margin * clean unused functionality * remove unnessary css * remove duplicate tracking * only show tooltip when hovering over label * remove extra space * add br * remove extra space * clean up commas * clean up commas * remove extra space * remove extra space * rewrite desc * add commas * add space * remove extra space * add space * add dot * update credentials section * use includes Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-10-27 13:00:13 -07:00
description: `A list of tag names to apply to the new task separated by a comma (,)`,
2019-12-06 09:04:50 -08:00
},
],
},
/* -------------------------------------------------------------------------- */
/* task:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Task ID',
name: 'taskId',
type: 'string',
default: '',
2019-12-06 09:04:50 -08:00
required: true,
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'get',
],
2019-12-06 09:04:50 -08:00
},
},
description: '',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'get',
],
},
},
options: [
{
displayName: 'Include',
name: 'include',
type: 'multiOptions',
default: [],
options: [
{
name: 'schedule',
value: 'schedule',
},
{
name: 'files',
value: 'files',
},
{
name: 'file Associations',
value: 'file_associations',
},
{
name: 'Parent',
value: 'parent',
},
2020-10-22 06:46:03 -07:00
],
2019-12-06 09:04:50 -08:00
},
],
},
/* -------------------------------------------------------------------------- */
/* task:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'getAll',
],
2019-12-06 09:04:50 -08:00
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'task',
],
operation: [
2020-10-22 06:46:03 -07:00
'getAll',
2019-12-06 09:04:50 -08:00
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
maxValue: 100,
},
default: 50,
description: 'How many results to return.',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: [
'task',
],
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Include',
name: 'include',
type: 'multiOptions',
default: [],
options: [
{
name: 'schedule',
value: 'schedule',
},
{
name: 'files',
value: 'files',
},
{
name: 'file Associations',
value: 'file_associations',
},
{
name: 'Parent',
value: 'parent',
},
2020-10-22 06:46:03 -07:00
],
2019-12-06 09:04:50 -08:00
},
{
displayName: 'Order',
name: 'order',
type: 'options',
default: 'created_at',
2019-12-06 09:04:50 -08:00
options: [
{
name: 'Due On',
value: 'due_on',
},
{
name: 'Starts On',
value: 'starts_on',
},
{
name: 'Created At',
value: 'created_at',
},
{
name: 'Position',
value: 'position',
},
{
name: 'Account ID',
value: 'account_id',
},
{
name: 'List ID',
value: 'list_id',
},
{
name: 'Section ID',
value: 'section_id',
},
{
name: 'Owner ID',
value: 'owner_id',
},
{
name: 'Name',
value: 'name',
},
{
name: 'Completed At',
value: 'completed_at',
},
{
name: 'Updated At',
value: 'updated_at',
},
2020-10-22 06:46:03 -07:00
],
2019-12-06 09:04:50 -08:00
},
{
displayName: 'Workspace ID',
name: 'workspaceId',
type: 'string',
default: '',
description: 'Create resources under the given workspace.',
},
{
displayName: 'Created Before',
name: 'createdBefore',
type: 'dateTime',
default: '',
description: 'Select resources created before a certain time.',
},
{
displayName: 'Created After',
name: 'createdAfter',
type: 'dateTime',
default: '',
description: 'Select resources created after a certain time.',
},
{
displayName: 'Update Before',
name: 'updateBefore',
type: 'dateTime',
default: '',
description: 'Select resources updated before a certain time.',
},
{
displayName: 'Update After',
name: 'updateAfter',
type: 'dateTime',
default: '',
description: 'Select resources updated after a certain time.',
},
{
displayName: 'Deleted',
name: 'deleted',
type: 'boolean',
default: false,
description: 'Select deleted resources.',
},
{
displayName: 'Cleared',
name: 'cleared',
type: 'boolean',
default: false,
description: 'Select cleared resources.',
},
],
},
];