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

523 lines
16 KiB
TypeScript
Raw Normal View History

2020-01-28 06:46:38 -08:00
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeTypeDescription,
INodeExecutionData,
INodeType,
} from 'n8n-workflow';
import { harvestApiRequest, harvestApiRequestAllItems } from './GenericFunctions';
2020-01-28 06:46:38 -08:00
import { timeEntryOperations, timeEntryFields } from './TimeEntryDescription';
import { clientOperations, clientFields } from './ClientDescription';
import { companyOperations } from './CompanyDescription';
import { contactOperations, contactFields } from './ContactDescription';
import { expenseOperations, expenseFields } from './ExpenseDescription';
import { invoiceOperations, invoiceFields } from './InvoiceDescription';
import { projectOperations, projectFields } from './ProjectDescription';
import { taskOperations, taskFields } from './TaskDescription';
import { userOperations, userFields } from './UserDescription';
import { estimateOperations, estimateFields } from './EstimateDescription';
2020-01-28 06:46:38 -08:00
/**
* fetch All resource using paginated calls
*/
async function getAllResource(this: IExecuteFunctions, resource: string, i: number) {
const endpoint = resource;
2020-01-29 15:51:14 -08:00
const qs: IDataObject = {};
const requestMethod = 'GET';
qs.per_page = 100;
const additionalFields = this.getNodeParameter('filters', i) as IDataObject;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
Object.assign(qs, additionalFields);
2020-01-29 15:51:14 -08:00
let responseData: IDataObject = {};
if(returnAll) {
responseData[resource] = await harvestApiRequestAllItems.call(this, requestMethod, qs, endpoint, resource);
} else {
const limit = this.getNodeParameter('limit', i) as string;
qs.per_page = limit;
responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
}
2020-01-29 15:51:14 -08:00
return responseData[resource] as IDataObject[];
}
2020-01-28 06:46:38 -08:00
export class Harvest implements INodeType {
description: INodeTypeDescription = {
displayName: 'Harvest',
name: 'harvest',
icon: 'file:harvest.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Access data on Harvest',
defaults: {
name: 'Harvest',
color: '#22BB44',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'harvestApi',
required: true,
}
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
2020-01-29 15:51:14 -08:00
2020-01-28 06:46:38 -08:00
{
2020-01-29 15:51:14 -08:00
name: 'Client',
value: 'client',
2020-01-28 06:46:38 -08:00
},
2020-01-28 07:50:15 -08:00
{
2020-01-29 15:51:14 -08:00
name: 'Company',
value: 'company',
2020-01-28 07:50:15 -08:00
},
{
2020-01-29 15:51:14 -08:00
name: 'Contact',
value: 'contact',
},
{
2020-01-29 15:51:14 -08:00
name: 'Estimates',
value: 'estimate',
},
{
2020-01-29 15:51:14 -08:00
name: 'Expense',
value: 'expense',
},
{
2020-01-29 15:51:14 -08:00
name: 'Invoice',
value: 'invoice',
},
{
2020-01-29 15:51:14 -08:00
name: 'Project',
value: 'project',
},
{
2020-01-29 15:51:14 -08:00
name: 'Task',
value: 'task',
},
{
2020-01-29 15:51:14 -08:00
name: 'Time Entries',
value: 'timeEntry',
},
{
2020-01-29 15:51:14 -08:00
name: 'User',
value: 'user',
},
2020-01-28 06:46:38 -08:00
],
2020-01-29 15:51:14 -08:00
default: 'task',
2020-01-28 06:46:38 -08:00
description: 'The resource to operate on.',
},
// operations
...clientOperations,
...companyOperations,
...contactOperations,
...estimateOperations,
...expenseOperations,
...invoiceOperations,
...projectOperations,
...taskOperations,
2020-01-28 06:46:38 -08:00
...timeEntryOperations,
...userOperations,
2020-01-28 06:46:38 -08:00
// fields
...clientFields,
...contactFields,
...estimateFields,
...expenseFields,
...invoiceFields,
...projectFields,
...taskFields,
...timeEntryFields,
...userFields
2020-01-28 06:46:38 -08:00
]
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
let endpoint = '';
let requestMethod = '';
let body: IDataObject | Buffer;
let qs: IDataObject;
for (let i = 0; i < items.length; i++) {
body = {};
qs = {};
if (resource === 'timeEntry') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `time_entries/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'time_entries', i);
returnData.push.apply(returnData, responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'createByStartEnd') {
// ----------------------------------
// createByStartEnd
// ----------------------------------
requestMethod = 'POST';
endpoint = 'time_entries';
2020-01-29 15:51:14 -08:00
body.project_id = this.getNodeParameter('projectId', i) as string;
body.task_id = this.getNodeParameter('taskId', i) as string;
body.spent_date = this.getNodeParameter('spentDate', i) as string;
2020-01-28 06:46:38 -08:00
2020-01-29 15:51:14 -08:00
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(body, additionalFields);
2020-01-28 06:46:38 -08:00
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint, body);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'createByDuration') {
// ----------------------------------
// createByDuration
// ----------------------------------
requestMethod = 'POST';
endpoint = 'time_entries';
2020-01-29 15:51:14 -08:00
body.project_id = this.getNodeParameter('projectId', i) as string;
body.task_id = this.getNodeParameter('taskId', i) as string;
body.spent_date = this.getNodeParameter('spentDate', i) as string;
2020-01-28 06:46:38 -08:00
2020-01-29 15:51:14 -08:00
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(body, additionalFields);
2020-01-28 06:46:38 -08:00
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint, body);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'delete') {
// ----------------------------------
// delete
// ----------------------------------
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
endpoint = `time_entries/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'deleteExternal') {
// ----------------------------------
// deleteExternal
// ----------------------------------
requestMethod = 'DELETE';
const id = this.getNodeParameter('id', i) as string;
endpoint = `time_entries/${id}/external_reference`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'restartTime') {
// ----------------------------------
// restartTime
// ----------------------------------
requestMethod = 'PATCH';
const id = this.getNodeParameter('id', i) as string;
endpoint = `time_entries/${id}/restart`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'stopTime') {
// ----------------------------------
// stopTime
// ----------------------------------
requestMethod = 'PATCH';
const id = this.getNodeParameter('id', i) as string;
endpoint = `time_entries/${id}/stop`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else if (operation === 'update') {
// ----------------------------------
// update
// ----------------------------------
requestMethod = 'PATCH';
const id = this.getNodeParameter('id', i) as string;
endpoint = `time_entries/${id}`;
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
2020-01-29 15:51:14 -08:00
Object.assign(body, updateFields);
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint, body);
returnData.push(responseData);
2020-01-28 06:46:38 -08:00
} else {
throw new Error(`The operation "${operation}" is not known!`);
}
2020-01-28 07:50:15 -08:00
} else if (resource === 'client') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `clients/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'clients', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'project') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `projects/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'projects', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'user') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `users/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'users', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'me') {
// ----------------------------------
// me
2020-01-28 07:50:15 -08:00
// ----------------------------------
requestMethod = 'GET';
endpoint = 'users/me';
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'contact') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `contacts/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'contacts', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'company') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
endpoint = `company`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'task') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `tasks/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'tasks', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'invoice') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `invoices/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'invoices', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'expense') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `expenses/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
2020-01-28 07:50:15 -08:00
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'expenses', i);
returnData.push.apply(returnData, responseData);
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
} else if (resource === 'estimate') {
if (operation === 'get') {
// ----------------------------------
// get
// ----------------------------------
requestMethod = 'GET';
const id = this.getNodeParameter('id', i) as string;
endpoint = `estimates/${id}`;
2020-01-29 15:51:14 -08:00
const responseData = await harvestApiRequest.call(this, requestMethod, qs, endpoint);
returnData.push(responseData);
} else if (operation === 'getAll') {
// ----------------------------------
// getAll
// ----------------------------------
const responseData: IDataObject[] = await getAllResource.call(this, 'estimates', i);
returnData.push.apply(returnData, responseData);
2020-01-28 07:50:15 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
2020-01-28 06:46:38 -08:00
} else {
throw new Error(`The resource "${resource}" is not known!`);
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}