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

316 lines
6.7 KiB
TypeScript
Raw Normal View History

import {
INodeProperties
} from 'n8n-workflow';
const resource = [
'task',
];
export const taskOperations: INodeProperties[] = [
2020-01-28 07:50:15 -08:00
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource,
2020-01-28 07:50:15 -08:00
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a task',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a task',
},
2020-01-28 07:50:15 -08:00
{
name: 'Get',
value: 'get',
description: 'Get data of a task',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all tasks',
},
2020-01-31 06:06:10 -08:00
{
name: 'Update',
value: 'update',
description: 'Update a task',
2020-01-31 06:06:10 -08:00
},
2020-01-28 07:50:15 -08:00
],
default: 'getAll',
2020-01-28 07:50:15 -08:00
description: 'The operation to perform.',
},
];
2020-01-28 07:50:15 -08:00
export const taskFields: INodeProperties[] = [
2020-01-28 07:50:15 -08:00
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
/* task:getAll */
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
},
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
default: false,
description: 'Whether to return all results or only up to a given limit',
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
returnAll: [
false,
],
},
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
typeOptions: {
minValue: 1,
maxValue: 100,
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
default: 100,
description: 'Max number of results to return',
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
},
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
options: [
{
displayName: 'Is Active',
name: 'is_active',
type: 'boolean',
default: true,
description: 'Pass true to only return active tasks and false to return inactive tasks',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Page',
name: 'page',
type: 'number',
typeOptions: {
minValue: 1,
},
default: 1,
description: 'The page number to use in pagination',
},
{
displayName: 'Updated Since',
name: 'updated_since',
type: 'dateTime',
default: '',
description: 'Only return tasks belonging to the task with the given ID',
},
2020-10-22 06:46:03 -07:00
],
2020-01-31 06:06:10 -08:00
},
/* -------------------------------------------------------------------------- */
/* task:get */
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
{
displayName: 'Task Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource,
},
2020-01-28 07:50:15 -08:00
},
description: 'The ID of the task you are retrieving',
2020-01-31 06:06:10 -08:00
},
2020-01-28 07:50:15 -08:00
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
/* task:delete */
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
{
displayName: 'Task Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'delete',
],
resource,
},
2020-01-28 07:50:15 -08:00
},
description: 'The ID of the task you want to delete',
2020-01-28 07:50:15 -08:00
},
2020-01-31 04:47:20 -08:00
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
/* task:create */
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
{
displayName: 'Name',
name: 'name',
type: 'string',
displayOptions: {
show: {
operation: [
'create',
],
resource,
},
},
default: '',
required: true,
description: 'The name of the task',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'create',
],
resource,
},
},
default: {},
options: [
{
displayName: 'Billable By Default',
name: 'billable_by_default',
type: 'boolean',
default: true,
2020-10-22 06:46:03 -07:00
description: 'Used in determining whether default tasks should be marked billable when creating a new project. Defaults to true.',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Default Hourly Rate',
name: 'default_hourly_rate',
type: 'number',
default: 0,
2020-10-22 06:46:03 -07:00
description: 'The default hourly rate to use for this task when it is added to a project. Defaults to 0.',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Is Active',
name: 'is_active',
type: 'boolean',
default: true,
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
description: 'Whether this task is active or archived. Defaults to true.',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Is Default',
name: 'is_default',
type: 'boolean',
default: false,
description: 'Whether this task should be automatically added to future projects. Defaults to false.',
},
2020-01-31 06:06:10 -08:00
],
},
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
/* task:update */
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
{
displayName: 'Task ID',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'update',
],
resource,
},
},
description: 'The ID of the task you want to update',
},
2020-01-31 06:06:10 -08:00
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Update Field',
displayOptions: {
show: {
operation: [
'update',
],
resource,
},
2020-01-31 04:47:20 -08:00
},
2020-01-31 06:06:10 -08:00
default: {},
options: [
2020-01-31 06:06:10 -08:00
{
displayName: 'Billable By Default',
name: 'billable_by_default',
type: 'boolean',
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
default: false,
2020-10-22 06:46:03 -07:00
description: 'Used in determining whether default tasks should be marked billable when creating a new project. Defaults to true.',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Default Hourly Rate',
name: 'default_hourly_rate',
type: 'number',
default: 0,
2020-10-22 06:46:03 -07:00
description: 'The default hourly rate to use for this task when it is added to a project. Defaults to 0.',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Is Active',
name: 'is_active',
type: 'boolean',
default: true,
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
description: 'Whether this task is active or archived. Defaults to true.',
},
2020-01-31 06:06:10 -08:00
{
displayName: 'Is Default',
name: 'is_default',
type: 'boolean',
default: false,
2020-10-22 06:46:03 -07:00
description: 'Whether this task should be automatically added to future projects. Defaults to false.',
2020-01-31 06:06:10 -08:00
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the task',
},
2020-01-31 06:06:10 -08:00
],
2020-01-31 04:47:20 -08:00
},
2020-01-28 07:50:15 -08:00
];