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

555 lines
12 KiB
TypeScript
Raw Normal View History

import {
INodeProperties,
} from 'n8n-workflow';
export const resource = [
'timeEntry',
];
2020-01-28 06:46:38 -08:00
export const timeEntryOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
2020-01-31 05:32:14 -08:00
resource,
2020-01-28 06:46:38 -08:00
},
},
options: [
{
name: 'Create via Duration',
value: 'createByDuration',
description: 'Create a time entry via duration',
},
{
name: 'Create via Start and End Time',
value: 'createByStartEnd',
description: 'Create a time entry via start and end time',
},
{
name: 'Delete',
value: 'delete',
description: `Delete a time entry`,
},
{
name: 'Delete External Reference',
value: 'deleteExternal',
description: `Delete a time entrys external reference.`,
},
{
name: 'Get',
value: 'get',
description: 'Get data of a time entry',
},
{
name: 'Get All',
value: 'getAll',
description: 'Get data of all time entries',
},
{
name: 'Restart',
value: 'restartTime',
description: 'Restart a time entry',
},
{
name: 'Stop',
value: 'stopTime',
description: 'Stop a time entry',
},
{
name: 'Update',
value: 'update',
description: 'Update a time entry',
},
],
default: 'getAll',
2020-01-28 06:46:38 -08:00
description: 'The operation to perform.',
},
] as INodeProperties[];
export const timeEntryFields = [
/* -------------------------------------------------------------------------- */
/* timeEntry:getAll */
/* -------------------------------------------------------------------------- */
2020-01-28 06:46:38 -08:00
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
},
2020-01-28 06:46:38 -08:00
},
default: false,
description: 'Returns a list of your time entries.',
2020-01-28 06:46:38 -08:00
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
returnAll: [
false,
],
},
2020-01-28 06:46:38 -08:00
},
typeOptions: {
minValue: 1,
maxValue: 100,
2020-01-28 06:46:38 -08:00
},
default: 100,
description: 'How many results to return.',
2020-01-28 06:46:38 -08:00
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource,
operation: [
'getAll',
],
},
},
options: [
{
displayName: 'Client ID',
name: 'client_id',
type: 'string',
default: '',
description: 'Only return time entries belonging to the client with the given ID.',
},
{
displayName: 'From',
name: 'from',
type: 'dateTime',
default: '',
description: 'Only return time entries with a spent_date on or after the given date.',
},
{
displayName: 'Is Billed',
name: 'is_billed',
type: 'boolean',
default: true,
description: 'Pass true to only return time entries that have been invoiced and false to return time entries that have not been invoiced.',
},
{
displayName: 'Is Running',
name: 'is_running',
type: 'boolean',
default: true,
description: 'Pass true to only return running time entries and false to return non-running time entries.',
},
{
displayName: 'Page',
name: 'page',
type: 'number',
typeOptions: {
minValue: 1,
},
default: 1,
description: 'The page number to use in pagination. For instance, if you make a list request and receive 100 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)',
},
{
displayName: 'To',
name: 'to',
type: 'dateTime',
default: '',
description: 'Only return time entries with a spent_date on or before the given date.',
},
{
displayName: 'Updated Since',
name: 'updated_since',
type: 'dateTime',
default: '',
description: 'Only return time entries that have been updated since the given date and time.',
},
{
displayName: 'User ID',
name: 'user_id',
type: 'string',
default: '',
description: 'Only return time entries belonging to the user with the given ID.',
},
],
},
2020-01-28 06:46:38 -08:00
/* -------------------------------------------------------------------------- */
/* timeEntry:get */
/* -------------------------------------------------------------------------- */
{
displayName: 'Time Entry Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
description: 'The ID of the time entry you are retrieving.',
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:delete */
/* -------------------------------------------------------------------------- */
{
displayName: 'Time Entry Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'delete',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
description: 'The ID of the time entry you are deleting.',
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:deleteExternal */
/* -------------------------------------------------------------------------- */
{
displayName: 'Time Entry Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'deleteExternal',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
description: 'The ID of the time entry whose external reference you are deleting.',
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:stopTime */
/* -------------------------------------------------------------------------- */
{
displayName: 'Time Entry Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'stopTime',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
description: 'Stop a running time entry. Stopping a time entry is only possible if its currently running.',
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:restartTime */
/* -------------------------------------------------------------------------- */
{
displayName: 'Time Entry Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'restartTime',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
description: 'Restart a stopped time entry. Restarting a time entry is only possible if it isnt currently running.',
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:update */
/* -------------------------------------------------------------------------- */
{
displayName: 'Time Entry Id',
name: 'id',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'update',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
description: 'The ID of the time entry to update.',
2020-01-28 06:46:38 -08:00
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'update',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
default: {},
options: [
{
displayName: 'Ended Time',
name: 'ended_time',
type: 'string',
default: '',
placeholder: '3:00pm',
description: 'The time the entry ended.',
},
{
displayName: 'Hours',
name: 'hours',
type: 'number',
typeOptions: {
minValue: 0,
},
default: 0,
description: 'The current amount of time tracked.',
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
description: 'These are notes about the time entry..',
},
{
displayName: 'Started Time',
name: 'started_time',
type: 'string',
default: '',
placeholder: '3:00pm',
description: 'The time the entry started. Defaults to the current time. Example: “8:00am”.',
},
],
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:createByDuration */
/* -------------------------------------------------------------------------- */
{
displayName: 'Project Id',
name: 'projectId',
type: 'string',
displayOptions: {
show: {
operation: [
'createByDuration',
],
resource,
},
2020-01-29 15:51:14 -08:00
},
default: '',
required: true,
description: 'The ID of the project to associate with the time entry.',
2020-01-29 15:51:14 -08:00
},
{
displayName: 'Task Id',
name: 'taskId',
type: 'string',
displayOptions: {
show: {
operation: [
'createByDuration',
],
resource,
},
2020-01-29 15:51:14 -08:00
},
default: '',
required: true,
description: 'The ID of the task to associate with the time entry.',
2020-01-29 15:51:14 -08:00
},
{
displayName: 'Spent Date',
name: 'spentDate',
type: 'dateTime',
displayOptions: {
show: {
operation: [
'createByDuration',
],
resource,
},
2020-01-29 15:51:14 -08:00
},
default: '',
required: true,
description: 'The ISO 8601 formatted date the time entry was spent.',
2020-01-29 15:51:14 -08:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'createByDuration',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
default: {},
options: [
{
displayName: 'Hours',
name: 'hours',
type: 'number',
typeOptions: {
minValue: 0,
},
default: 0,
description: 'The current amount of time tracked.',
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
description: 'These are notes about the time entry..',
},
{
displayName: 'User ID',
name: 'user_id',
type: 'string',
default: '',
description: 'The ID of the user to associate with the time entry. Defaults to the currently authenticated users ID.',
},
],
2020-01-28 06:46:38 -08:00
},
/* -------------------------------------------------------------------------- */
/* timeEntry:createByStartEnd */
/* -------------------------------------------------------------------------- */
{
displayName: 'Project Id',
name: 'projectId',
type: 'string',
displayOptions: {
show: {
operation: [
'createByStartEnd',
],
resource,
},
2020-01-29 15:51:14 -08:00
},
default: '',
required: true,
description: 'The ID of the project to associate with the time entry.',
2020-01-29 15:51:14 -08:00
},
{
displayName: 'Task Id',
name: 'taskId',
type: 'string',
displayOptions: {
show: {
operation: [
'createByStartEnd',
],
resource,
},
2020-01-29 15:51:14 -08:00
},
default: '',
required: true,
description: 'The ID of the task to associate with the time entry.',
2020-01-29 15:51:14 -08:00
},
{
displayName: 'Spent Date',
name: 'spentDate',
type: 'dateTime',
displayOptions: {
show: {
operation: [
'createByStartEnd',
],
resource,
},
2020-01-29 15:51:14 -08:00
},
default: '',
required: true,
description: 'The ISO 8601 formatted date the time entry was spent.',
2020-01-29 15:51:14 -08:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
operation: [
'createByStartEnd',
],
resource,
},
2020-01-28 06:46:38 -08:00
},
default: {},
options: [
{
displayName: 'Ended Time',
name: 'ended_time',
type: 'string',
default: '',
placeholder: '3:00pm',
description: 'The time the entry ended.',
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
description: 'These are notes about the time entry..',
},
{
displayName: 'Started Time',
name: 'started_time',
type: 'string',
default: '',
placeholder: '8:00am',
description: 'The time the entry started. Defaults to the current time. Example: “8:00am”.',
},
{
displayName: 'User ID',
name: 'user_id',
type: 'string',
default: '',
description: 'The ID of the user to associate with the time entry. Defaults to the currently authenticated users ID.',
},
],
2020-01-28 06:46:38 -08:00
},
] as INodeProperties[];