n8n/packages/nodes-base/nodes/ClickUp/TimeEntryDescription.ts
Iván Ovejero 3a9c7acb04
refactor(nodes-base): Apply lint rule node-param-operation-option-description-wrong-for-get-many (#4064)
* 👕 Enable rule

* ⬆️ Upgrade linter

* 📦 Update `package-lock.json`

* 👕 Apply rule

* ✏️ Fix plurals

* ✏️ More typos

* ✏️ Final typos
2022-09-13 12:36:36 +02:00

740 lines
16 KiB
TypeScript

import { INodeProperties } from 'n8n-workflow';
export const timeEntryOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: ['timeEntry'],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a time entry',
action: 'Create a time entry',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a time entry',
action: 'Delete a time entry',
},
{
name: 'Get',
value: 'get',
description: 'Get a time entry',
action: 'Get a time entry',
},
{
name: 'Get Many',
value: 'getAll',
description: 'Get many time entries',
action: 'Get many time entries',
},
{
name: 'Start',
value: 'start',
description: 'Start a time entry',
action: 'Start a time entry',
},
{
name: 'Stop',
value: 'stop',
description: 'Stop the current running timer',
action: 'Stop a time entry',
},
{
name: 'Update',
value: 'update',
description: 'Update a time Entry',
action: 'Update a time entry',
},
],
default: 'create',
},
];
export const timeEntryFields: INodeProperties[] = [
/* -------------------------------------------------------------------------- */
/* timeEntry:getAll */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['getAll'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['getAll'],
},
},
default: false,
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['getAll'],
returnAll: [false],
},
},
typeOptions: {
minValue: 1,
maxValue: 10,
},
default: 5,
description: 'Max number of results to return',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['getAll'],
},
},
options: [
{
displayName: 'End Date',
name: 'end_date',
type: 'dateTime',
default: '',
},
{
displayName: 'Start Date',
name: 'start_date',
type: 'dateTime',
default: '',
},
],
},
/* -------------------------------------------------------------------------- */
/* timeEntry:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['get'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
{
displayName: 'Running',
name: 'running',
type: 'boolean',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['get'],
},
},
default: false,
description: 'Whether to return just the current running time entry',
},
{
displayName: 'Time Entry ID',
name: 'timeEntry',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['get'],
running: [false],
},
},
required: true,
},
/* -------------------------------------------------------------------------- */
/* timeEntry:create */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
{
displayName: 'Space Name or ID',
name: 'space',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
typeOptions: {
loadOptionsMethod: 'getSpaces',
loadOptionsDependsOn: ['team'],
},
required: true,
},
{
displayName: 'Folderless List',
name: 'folderless',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
required: true,
},
{
displayName: 'Folder Name or ID',
name: 'folder',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
folderless: [false],
},
},
typeOptions: {
loadOptionsMethod: 'getFolders',
loadOptionsDependsOn: ['space'],
},
required: true,
},
{
displayName: 'List Name or ID',
name: 'list',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
folderless: [true],
},
},
typeOptions: {
loadOptionsMethod: 'getFolderlessLists',
loadOptionsDependsOn: ['space'],
},
required: true,
},
{
displayName: 'List Name or ID',
name: 'list',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
folderless: [false],
},
},
typeOptions: {
loadOptionsMethod: 'getLists',
loadOptionsDependsOn: ['folder'],
},
required: true,
},
{
displayName: 'Start',
name: 'start',
type: 'dateTime',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
required: true,
default: '',
},
{
displayName: 'Duration (Minutes)',
name: 'duration',
type: 'number',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
default: 0,
required: true,
description: 'Duration in minutes',
},
{
displayName: 'Task Name or ID',
name: 'task',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
typeOptions: {
loadOptionsMethod: 'getTasks',
loadOptionsDependsOn: ['list'],
},
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['create'],
},
},
options: [
{
displayName: 'Assignee Name or ID',
name: 'assignee',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getAssignees',
loadOptionsDependsOn: ['list'],
},
default: [],
},
{
displayName: 'Billable',
name: 'billable',
type: 'boolean',
default: true,
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description of the time entry',
},
{
displayName: 'Tag Names or IDs',
name: 'tags',
type: 'multiOptions',
description:
'Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsDependsOn: ['team'],
loadOptionsMethod: 'getTimeEntryTags',
},
default: [],
},
],
},
/* -------------------------------------------------------------------------- */
/* timeEntry:start */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['start'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
{
displayName: 'Task ID',
name: 'task',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['start'],
},
},
required: true,
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['start'],
},
},
options: [
{
displayName: 'Billable',
name: 'billable',
type: 'boolean',
default: true,
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description of the time entry',
},
],
},
/* -------------------------------------------------------------------------- */
/* timeEntry:stop */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['stop'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
/* -------------------------------------------------------------------------- */
/* timeEntry:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['delete'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
{
displayName: 'Time Entry ID',
name: 'timeEntry',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['delete'],
},
},
required: true,
},
/* -------------------------------------------------------------------------- */
/* timeEntry:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Team Name or ID',
name: 'team',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
},
},
typeOptions: {
loadOptionsMethod: 'getTeams',
},
required: true,
},
{
displayName: 'Space Name or ID',
name: 'space',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
},
},
typeOptions: {
loadOptionsMethod: 'getSpaces',
loadOptionsDependsOn: ['team'],
},
required: true,
},
{
displayName: 'Folderless List',
name: 'folderless',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
},
},
required: true,
},
{
displayName: 'Folder Name or ID',
name: 'folder',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
folderless: [false],
},
},
typeOptions: {
loadOptionsMethod: 'getFolders',
loadOptionsDependsOn: ['space'],
},
required: true,
},
{
displayName: 'List Name or ID',
name: 'list',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
folderless: [true],
},
},
typeOptions: {
loadOptionsMethod: 'getFolderlessLists',
loadOptionsDependsOn: ['space'],
},
required: true,
},
{
displayName: 'List Name or ID',
name: 'list',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
folderless: [false],
},
},
typeOptions: {
loadOptionsMethod: 'getLists',
loadOptionsDependsOn: ['folder'],
},
required: true,
},
{
displayName: 'Archived',
name: 'archived',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
},
},
required: true,
},
{
displayName: 'Time Entry ID',
name: 'timeEntry',
type: 'string',
default: '',
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
},
},
required: true,
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['timeEntry'],
operation: ['update'],
},
},
options: [
{
displayName: 'Assignee Name or ID',
name: 'assignee',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getAssignees',
loadOptionsDependsOn: ['list'],
},
default: [],
},
{
displayName: 'Billable',
name: 'billable',
type: 'boolean',
default: true,
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description of the time entry',
},
{
displayName: 'Duration (Minutes)',
name: 'duration',
type: 'number',
default: 0,
description: 'Duration in minutes',
},
{
displayName: 'Start',
name: 'start',
type: 'dateTime',
default: '',
},
{
displayName: 'Tag Names or IDs',
name: 'tags',
type: 'multiOptions',
description:
'Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsDependsOn: ['spaceId'],
loadOptionsMethod: 'getTags',
},
default: [],
},
{
displayName: 'Task Name or ID',
name: 'task',
type: 'options',
description:
'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
typeOptions: {
loadOptionsMethod: 'getTasks',
loadOptionsDependsOn: ['archived', 'list'],
},
default: '',
},
],
},
];