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

import type {
	IExecuteFunctions,
	IDataObject,
	INodeExecutionData,
	INodeType,
	INodeTypeDescription,
} from 'n8n-workflow';
import { NodeConnectionType } from 'n8n-workflow';

import {
	adjustCompanyFields,
	adjustLeadFields,
	adjustPersonFields,
	adjustTaskFields,
	copperApiRequest,
	handleListing,
} from './GenericFunctions';

import {
	companyFields,
	companyOperations,
	customerSourceFields,
	customerSourceOperations,
	leadFields,
	leadOperations,
	opportunityFields,
	opportunityOperations,
	personFields,
	personOperations,
	projectFields,
	projectOperations,
	taskFields,
	taskOperations,
	userFields,
	userOperations,
} from './descriptions';

export class Copper implements INodeType {
	description: INodeTypeDescription = {
		displayName: 'Copper',
		name: 'copper',
		icon: 'file:copper.svg',
		group: ['transform'],
		version: 1,
		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
		description: 'Consume the Copper API',
		defaults: {
			name: 'Copper',
		},
		inputs: [NodeConnectionType.Main],
		outputs: [NodeConnectionType.Main],
		credentials: [
			{
				name: 'copperApi',
				required: true,
			},
		],
		properties: [
			{
				displayName: 'Resource',
				name: 'resource',
				type: 'options',
				noDataExpression: true,
				options: [
					{
						name: 'Company',
						value: 'company',
					},
					{
						name: 'Customer Source',
						value: 'customerSource',
					},
					{
						name: 'Lead',
						value: 'lead',
					},
					{
						name: 'Opportunity',
						value: 'opportunity',
					},
					{
						name: 'Person',
						value: 'person',
					},
					{
						name: 'Project',
						value: 'project',
					},
					{
						name: 'Task',
						value: 'task',
					},
					{
						name: 'User',
						value: 'user',
					},
				],
				default: 'company',
			},
			...companyOperations,
			...companyFields,
			...customerSourceOperations,
			...customerSourceFields,
			...leadOperations,
			...leadFields,
			...opportunityOperations,
			...opportunityFields,
			...personOperations,
			...personFields,
			...projectOperations,
			...projectFields,
			...taskOperations,
			...taskFields,
			...userOperations,
			...userFields,
		],
	};

	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
		const items = this.getInputData();
		const returnData: INodeExecutionData[] = [];

		const resource = this.getNodeParameter('resource', 0);
		const operation = this.getNodeParameter('operation', 0);

		let responseData;

