first commit

packages/nodes-base/nodes/Egoi/Egoi.node.json

@@ -0,0 +1,18 @@
+{
+	"node": "n8n-nodes-base.egoi",
+	"nodeVersion": "1.0",
+	"codexVersion": "1.0",
+	"categories": ["Communication", "Marketing"],
+	"resources": {
+		"credentialDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/credentials/egoi/"
+			}
+		],
+		"primaryDocumentation": [
+			{
+				"url": "https://docs.n8n.io/integrations/builtin/app-nodes/n8n-nodes-base.egoi/"
+			}
+		]
+	}
+}

packages/nodes-base/nodes/Egoi/Egoi.node.ts

@@ -0,0 +1,758 @@
+import moment from 'moment-timezone';
+import type {
+	IExecuteFunctions,
+	IDataObject,
+	ILoadOptionsFunctions,
+	INodeExecutionData,
+	INodePropertyOptions,
+	INodeType,
+	INodeTypeDescription,
+} from 'n8n-workflow';
+import { NodeConnectionTypes } from 'n8n-workflow';
+
+import { egoiApiRequest, egoiApiRequestAllItems, simplify } from './GenericFunctions';
+import type { ICreateMemberBody } from './Interfaces';
+
+export class Egoi implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'E-goi',
+		name: 'egoi',
+
+		icon: 'file:egoi.svg',
+		group: ['output'],
+		version: 1,
+		subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
+		description: 'Consume E-goi API',
+		defaults: {
+			name: 'E-goi',
+		},
+		usableAsTool: true,
+		inputs: [NodeConnectionTypes.Main],
+		outputs: [NodeConnectionTypes.Main],
+		credentials: [
+			{
+				name: 'egoiApi',
+				required: true,
+			},
+		],
+		properties: [
+			{
+				displayName: 'Resource',
+				name: 'resource',
+				type: 'options',
+				noDataExpression: true,
+				required: true,
+				options: [
+					{
+						name: 'Contact',
+						value: 'contact',
+					},
+				],
+				default: 'contact',
+			},
+			{
+				displayName: 'Operation',
+				name: 'operation',
+				type: 'options',
+				noDataExpression: true,
+				required: true,
+				options: [
+					{
+						name: 'Create',
+						value: 'create',
+						description: 'Create a member',
+						action: 'Create a member',
+					},
+					{
+						name: 'Get',
+						value: 'get',
+						description: 'Get a member',
+						action: 'Get a member',
+					},
+					{
+						name: 'Get Many',
+						value: 'getAll',
+						description: 'Get many members',
+						action: 'Get many members',
+					},
+					{
+						name: 'Update',
+						value: 'update',
+						description: 'Update a member',
+						action: 'Update a member',
+					},
+				],
+				default: 'create',
+			},
+			{
+				displayName: 'List Name or ID',
+				name: 'list',
+				type: 'options',
+				typeOptions: {
+					loadOptionsMethod: 'getLists',
+				},
+				displayOptions: {
+					show: {
+						operation: ['getAll', 'create', 'update', 'get'],
+					},
+				},
+				default: '',
+				description:
+					'ID of list to operate on. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+			},
+			{
+				displayName: 'Email',
+				name: 'email',
+				type: 'string',
+				placeholder: 'name@email.com',
+				displayOptions: {
+					show: {
+						operation: ['create'],
+					},
+				},
+				default: '',
+				description: 'Email address for a subscriber',
+			},
+			{
+				displayName: 'Contact ID',
+				name: 'contactId',
+				type: 'string',
+				displayOptions: {
+					show: {
+						resource: ['contact'],
+						operation: ['update'],
+					},
+				},
+				default: '',
+				description: 'Contact ID of the subscriber',
+			},
+			{
+				displayName: 'Resolve Data',
+				name: 'resolveData',
+				type: 'boolean',
+				displayOptions: {
+					show: {
+						operation: ['create', 'update'],
+					},
+				},
+				default: true,
+				// eslint-disable-next-line n8n-nodes-base/node-param-description-boolean-without-whether
+				description:
+					'By default the response just includes the contact ID. If this option gets activated, it will resolve the data automatically.',
+			},
+			{
+				displayName: 'Additional Fields',
+				name: 'additionalFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				displayOptions: {
+					show: {
+						operation: ['create'],
+						resource: ['contact'],
+					},
+				},
+				default: {},
+				options: [
+					{
+						displayName: 'Birth Date',
+						name: 'birth_date',
+						type: 'dateTime',
+						default: '',
+						description: 'Birth date of a subscriber',
+					},
+					{
+						displayName: 'Cellphone',
+						name: 'cellphone',
+						type: 'string',
+						default: '',
+						description: 'Cellphone of a subscriber',
+					},
+					{
+						displayName: 'Extra Fields',
+						name: 'extraFieldsUi',
+						type: 'fixedCollection',
+						placeholder: 'Add Field',
+						default: {},
+						typeOptions: {
+							multipleValues: true,
+						},
+						options: [
+							{
+								displayName: 'Extra Field',
+								name: 'extraFieldValues',
+								typeOptions: {
+									multipleValueButtonText: 'Add Field',
+								},
+								values: [
+									{
+										displayName: 'Field Name or ID',
+										name: 'field_id',
+										type: 'options',
+										description:
+											'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+										typeOptions: {
+											loadOptionsMethod: 'getExtraFields',
+											loadOptionsDependsOn: ['list'],
+										},
+										default: '',
+									},
+									{
+										displayName: 'Value',
+										name: 'value',
+										type: 'string',
+										default: '',
+									},
+								],
+							},
+						],
+					},
+					{
+						displayName: 'First Name',
+						name: 'first_name',
+						type: 'string',
+						default: '',
+						description: 'Name of a subscriber',
+					},
+					{
+						displayName: 'Last Name',
+						name: 'last_name',
+						type: 'string',
+						default: '',
+						description: 'Name of a subscriber',
+					},
+					{
+						displayName: 'Status',
+						name: 'status',
+						type: 'options',
+						options: [
+							{
+								name: 'Unconfirmed',
+								value: 'unconfirmed',
+							},
+							{
+								name: 'Active',
+								value: 'active',
+							},
+							{
+								name: 'Inactive',
+								value: 'inactive',
+							},
+							{
+								name: 'Removed',
+								value: 'removed',
+							},
+						],
+						default: 'active',
+						description: "Subscriber's current status",
+					},
+					{
+						displayName: 'Tag Names or IDs',
+						name: 'tagIds',
+						type: 'multiOptions',
+						typeOptions: {
+							loadOptionsMethod: 'getListTags',
+						},
+						default: [],
+						description:
+							'List of tag IDs to be added. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+					},
+				],
+			},
+			//--------------------
+			//----UPDATE MEMBER---
+			//--------------------
+			{
+				displayName: 'Update Fields',
+				name: 'updateFields',
+				type: 'collection',
+				placeholder: 'Add Field',
+				default: {},
+				displayOptions: {
+					show: {
+						operation: ['update'],
+					},
+				},
+				options: [
+					{
+						displayName: 'Birth Date',
+						name: 'birth_date',
+						type: 'dateTime',
+						default: '',
+						description: 'Birth date of subscriber',
+					},
+					{
+						displayName: 'Cellphone',
+						name: 'cellphone',
+						type: 'string',
+						default: '',
+						description: 'Cellphone of subscriber',
+					},
+					{
+						displayName: 'Email',
+						name: 'email',
+						type: 'string',
+						placeholder: 'name@email.com',
+						default: '',
+						description: 'Email address for subscriber',
+					},
+					{
+						displayName: 'Extra Fields',
+						name: 'extraFieldsUi',
+						type: 'fixedCollection',
+						placeholder: 'Add Field',
+						default: {},
+						typeOptions: {
+							multipleValues: true,
+						},
+						options: [
+							{
+								displayName: 'Extra Field',
+								name: 'extraFieldValues',
+								typeOptions: {
+									multipleValueButtonText: 'Add Field',
+								},
+								values: [
+									{
+										displayName: 'Field Name or ID',
+										name: 'field_id',
+										type: 'options',
+										description:
+											'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+										typeOptions: {
+											loadOptionsMethod: 'getExtraFields',
+											loadOptionsDependsOn: ['list'],
+										},
+										default: '',
+									},
+									{
+										displayName: 'Value',
+										name: 'value',
+										type: 'string',
+										default: '',
+									},
+								],
+							},
+						],
+					},
+					{
+						displayName: 'First Name',
+						name: 'first_name',
+						type: 'string',
+						default: '',
+						description: 'Name of subscriber',
+					},
+					{
+						displayName: 'Last Name',
+						name: 'last_name',
+						type: 'string',
+						default: '',
+						description: 'Name of subscriber',
+					},
+					{
+						displayName: 'Status',
+						name: 'status',
+						type: 'options',
+						options: [
+							{
+								name: 'Unconfirmed',
+								value: 'unconfirmed',
+							},
+							{
+								name: 'Active',
+								value: 'active',
+							},
+							{
+								name: 'Inactive',
+								value: 'inactive',
+							},
+							{
+								name: 'Removed',
+								value: 'removed',
+							},
+						],
+						default: 'active',
+						description: "Subscriber's current status",
+					},
+					{
+						displayName: 'Tag Names or IDs',
+						name: 'tagIds',
+						type: 'multiOptions',
+						typeOptions: {
+							loadOptionsMethod: 'getListTags',
+						},
+						default: [],
+						description:
+							'List of tag IDs to be added. Choose from the list, or specify IDs using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.',
+					},
+				],
+			},
+			{
+				displayName: 'By',
+				name: 'by',
+				type: 'options',
+				options: [
+					{
+						name: 'Contact ID',
+						value: 'id',
+					},
+					{
+						name: 'Email',
+						value: 'email',
+					},
+				],
+				displayOptions: {
+					show: {
+						operation: ['get'],
+						resource: ['contact'],
+					},
+				},
+				default: 'id',
+				description: 'Search by',
+			},
+			{
+				displayName: 'Contact ID',
+				name: 'contactId',
+				type: 'string',
+				displayOptions: {
+					show: {
+						resource: ['contact'],
+						operation: ['get'],
+						by: ['id'],
+					},
+				},
+				default: '',
+				description: 'Contact ID of the subscriber',
+			},
+			{
+				displayName: 'Email',
+				name: 'email',
+				type: 'string',
+				placeholder: 'name@email.com',
+				displayOptions: {
+					show: {
+						resource: ['contact'],
+						operation: ['get'],
+						by: ['email'],
+					},
+				},
+				default: '',
+				description: 'Email address for subscriber',
+			},
+			{
+				displayName: 'Return All',
+				name: 'returnAll',
+				type: 'boolean',
+				displayOptions: {
+					show: {
+						operation: ['getAll'],
+						resource: ['contact'],
+					},
+				},
+				default: false,
+				description: 'Whether to return all results or only up to a given limit',
+			},
+			{
+				displayName: 'Limit',
+				name: 'limit',
+				type: 'number',
+				displayOptions: {
+					show: {
+						operation: ['getAll'],
+						resource: ['contact'],
+						returnAll: [false],
+					},
+				},
+				typeOptions: {
+					minValue: 1,
+					maxValue: 500,
+				},
+				default: 100,
+				description: 'Max number of results to return',
+			},
+			{
+				displayName: 'Simplify',
+				name: 'simple',
+				type: 'boolean',
+				displayOptions: {
+					show: {
+						operation: ['get', 'getAll'],
+						resource: ['contact'],
+					},
+				},
+				default: true,
+				description:
+					'Whether to return a simplified version of the response instead of the raw data',
+			},
+		],
+	};
+
+	methods = {
+		loadOptions: {
+			async getLists(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const lists = await egoiApiRequestAllItems.call(this, 'items', 'GET', '/lists');
+				for (const list of lists) {
+					const listName = list.internal_name;
+					const listId = list.list_id;
+					returnData.push({
+						name: listName,
+						value: listId,
+					});
+				}
+				return returnData;
+			},
+
+			async getExtraFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const listId = this.getCurrentNodeParameter('list');
+				const extraFields = await egoiApiRequest.call(this, 'GET', `/lists/${listId}/fields`);
+				for (const field of extraFields) {
+					if (field.type === 'extra') {
+						const fieldName = field.name;
+						const fieldId = field.field_id;
+						returnData.push({
+							name: fieldName,
+							value: fieldId,
+						});
+					}
+				}
+				return returnData;
+			},
+
+			async getListTags(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const tagList = await egoiApiRequestAllItems.call(this, 'items', 'GET', '/tags');
+				for (const tag of tagList) {
+					const tagName = tag.name;
+					const tagId = tag.tag_id;
+					returnData.push({
+						name: tagName,
+						value: tagId,
+					});
+				}
+				return returnData;
+			},
+		},
+	};
+
+	async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
+		let responseData;
+		const returnData: INodeExecutionData[] = [];
+		const items = this.getInputData();
+		const length = items.length;
+		const operation = this.getNodeParameter('operation', 0);
+		const resource = this.getNodeParameter('resource', 0);
+		for (let i = 0; i < length; i++) {
+			try {
+				if (resource === 'contact') {
+					if (operation === 'create') {
+						const listId = this.getNodeParameter('list', i) as string;
+
+						const email = this.getNodeParameter('email', i) as string;
+
+						const resolveData = this.getNodeParameter('resolveData', i);
+
+						const additionalFields = this.getNodeParameter('additionalFields', i);
+
+						const body: ICreateMemberBody = {
+							base: {
+								email,
+							},
+							extra: [],
+						};
+
+						if (additionalFields.birth_date) {
+							additionalFields.birth_date = moment(additionalFields.birth_date as string).format(
+								'YYYY-MM-DD',
+							);
+						}
+
+						if (additionalFields.extraFieldsUi) {
+							const extraFields = (additionalFields.extraFieldsUi as IDataObject)
+								.extraFieldValues as IDataObject[];
+							if (extraFields) {
+								body.extra = extraFields as unknown as [];
+							}
+						}
+
+						Object.assign(body.base, additionalFields);
+
+						responseData = await egoiApiRequest.call(
+							this,
+							'POST',
+							`/lists/${listId}/contacts`,
+							body,
+						);
+
+						const contactId = responseData.contact_id;
+
+						if (additionalFields.tagIds) {
+							const tags = additionalFields.tagIds as string[];
+							for (const tag of tags) {
+								await egoiApiRequest.call(
+									this,
+									'POST',
+									`/lists/${listId}/contacts/actions/attach-tag`,
+									{ tag_id: tag, contacts: [contactId] },
+								);
+							}
+						}
+
+						if (resolveData) {
+							responseData = await egoiApiRequest.call(
+								this,
+								'GET',
+								`/lists/${listId}/contacts/${contactId}`,
+							);
+						}
+					}
+
+					if (operation === 'get') {
+						const listId = this.getNodeParameter('list', i) as string;
+
+						const simple = this.getNodeParameter('simple', i) as boolean;
+
+						const by = this.getNodeParameter('by', 0) as string;
+
+						let endpoint = '';
+
+						if (by === 'id') {
+							const contactId = this.getNodeParameter('contactId', i) as string;
+							endpoint = `/lists/${listId}/contacts/${contactId}`;
+						} else {
+							const email = this.getNodeParameter('email', i) as string;
+							endpoint = `/lists/${listId}/contacts?email=${email}`;
+						}
+
+						responseData = await egoiApiRequest.call(this, 'GET', endpoint, {});
+
+						if (responseData.items) {
+							responseData = responseData.items;
+						}
+
+						if (simple) {
+							const data = (await simplify.call(this, [responseData], listId))[0];
+
+							responseData = {
+								...data,
+								email_stats: responseData.email_stats,
+								sms_stats: responseData.sms_stats,
+								push_stats: responseData.push_stats,
+								webpush_stats: responseData.webpush_stats,
+								voice_stats: responseData.voice_stats,
+							};
+						}
+					}
+
+					if (operation === 'getAll') {
+						const listId = this.getNodeParameter('list', i) as string;
+
+						const returnAll = this.getNodeParameter('returnAll', 0);
+
+						const simple = this.getNodeParameter('simple', i) as boolean;
+
+						if (returnAll) {
+							responseData = await egoiApiRequestAllItems.call(
+								this,
+								'items',
+								'GET',
+								`/lists/${listId}/contacts`,
+								{},
+							);
+						} else {
+							const limit = this.getNodeParameter('limit', i);
+
+							responseData = await egoiApiRequest.call(
+								this,
+								'GET',
+								`/lists/${listId}/contacts`,
+								{},
+								{ limit },
+							);
+
+							responseData = responseData.items;
+						}
+
+						if (simple) {
+							responseData = await simplify.call(this, responseData, listId);
+						}
+					}
+
+					if (operation === 'update') {
+						const listId = this.getNodeParameter('list', i) as string;
+						const contactId = this.getNodeParameter('contactId', i) as string;
+						const resolveData = this.getNodeParameter('resolveData', i);
+
+						const updateFields = this.getNodeParameter('updateFields', i);
+						const body: ICreateMemberBody = {
+							base: {},
+							extra: [],
+						};
+
+						if (updateFields.birth_date) {
+							updateFields.birth_date = moment(updateFields.birth_date as string).format(
+								'YYYY-MM-DD',
+							);
+						}
+
+						if (updateFields.extraFieldsUi) {
+							const extraFields = (updateFields.extraFieldsUi as IDataObject)
+								.extraFieldValues as IDataObject[];
+							if (extraFields) {
+								body.extra = extraFields as unknown as [];
+							}
+						}
+
+						Object.assign(body.base, updateFields);
+
+						responseData = await egoiApiRequest.call(
+							this,
+							'PATCH',
+							`/lists/${listId}/contacts/${contactId}`,
+							body,
+						);
+
+						if (updateFields.tagIds) {
+							const tags = updateFields.tagIds as string[];
+							for (const tag of tags) {
+								await egoiApiRequest.call(
+									this,
+									'POST',
+									`/lists/${listId}/contacts/actions/attach-tag`,
+									{ tag_id: tag, contacts: [contactId] },
+								);
+							}
+						}
+
+						if (resolveData) {
+							responseData = await egoiApiRequest.call(
+								this,
+								'GET',
+								`/lists/${listId}/contacts/${contactId}`,
+							);
+						}
+					}
+				}
+			} catch (error) {
+				if (!this.continueOnFail()) {
+					throw error;
+				} else {
+					// Return the actual reason as error
+					const executionErrorData = this.helpers.constructExecutionMetaData(
+						this.helpers.returnJsonArray({ error: error.message }),
+						{ itemData: { item: i } },
+					);
+					returnData.push(...executionErrorData);
+					continue;
+				}
+			}
+
+			const executionData = this.helpers.constructExecutionMetaData(
+				this.helpers.returnJsonArray(responseData as IDataObject[]),
+				{ itemData: { item: i } },
+			);
+			returnData.push(...executionData);
+		}
+		return [returnData];
+	}
+}

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

