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

294 lines
6.4 KiB
TypeScript
Raw Normal View History

import { INodeProperties } from 'n8n-workflow';
const resource = ['task'];
2020-01-28 07:50:15 -08:00
export const taskOperations = [
{
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-28 07:50:15 -08:00
],
default: 'getAll',
2020-01-28 07:50:15 -08:00
description: 'The operation to perform.',
},
] as INodeProperties[];
export const taskFields = [
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
/* task:getAll */
/* -------------------------------------------------------------------------- */
2020-01-28 07:50:15 -08:00
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: 'Returns a list of your tasks.',
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: 'How many 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.',
},
{
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 */
/* -------------------------------------------------------------------------- */
{
displayName: 'Task Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource,
},
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
description: 'The ID of the task you are retrieving.',
},
2020-01-28 07:50:15 -08:00
2020-01-31 06:06:10 -08:00
/* -------------------------------------------------------------------------- */
/* task:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Task Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'delete',
],
resource,
},
2020-01-28 07:50:15 -08:00
},
2020-01-31 06:06:10 -08:00
description: 'The ID of the task you wan 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 */
/* -------------------------------------------------------------------------- */
{
displayName: 'Name',
name: 'name',
type: 'string',
displayOptions: {
show: {
operation: [
'create',
],
resource,
},
},
default: '',
required: true,
description: 'The name of the task.',
},
{
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: '',
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: 'string',
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 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: 'Is Active',
name: 'is_active',
type: 'boolean',
default: true,
2020-10-22 06:46:03 -07:00
description: 'Whether this task is active or archived. Defaults to true',
2020-01-31 06:06:10 -08:00
},
],
},
/* -------------------------------------------------------------------------- */
/* task:update */
/* -------------------------------------------------------------------------- */
{
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',
default: '',
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: 'string',
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,
2020-10-22 06:46:03 -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: '',
2020-10-22 06:46:03 -07:00
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
] as INodeProperties[];