		for (let i = 0; i < items.length; i++) {
			try {
				if (resource === 'company') {
					// **********************************************************************
					//                                company
					// **********************************************************************

					if (operation === 'create') {
						// ----------------------------------------
						//             company: create
						// ----------------------------------------

						// https://developer.copper.com/companies/create-a-new-company.html

						const body: IDataObject = {
							name: this.getNodeParameter('name', i),
						};

						const additionalFields = this.getNodeParameter('additionalFields', i);

						if (Object.keys(additionalFields).length) {
							Object.assign(body, adjustCompanyFields(additionalFields));
						}

						responseData = await copperApiRequest.call(this, 'POST', '/companies', body);
					} else if (operation === 'delete') {
						// ----------------------------------------
						//             company: delete
						// ----------------------------------------

						// https://developer.copper.com/companies/delete-a-company.html

						const companyId = this.getNodeParameter('companyId', i);

						responseData = await copperApiRequest.call(this, 'DELETE', `/companies/${companyId}`);
					} else if (operation === 'get') {
						// ----------------------------------------
						//               company: get
						// ----------------------------------------

						// https://developer.copper.com/companies/fetch-a-company-by-id.html

						const companyId = this.getNodeParameter('companyId', i);

						responseData = await copperApiRequest.call(this, 'GET', `/companies/${companyId}`);
					} else if (operation === 'getAll') {
						// ----------------------------------------
						//             company: getAll
						// ----------------------------------------

						// https://developer.copper.com/companies/list-companies-search.html

						const body: IDataObject = {};
						const filterFields = this.getNodeParameter('filterFields', i) as IDataObject;

						if (Object.keys(filterFields).length) {
							Object.assign(body, filterFields);
						}

						responseData = await handleListing.call(this, 'POST', '/companies/search', body);
					} else if (operation === 'update') {
						// ----------------------------------------
						//             company: update
						// ----------------------------------------

						// https://developer.copper.com/companies/update-a-company.html

						const companyId = this.getNodeParameter('companyId', i);

						const body: IDataObject = {};
						const updateFields = this.getNodeParameter('updateFields', i);

						if (Object.keys(updateFields).length) {
							Object.assign(body, adjustCompanyFields(updateFields));
						}

						responseData = await copperApiRequest.call(
							this,
							'PUT',
							`/companies/${companyId}`,
							body,
						);
					}
				} else if (resource === 'customerSource') {
					// **********************************************************************
					//                            customerSource
					// **********************************************************************

					if (operation === 'getAll') {
						// ----------------------------------------
						//        customerSource: getAll
						// ----------------------------------------

						responseData = await handleListing.call(this, 'GET', '/customer_sources');
					}
				} else if (resource === 'lead') {
					// **********************************************************************
					//                                  lead
					// **********************************************************************

					if (operation === 'create') {
						// ----------------------------------------
						//               lead: create
						// ----------------------------------------

						// https://developer.copper.com/leads/create-a-new-lead.html

						const body: IDataObject = {
							name: this.getNodeParameter('name', i),
						};

						const additionalFields = this.getNodeParameter('additionalFields', i);

						if (Object.keys(additionalFields).length) {
							Object.assign(body, adjustLeadFields(additionalFields));
						}

						responseData = await copperApiRequest.call(this, 'POST', '/leads', body);
					} else if (operation === 'delete') {
						// ----------------------------------------
						//               lead: delete
						// ----------------------------------------

						// https://developer.copper.com/leads/delete-a-lead.html

						const leadId = this.getNodeParameter('leadId', i);

						responseData = await copperApiRequest.call(this, 'DELETE', `/leads/${leadId}`);
					} else if (operation === 'get') {
						// ----------------------------------------
						//                lead: get
						// ----------------------------------------

						// https://developer.copper.com/leads/fetch-a-lead-by-id.html

						const leadId = this.getNodeParameter('leadId', i);

						responseData = await copperApiRequest.call(this, 'GET', `/leads/${leadId}`);
					} else if (operation === 'getAll') {
						// ----------------------------------------
						//               lead: getAll
						// ----------------------------------------

						const body: IDataObject = {};
						const filterFields = this.getNodeParameter('filterFields', i) as IDataObject;

						if (Object.keys(filterFields).length) {
							Object.assign(body, filterFields);
						}

						responseData = await handleListing.call(this, 'POST', '/leads/search', body);
					} else if (operation === 'update') {
						// ----------------------------------------
						//               lead: update
						// ----------------------------------------

						// https://developer.copper.com/leads/update-a-lead.html

						const leadId = this.getNodeParameter('leadId', i);

						const body: IDataObject = {};
						const updateFields = this.getNodeParameter('updateFields', i);

						if (Object.keys(updateFields).length) {
							Object.assign(body, adjustLeadFields(updateFields));
						}

						responseData = await copperApiRequest.call(this, 'PUT', `/leads/${leadId}`, body);
					}
				} else if (resource === 'opportunity') {
					// **********************************************************************
					//                              opportunity
					// **********************************************************************

					if (operation === 'create') {
						// ----------------------------------------
						//           opportunity: create
						// ----------------------------------------

						// https://developer.copper.com/opportunities/create-a-new-opportunity.html

						const body: IDataObject = {
							name: this.getNodeParameter('name', i),
							customer_source_id: this.getNodeParameter('customerSourceId', i),
							primary_contact_id: this.getNodeParameter('primaryContactId', i),
						};

						responseData = await copperApiRequest.call(this, 'POST', '/opportunities', body);
					} else if (operation === 'delete') {
						// ----------------------------------------
						//           opportunity: delete
						// ----------------------------------------

						// https://developer.copper.com/opportunities/delete-an-opportunity.html

						const opportunityId = this.getNodeParameter('opportunityId', i);

						responseData = await copperApiRequest.call(
							this,
							'DELETE',
							`/opportunities/${opportunityId}`,
						);
					} else if (operation === 'get') {
						// ----------------------------------------
						//             opportunity: get
						// ----------------------------------------

						// https://developer.copper.com/opportunities/fetch-an-opportunity-by-id.html

						const opportunityId = this.getNodeParameter('opportunityId', i);

						responseData = await copperApiRequest.call(
							this,
							'GET',
							`/opportunities/${opportunityId}`,
						);
					} else if (operation === 'getAll') {
						// ----------------------------------------
						//           opportunity: getAll
						// ----------------------------------------

						// https://developer.copper.com/opportunities/list-opportunities-search.html

						const body: IDataObject = {};
						const filterFields = this.getNodeParameter('filterFields', i) as IDataObject;

						if (Object.keys(filterFields).length) {
							Object.assign(body, filterFields);
						}

						responseData = await handleListing.call(this, 'POST', '/opportunities/search', body);
					} else if (operation === 'update') {
						// ----------------------------------------
						//           opportunity: update
						// ----------------------------------------

						// https://developer.copper.com/opportunities/update-an-opportunity.html

						const opportunityId = this.getNodeParameter('opportunityId', i);

						const body: IDataObject = {};
						const updateFields = this.getNodeParameter('updateFields', i);

						if (Object.keys(updateFields).length) {
							Object.assign(body, updateFields);
						}

						responseData = await copperApiRequest.call(
							this,
							'PUT',
							`/opportunities/${opportunityId}`,
							body,
						);
					}
				} else if (resource === 'person') {
					// **********************************************************************
					//                                 person
					// **********************************************************************

					if (operation === 'create') {
						// ----------------------------------------
						//              person: create
						// ----------------------------------------

						// https://developer.copper.com/people/create-a-new-person.html

						const body: IDataObject = {
							name: this.getNodeParameter('name', i),
						};

						const additionalFields = this.getNodeParameter('additionalFields', i);

						if (Object.keys(additionalFields).length) {
							Object.assign(body, adjustPersonFields(additionalFields));
						}

						responseData = await copperApiRequest.call(this, 'POST', '/people', body);
					} else if (operation === 'delete') {
						// ----------------------------------------
						//              person: delete
						// ----------------------------------------

						// https://developer.copper.com/people/delete-a-person.html

						const personId = this.getNodeParameter('personId', i);

						responseData = await copperApiRequest.call(this, 'DELETE', `/people/${personId}`);
					} else if (operation === 'get') {
						// ----------------------------------------
						//               person: get
						// ----------------------------------------

						// https://developer.copper.com/people/fetch-a-person-by-id.html

						const personId = this.getNodeParameter('personId', i);

						responseData = await copperApiRequest.call(this, 'GET', `/people/${personId}`);
					} else if (operation === 'getAll') {
						// ----------------------------------------
						//              person: getAll
						// ----------------------------------------

						const body: IDataObject = {};
						const filterFields = this.getNodeParameter('filterFields', i) as IDataObject;

						if (Object.keys(filterFields).length) {
							Object.assign(body, filterFields);
						}

						responseData = await handleListing.call(this, 'POST', '/people/search', body);
					} else if (operation === 'update') {
						// ----------------------------------------
						//              person: update
						// ----------------------------------------

						// https://developer.copper.com/people/update-a-person.html

						const personId = this.getNodeParameter('personId', i);

						const body: IDataObject = {};
						const updateFields = this.getNodeParameter('updateFields', i);

						if (Object.keys(updateFields).length) {
							Object.assign(body, adjustPersonFields(updateFields));
						}

						responseData = await copperApiRequest.call(this, 'PUT', `/people/${personId}`, body);
					}
				} else if (resource === 'project') {
					// **********************************************************************
					//                                project
					// **********************************************************************

					if (operation === 'create') {
						// ----------------------------------------
						//             project: create
						// ----------------------------------------

						// https://developer.copper.com/projects/create-a-new-project.html

						const body: IDataObject = {
							name: this.getNodeParameter('name', i),
						};

						const additionalFields = this.getNodeParameter('additionalFields', i);

						if (Object.keys(additionalFields).length) {
							Object.assign(body, additionalFields);
						}

						responseData = await copperApiRequest.call(this, 'POST', '/projects', body);
					} else if (operation === 'delete') {
						// ----------------------------------------
						//             project: delete
						// ----------------------------------------

						// https://developer.copper.com/projects/delete-a-project.html

						const projectId = this.getNodeParameter('projectId', i);

						responseData = await copperApiRequest.call(this, 'DELETE', `/projects/${projectId}`);
					} else if (operation === 'get') {
						// ----------------------------------------
						//               project: get
						// ----------------------------------------

						// https://developer.copper.com/projects/fetch-a-project-by-id.html

						const projectId = this.getNodeParameter('projectId', i);

						responseData = await copperApiRequest.call(this, 'GET', `/projects/${projectId}`);
					} else if (operation === 'getAll') {
						// ----------------------------------------
						//             project: getAll
						// ----------------------------------------

						// https://developer.copper.com/projects/list-projects-search.html

						const body: IDataObject = {};
						const filterFields = this.getNodeParameter('filterFields', i) as IDataObject;

						if (Object.keys(filterFields).length) {
							Object.assign(body, filterFields);
						}

						responseData = await handleListing.call(this, 'POST', '/projects/search', body);
					} else if (operation === 'update') {
						// ----------------------------------------
						//             project: update
						// ----------------------------------------

						// https://developer.copper.com/projects/update-a-project.html

						const projectId = this.getNodeParameter('projectId', i);

						const body: IDataObject = {};
						const updateFields = this.getNodeParameter('updateFields', i);

						if (Object.keys(updateFields).length) {
							Object.assign(body, updateFields);
						}

						responseData = await copperApiRequest.call(this, 'PUT', `/projects/${projectId}`, body);
					}
				} else if (resource === 'task') {
					// **********************************************************************
					//                                  task
					// **********************************************************************

					if (operation === 'create') {
						// ----------------------------------------
						//               task: create
						// ----------------------------------------

						// https://developer.copper.com/tasks/create-a-new-task.html

						const body: IDataObject = {
							name: this.getNodeParameter('name', i),
						};

						const additionalFields = this.getNodeParameter('additionalFields', i);

						if (Object.keys(additionalFields).length) {
							Object.assign(body, additionalFields);
						}

						responseData = await copperApiRequest.call(this, 'POST', '/tasks', body);
					} else if (operation === 'delete') {
						// ----------------------------------------
						//               task: delete
						// ----------------------------------------

						// https://developer.copper.com/tasks/delete-a-task.html

						const taskId = this.getNodeParameter('taskId', i);

						responseData = await copperApiRequest.call(this, 'DELETE', `/tasks/${taskId}`);
					} else if (operation === 'get') {
						// ----------------------------------------
						//                task: get
						// ----------------------------------------

						// https://developer.copper.com/tasks/fetch-a-task-by-id.html

						const taskId = this.getNodeParameter('taskId', i);

						responseData = await copperApiRequest.call(this, 'GET', `/tasks/${taskId}`);
					} else if (operation === 'getAll') {
						// ----------------------------------------
						//               task: getAll
						// ----------------------------------------

						// https://developer.copper.com/tasks/list-tasks-search.html

						const body: IDataObject = {};
						const filterFields = this.getNodeParameter('filterFields', i) as IDataObject;

						if (Object.keys(filterFields).length) {
							Object.assign(body, adjustTaskFields(filterFields));
						}

						responseData = await handleListing.call(this, 'POST', '/tasks/search', body);
					} else if (operation === 'update') {
						// ----------------------------------------
						//               task: update
						// ----------------------------------------

						// https://developer.copper.com/tasks/update-a-task.html

						const taskId = this.getNodeParameter('taskId', i);

						const body: IDataObject = {};
						const updateFields = this.getNodeParameter('updateFields', i);

						if (Object.keys(updateFields).length) {
							Object.assign(body, updateFields);
						}

						responseData = await copperApiRequest.call(this, 'PUT', `/tasks/${taskId}`, body);
					}
				} else if (resource === 'user') {
					// **********************************************************************
					//                            user
					// **********************************************************************

					if (operation === 'getAll') {
						// ----------------------------------------
						//              user: getAll
						// ----------------------------------------

						responseData = await handleListing.call(this, 'POST', '/users/search');
					}
				}
			} catch (error) {
				if (this.continueOnFail()) {
					returnData.push({ error: error.toString(), json: {} });
					continue;
				}

				throw error;
			}

			const executionData = this.helpers.constructExecutionMetaData(
				this.helpers.returnJsonArray(responseData as IDataObject[]),
				{ itemData: { item: i } },
			);
			returnData.push(...executionData);
		}

		return [returnData];
	}
}