@@ -0,0 +1,116 @@
+import type {
+	IDataObject,
+	IExecuteFunctions,
+	IHookFunctions,
+	ILoadOptionsFunctions,
+	JsonObject,
+	IRequestOptions,
+	IHttpRequestMethods,
+} from 'n8n-workflow';
+import { NodeApiError } from 'n8n-workflow';
+
+interface IContact {
+	tags: [];
+	base: IDataObject;
+	extra: IDataObject[];
+}
+
+const fieldCache: {
+	[key: string]: IDataObject[];
+} = {};
+
+export async function egoiApiRequest(
+	this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
+	method: IHttpRequestMethods,
+	endpoint: string,
+
+	body: any = {},
+	qs: IDataObject = {},
+	_headers?: object,
+): Promise<any> {
+	const credentials = await this.getCredentials('egoiApi');
+
+	const options: IRequestOptions = {
+		headers: {
+			accept: 'application/json',
+			Apikey: `${credentials.apiKey}`,
+		},
+		method,
+		qs,
+		body,
+		url: `https://api.egoiapp.com${endpoint}`,
+		json: true,
+	};
+
+	if (Object.keys(body as IDataObject).length === 0) {
+		delete options.body;
+	}
+
+	try {
+		return await this.helpers.request(options);
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error as JsonObject);
+	}
+}
+
+export async function getFields(this: IExecuteFunctions, listId: string) {
+	if (fieldCache[listId]) {
+		return fieldCache[listId];
+	}
+	fieldCache[listId] = await egoiApiRequest.call(this, 'GET', `/lists/${listId}/fields`);
+	return fieldCache[listId];
+}
+
+export async function egoiApiRequestAllItems(
+	this: IExecuteFunctions | ILoadOptionsFunctions,
+	propertyName: string,
+	method: IHttpRequestMethods,
+	endpoint: string,
+
+	body: any = {},
+	query: IDataObject = {},
+): Promise<any> {
+	const returnData: IDataObject[] = [];
+
+	let responseData;
+
+	query.offset = 0;
+	query.count = 500;
+
+	do {
+		responseData = await egoiApiRequest.call(this, method, endpoint, body, query);
+		returnData.push.apply(returnData, responseData[propertyName] as IDataObject[]);
+		query.offset += query.count;
+	} while (responseData[propertyName] && responseData[propertyName].length !== 0);
+
+	return returnData;
+}
+
+export async function simplify(this: IExecuteFunctions, contacts: IContact[], listId: string) {
+	let fields = await getFields.call(this, listId);
+
+	fields = fields.filter((element: IDataObject) => element.type === 'extra');
+	const fieldsKeyValue: IDataObject = {};
+	for (const field of fields) {
+		fieldsKeyValue[field.field_id as string] = field.name;
+	}
+
+	const data: IDataObject[] = [];
+
+	for (const contact of contacts) {
+		const extras = contact.extra.reduce(
+			(accumulator: IDataObject, currentValue: IDataObject): any => {
+				const key = fieldsKeyValue[currentValue.field_id as string] as string;
+				return { [key]: currentValue.value, ...accumulator };
+			},
+			{},
+		);
+		data.push({
+			...contact.base,
+			...extras,
+			tags: contact.tags,
+		});
+	}
+
+	return data;
+}

packages/nodes-base/nodes/Egoi/Interfaces.ts

@@ -0,0 +1,11 @@
+export interface ICreateMemberBody {
+	base: {
+		email?: string;
+		first_name?: string;
+		last_name?: string;
+		cellphone?: string;
+		birth_date?: string;
+		subscription_status?: string;
+	};
+	extra: [];
+}

packages/nodes-base/nodes/Egoi/egoi.svg

@@ -0,0 +1,5 @@
+<svg width="40" height="40" viewBox="0 0 40 40" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M26.7779 5.29164L13.217 5L12.6915 34.1699L17.7112 29.1886L27.7282 28.0779L26.7779 5.29164Z" fill="#00AEDA"/>
+<path d="M11.0471 5.23558L11.8074 28.4594C8.69941 29.0315 2.02514 28.0555 0.247612 19.5513C-1.52998 11.0471 6.69826 6.45849 11.0471 5.23558Z" fill="#00AEDA"/>
+<path d="M28.7656 27.6852L28.5085 9.34181C32.8685 10.4862 41.2421 14.4353 39.8446 21.0883C38.4471 27.7413 31.8735 28.2574 28.7656 27.6852Z" fill="#00AEDA"/>
+</svg>