✨ Add Freshworks node (#2017)

* ✨ Create Freshworks node

* ⚡ Implement all getAll operations

* ⚡ Add tz to appointment:create and update

* ⚡ Fix repetition in email in contact:create

* ⚡ Add tz to salesActivity:create and update

* ⚡ Add tz to task:create and update

* 🔥 Remove required from due date

* ⚡ Add all-day setting to appointment

* ⚡ Add filters to all operations

* ⚡ Improvements

* ⚡ Minor improvements

* ⚡ Additional parameter display name changes

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>

packages/nodes-base/nodes/FreshworksCrm/GenericFunctions.ts

@@ -0,0 +1,215 @@
+import {
+	IExecuteFunctions,
+} from 'n8n-core';
+
+import {
+	IDataObject,
+	ILoadOptionsFunctions,
+	NodeApiError,
+	NodeOperationError,
+} from 'n8n-workflow';
+
+import {
+	OptionsWithUri,
+} from 'request';
+
+import {
+	FreshworksConfigResponse,
+	FreshworksCrmApiCredentials,
+	SalesAccounts,
+	ViewsResponse,
+} from './types';
+
+import {
+	omit,
+} from 'lodash';
+
+export async function freshworksCrmApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: string,
+	endpoint: string,
+	body: IDataObject = {},
+	qs: IDataObject = {},
+) {
+	const { apiKey, domain } = this.getCredentials('freshworksCrmApi') as FreshworksCrmApiCredentials;
+
+	const options: OptionsWithUri = {
+		headers: {
+			Authorization: `Token token=${apiKey}`,
+		},
+		method,
+		body,
+		qs,
+		uri: `https://${domain}.myfreshworks.com/crm/sales/api${endpoint}`,
+		json: true,
+	};
+
+	if (!Object.keys(body).length) {
+		delete options.body;
+	}
+
+	if (!Object.keys(qs).length) {
+		delete options.qs;
+	}
+	try {
+		return await this.helpers.request!(options);
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error);
+	}
+}
+
+export async function getAllItemsViewId(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	{ fromLoadOptions } = { fromLoadOptions: false },
+) {
+	let resource = this.getNodeParameter('resource', 0) as string;
+	let keyword = 'All';
+
+	if (resource === 'account' || fromLoadOptions) {
+		resource = 'sales_account'; // adjust resource to endpoint
+	}
+
+	if (resource === 'deal') {
+		keyword = 'My Deals'; // no 'All Deals' available
+	}
+
+	const response = await freshworksCrmApiRequest.call(this, 'GET', `/${resource}s/filters`) as ViewsResponse;
+
+	const view = response.filters.find(v => v.name.includes(keyword));
+
+	if (!view) {
+		throw new NodeOperationError(this.getNode(), 'Failed to get all items view');
+	}
+
+	return view.id.toString();
+}
+
+export async function freshworksCrmApiRequestAllItems(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: string,
+	endpoint: string,
+	body: IDataObject = {},
+	qs: IDataObject = {},
+) {
+	const returnData: IDataObject[] = [];
+	let response: any; // tslint:disable-line: no-any
+
+	qs.page = 1;
+
+	do {
+		response = await freshworksCrmApiRequest.call(this, method, endpoint, body, qs);
+		const key = Object.keys(response)[0];
+		returnData.push(...response[key]);
+		qs.page++;
+	} while (
+		response.meta.total_pages && qs.page <= response.meta.total_pages
+	);
+
+	return returnData;
+}
+
+export async function handleListing(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	method: string,
+	endpoint: string,
+	body: IDataObject = {},
+	qs: IDataObject = {},
+) {
+	const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
+
+	if (returnAll) {
+		return await freshworksCrmApiRequestAllItems.call(this, method, endpoint, body, qs);
+	}
+
+	const responseData = await freshworksCrmApiRequestAllItems.call(this, method, endpoint, body, qs);
+	const limit = this.getNodeParameter('limit', 0) as number;
+
+	if (limit) return responseData.slice(0, limit);
+
+	return responseData;
+}
+
+/**
+ * Load resources for options, except users.
+ *
+ * See: https://developers.freshworks.com/crm/api/#admin_configuration
+ */
+export async function loadResource(
+	this: ILoadOptionsFunctions,
+	resource: string,
+) {
+	const response = await freshworksCrmApiRequest.call(
+		this, 'GET', `/selector/${resource}`,
+	) as FreshworksConfigResponse<LoadedResource>;
+
+	const key = Object.keys(response)[0];
+	return response[key].map(({ name, id }) => ({ name, value: id }));
+}
+
+export function adjustAttendees(attendees: [{ type: string, contactId: string, userId: string }]) {
+	return attendees.map((attendee) => {
+		if (attendee.type === 'contact') {
+			return {
+				attendee_type: 'Contact',
+				attendee_id: attendee.contactId.toString(),
+			};
+		} else if (attendee.type === 'user') {
+			return {
+				attendee_type: 'FdMultitenant::User',
+				attendee_id: attendee.userId.toString(),
+			};
+		}
+	});
+}
+
+
+// /**
+//  * Adjust attendee data from n8n UI to the format expected by Freshworks CRM API.
+//  */
+// export function adjustAttendees(additionalFields: IDataObject & Attendees) {
+// 	if (!additionalFields?.appointment_attendees_attributes) return additionalFields;
+
+// 	return {
+// 		...omit(additionalFields, ['appointment_attendees_attributes']),
+// 		appointment_attendees_attributes: additionalFields.appointment_attendees_attributes.map(attendeeId => {
+// 			return { type: 'user', id: attendeeId };
+// 		}),
+// 	};
+// }
+
+/**
+ * Adjust account data from n8n UI to the format expected by Freshworks CRM API.
+ */
+export function adjustAccounts(additionalFields: IDataObject & SalesAccounts) {
+	if (!additionalFields?.sales_accounts) return additionalFields;
+
+	const adjusted = additionalFields.sales_accounts.map(accountId => {
+		return { id: accountId, is_primary: false };
+	});
+
+	adjusted[0].is_primary = true;
+
+	return {
+		...omit(additionalFields, ['sales_accounts']),
+		sales_accounts: adjusted,
+	};
+}
+
+export function throwOnEmptyUpdate(
+	this: IExecuteFunctions,
+	resource: string,
+) {
+	throw new NodeOperationError(
+		this.getNode(),
+		`Please enter at least one field to update for the ${resource}.`,
+	);
+}
+
+export function throwOnEmptyFilter(
+	this: IExecuteFunctions,
+) {
+	throw new NodeOperationError(
+		this.getNode(),
+		`Please select at least one filter.`,
+	);
+}