mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 18:12:04 +00:00
✨ Add Lemlist node (#1506)
* 🎉 Register node and credentials * ⚡ Add credentials file * 🎨 Add SVG icon * ⚡ Add generic functions file * ⚡ Add preliminary node stub * ⚡ Add resource description stubs * ⚡ Extract get CSV from getAll * ⚡ Implement lead:create * ⚡ Implement all lead operations * ⚡ Implement unsubscribe:create and delete * ⚡ Preload campaigns * 🔥 Remove logging * 🔥 Remove operation per feedback * 🎨 Prettify error message * ⚡ Implement unsubscribe:getAll * ⚡ Add trigger and small improvements * ⚡ Minor improvement and fixes Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Iván Ovejero
337
packages/nodes-base/nodes/Lemlist/Lemlist.node.ts
Normal file
337
packages/nodes-base/nodes/Lemlist/Lemlist.node.ts
Normal file
@@ -0,0 +1,337 @@
|
||||
import {
|
||||
IExecuteFunctions,
|
||||
} from 'n8n-core';
|
||||
|
||||
import {
|
||||
IDataObject,
|
||||
ILoadOptionsFunctions,
|
||||
INodeType,
|
||||
INodeTypeDescription,
|
||||
} from 'n8n-workflow';
|
||||
|
||||
import {
|
||||
activityFields,
|
||||
activityOperations,
|
||||
campaignFields,
|
||||
campaignOperations,
|
||||
leadFields,
|
||||
leadOperations,
|
||||
teamFields,
|
||||
teamOperations,
|
||||
unsubscribeFields,
|
||||
unsubscribeOperations,
|
||||
} from './descriptions';
|
||||
|
||||
import {
|
||||
lemlistApiRequest,
|
||||
lemlistApiRequestAllItems,
|
||||
} from './GenericFunctions';
|
||||
|
||||
import {
|
||||
isEmpty,
|
||||
omit,
|
||||
} from 'lodash';
|
||||
|
||||
export class Lemlist implements INodeType {
|
||||
description: INodeTypeDescription = {
|
||||
displayName: 'Lemlist',
|
||||
name: 'lemlist',
|
||||
icon: 'file:lemlist.svg',
|
||||
group: ['transform'],
|
||||
version: 1,
|
||||
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
||||
description: 'Consume the Lemlist API',
|
||||
defaults: {
|
||||
name: 'Lemlist',
|
||||
color: '#4d19ff',
|
||||
},
|
||||
inputs: ['main'],
|
||||
outputs: ['main'],
|
||||
credentials: [
|
||||
{
|
||||
name: 'lemlistApi',
|
||||
required: true,
|
||||
},
|
||||
],
|
||||
properties: [
|
||||
{
|
||||
displayName: 'Resource',
|
||||
name: 'resource',
|
||||
type: 'options',
|
||||
options: [
|
||||
{
|
||||
name: 'Activity',
|
||||
value: 'activity',
|
||||
},
|
||||
{
|
||||
name: 'Campaign',
|
||||
value: 'campaign',
|
||||
},
|
||||
{
|
||||
name: 'Lead',
|
||||
value: 'lead',
|
||||
},
|
||||
{
|
||||
name: 'Team',
|
||||
value: 'team',
|
||||
},
|
||||
{
|
||||
name: 'Unsubscribes',
|
||||
value: 'unsubscribe',
|
||||
},
|
||||
],
|
||||
default: 'activity',
|
||||
description: 'Resource to consume',
|
||||
},
|
||||
...activityOperations,
|
||||
...activityFields,
|
||||
...campaignOperations,
|
||||
...campaignFields,
|
||||
...leadOperations,
|
||||
...leadFields,
|
||||
...teamOperations,
|
||||
...teamFields,
|
||||
...unsubscribeOperations,
|
||||
...unsubscribeFields,
|
||||
],
|
||||
};
|
||||
|
||||
methods = {
|
||||
loadOptions: {
|
||||
async getCampaigns(this: ILoadOptionsFunctions) {
|
||||
const campaigns = await lemlistApiRequest.call(this, 'GET', '/campaigns');
|
||||
return campaigns.map(({ _id, name }: { _id: string, name: string }) => ({
|
||||
name,
|
||||
value: _id,
|
||||
}));
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
async execute(this: IExecuteFunctions) {
|
||||
const items = this.getInputData();
|
||||
|
||||
const resource = this.getNodeParameter('resource', 0) as string;
|
||||
const operation = this.getNodeParameter('operation', 0) as string;
|
||||
|
||||
let responseData;
|
||||
const returnData: IDataObject[] = [];
|
||||
|
||||
for (let i = 0; i < items.length; i++) {
|
||||
|
||||
try {
|
||||
|
||||
if (resource === 'activity') {
|
||||
|
||||
// *********************************************************************
|
||||
// activity
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// activity: getAll
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#activities
|
||||
|
||||
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
||||
|
||||
const qs = {} as IDataObject;
|
||||
const filters = this.getNodeParameter('filters', i);
|
||||
|
||||
if (!isEmpty(filters)) {
|
||||
Object.assign(qs, filters);
|
||||
}
|
||||
|
||||
responseData = await lemlistApiRequest.call(this, 'GET', '/activities', {}, qs);
|
||||
|
||||
if (returnAll === false) {
|
||||
const limit = this.getNodeParameter('limit', 0) as number;
|
||||
responseData = responseData.slice(0, limit);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'campaign') {
|
||||
|
||||
// *********************************************************************
|
||||
// campaign
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// campaign: getAll
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#list-all-campaigns
|
||||
|
||||
responseData = await lemlistApiRequest.call(this, 'GET', '/campaigns');
|
||||
|
||||
const returnAll = this.getNodeParameter('returnAll', i);
|
||||
|
||||
if (!returnAll) {
|
||||
const limit = this.getNodeParameter('limit', i);
|
||||
responseData = responseData.slice(0, limit);
|
||||
}
|
||||
}
|
||||
|
||||
} else if (resource === 'lead') {
|
||||
|
||||
// *********************************************************************
|
||||
// lead
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'create') {
|
||||
|
||||
// ----------------------------------
|
||||
// lead: create
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#add-a-lead-in-a-campaign
|
||||
|
||||
const qs = {} as IDataObject;
|
||||
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
||||
|
||||
if (additionalFields.deduplicate !== undefined) {
|
||||
qs.deduplicate = additionalFields.deduplicate;
|
||||
}
|
||||
|
||||
const body = {} as IDataObject;
|
||||
|
||||
const remainingAdditionalFields = omit(additionalFields, 'deduplicate');
|
||||
|
||||
if (!isEmpty(remainingAdditionalFields)) {
|
||||
Object.assign(body, remainingAdditionalFields);
|
||||
}
|
||||
|
||||
const campaignId = this.getNodeParameter('campaignId', i);
|
||||
const email = this.getNodeParameter('email', i);
|
||||
const endpoint = `/campaigns/${campaignId}/leads/${email}`;
|
||||
|
||||
responseData = await lemlistApiRequest.call(this, 'POST', endpoint, body, qs);
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
|
||||
// ----------------------------------
|
||||
// lead: delete
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#delete-a-lead-from-a-campaign
|
||||
|
||||
const campaignId = this.getNodeParameter('campaignId', i);
|
||||
const email = this.getNodeParameter('email', i);
|
||||
const endpoint = `/campaigns/${campaignId}/leads/${email}`;
|
||||
responseData = await lemlistApiRequest.call(this, 'DELETE', endpoint, {}, { action: 'remove' });
|
||||
|
||||
} else if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// lead: get
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#get-a-specific-lead-by-email
|
||||
|
||||
const email = this.getNodeParameter('email', i);
|
||||
responseData = await lemlistApiRequest.call(this, 'GET', `/leads/${email}`);
|
||||
|
||||
} else if (operation === 'unsubscribe') {
|
||||
|
||||
// ----------------------------------
|
||||
// lead: unsubscribe
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#unsubscribe-a-lead-from-a-campaign
|
||||
|
||||
const campaignId = this.getNodeParameter('campaignId', i);
|
||||
const email = this.getNodeParameter('email', i);
|
||||
const endpoint = `/campaigns/${campaignId}/leads/${email}`;
|
||||
responseData = await lemlistApiRequest.call(this, 'DELETE', endpoint);
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'team') {
|
||||
|
||||
// *********************************************************************
|
||||
// team
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'get') {
|
||||
|
||||
// ----------------------------------
|
||||
// team: get
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#team
|
||||
|
||||
responseData = await lemlistApiRequest.call(this, 'GET', '/team');
|
||||
|
||||
}
|
||||
|
||||
} else if (resource === 'unsubscribe') {
|
||||
|
||||
// *********************************************************************
|
||||
// unsubscribe
|
||||
// *********************************************************************
|
||||
|
||||
if (operation === 'add') {
|
||||
|
||||
// ----------------------------------
|
||||
// unsubscribe: Add
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#add-an-email-address-in-the-unsubscribes
|
||||
|
||||
const email = this.getNodeParameter('email', i);
|
||||
responseData = await lemlistApiRequest.call(this, 'POST', `/unsubscribes/${email}`);
|
||||
|
||||
} else if (operation === 'delete') {
|
||||
|
||||
// ----------------------------------
|
||||
// unsubscribe: delete
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#delete-an-email-address-from-the-unsubscribes
|
||||
|
||||
const email = this.getNodeParameter('email', i);
|
||||
responseData = await lemlistApiRequest.call(this, 'DELETE', `/unsubscribes/${email}`);
|
||||
|
||||
} else if (operation === 'getAll') {
|
||||
|
||||
// ----------------------------------
|
||||
// unsubscribe: getAll
|
||||
// ----------------------------------
|
||||
|
||||
// https://developer.lemlist.com/#list-all-unsubscribes
|
||||
|
||||
const returnAll = this.getNodeParameter('returnAll', i);
|
||||
|
||||
if (returnAll) {
|
||||
responseData = await lemlistApiRequestAllItems.call(this, 'GET', '/unsubscribes');
|
||||
} else {
|
||||
const qs = {
|
||||
limit: this.getNodeParameter('limit', i) as number,
|
||||
};
|
||||
responseData = await lemlistApiRequest.call(this, 'GET', '/unsubscribes', {}, qs);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
if (this.continueOnFail()) {
|
||||
returnData.push({ error: error.toString() });
|
||||
continue;
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
|
||||
Array.isArray(responseData)
|
||||
? returnData.push(...responseData)
|
||||
: returnData.push(responseData);
|
||||
}
|
||||
|
||||
return [this.helpers.returnJsonArray(returnData)];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user