feat(Lemlist Node): Add V2 to support more API operations (#10615)

This commit is contained in:
Shireen Missi
2024-09-10 16:26:55 +01:00
committed by GitHub
parent 1b04be1240
commit 20b1cf2b75
18 changed files with 1939 additions and 315 deletions

View File

@@ -0,0 +1,322 @@
/* eslint-disable n8n-nodes-base/node-filename-against-convention */
import {
type IExecuteFunctions,
type IDataObject,
type ILoadOptionsFunctions,
type INodeExecutionData,
type INodeType,
type INodeTypeDescription,
type INodeTypeBaseDescription,
NodeConnectionType,
} from 'n8n-workflow';
import isEmpty from 'lodash/isEmpty';
import omit from 'lodash/omit';
import { lemlistApiRequest, lemlistApiRequestAllItems } from '../GenericFunctions';
import {
activityFields,
activityOperations,
campaignFields,
campaignOperations,
leadFields,
leadOperations,
teamFields,
teamOperations,
unsubscribeFields,
unsubscribeOperations,
} from './descriptions';
const versionDescription: 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',
},
inputs: [NodeConnectionType.Main],
outputs: [NodeConnectionType.Main],
credentials: [
{
name: 'lemlistApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Activity',
value: 'activity',
},
{
name: 'Campaign',
value: 'campaign',
},
{
name: 'Lead',
value: 'lead',
},
{
name: 'Team',
value: 'team',
},
{
name: 'Unsubscribe',
value: 'unsubscribe',
},
],
default: 'activity',
},
...activityOperations,
...activityFields,
...campaignOperations,
...campaignFields,
...leadOperations,
...leadFields,
...teamOperations,
...teamFields,
...unsubscribeOperations,
...unsubscribeFields,
],
};
export class LemlistV1 implements INodeType {
description: INodeTypeDescription;
constructor(baseDescription: INodeTypeBaseDescription) {
this.description = {
...baseDescription,
...versionDescription,
};
}
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);
const operation = this.getNodeParameter('operation', 0);
let responseData;
const returnData: INodeExecutionData[] = [];
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', i);
const qs = {} as IDataObject;
const filters = this.getNodeParameter('filters', i);
if (!isEmpty(filters)) {
Object.assign(qs, filters);
}
if (returnAll) {
responseData = await lemlistApiRequestAllItems.call(this, 'GET', '/activities', qs);
} else {
qs.limit = this.getNodeParameter('limit', i);
responseData = await lemlistApiRequest.call(this, 'GET', '/activities', {}, qs);
}
}
} else if (resource === 'campaign') {
// *********************************************************************
// campaign
// *********************************************************************
if (operation === 'getAll') {
// ----------------------------------
// campaign: getAll
// ----------------------------------
// https://developer.lemlist.com/#list-all-campaigns
const returnAll = this.getNodeParameter('returnAll', i);
if (returnAll) {
responseData = await lemlistApiRequestAllItems.call(this, 'GET', '/campaigns', {});
} else {
const qs = {
limit: this.getNodeParameter('limit', i),
};
responseData = await lemlistApiRequest.call(this, 'GET', '/campaigns', {}, qs);
}
}
} 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);
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),
};
responseData = await lemlistApiRequest.call(this, 'GET', '/unsubscribes', {}, qs);
}
}
}
} catch (error) {
if (this.continueOnFail()) {
const executionErrorData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray({ error: error.message }),
{ itemData: { item: i } },
);
returnData.push(...executionErrorData);
continue;
}
throw error;
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject),
{ itemData: { item: i } },
);
returnData.push(...executionData);
}
return [returnData];
}
}

View File

@@ -0,0 +1,123 @@
import type { INodeProperties } from 'n8n-workflow';
export const activityOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'getAll',
options: [
{
name: 'Get Many',
value: 'getAll',
action: 'Get many activities',
},
],
displayOptions: {
show: {
resource: ['activity'],
},
},
},
];
export const activityFields: INodeProperties[] = [
// ----------------------------------
// activity: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: ['activity'],
operation: ['getAll'],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: ['activity'],
operation: ['getAll'],
returnAll: [false],
},
},
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
default: {},
displayOptions: {
show: {
resource: ['activity'],
operation: ['getAll'],
},
},
options: [
{
displayName: 'Campaign Name or ID',
name: 'campaignId',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
description:
'ID of the campaign to retrieve activity for. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
},
{
displayName: 'Type',
name: 'type',
type: 'options',
default: 'emailsOpened',
description: 'Type of activity to retrieve',
options: [
{
name: 'Emails Bounced',
value: 'emailsBounced',
},
{
name: 'Emails Clicked',
value: 'emailsClicked',
},
{
name: 'Emails Opened',
value: 'emailsOpened',
},
{
name: 'Emails Replied',
value: 'emailsReplied',
},
{
name: 'Emails Send Failed',
value: 'emailsSendFailed',
},
{
name: 'Emails Sent',
value: 'emailsSent',
},
{
name: 'Emails Unsubscribed',
value: 'emailsUnsubscribed',
},
],
},
],
},
];

View File

@@ -0,0 +1,60 @@
import type { INodeProperties } from 'n8n-workflow';
export const campaignOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'getAll',
options: [
{
name: 'Get Many',
value: 'getAll',
action: 'Get many campaigns',
},
],
displayOptions: {
show: {
resource: ['campaign'],
},
},
},
];
export const campaignFields: INodeProperties[] = [
// ----------------------------------
// campaign: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: ['campaign'],
operation: ['getAll'],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: ['campaign'],
operation: ['getAll'],
returnAll: [false],
},
},
},
];

View File

@@ -0,0 +1,238 @@
import type { INodeProperties } from 'n8n-workflow';
export const leadOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'create',
options: [
{
name: 'Create',
value: 'create',
action: 'Create a lead',
},
{
name: 'Delete',
value: 'delete',
action: 'Delete a lead',
},
{
name: 'Get',
value: 'get',
action: 'Get a lead',
},
{
name: 'Unsubscribe',
value: 'unsubscribe',
action: 'Unsubscribe a lead',
},
],
displayOptions: {
show: {
resource: ['lead'],
},
},
},
];
export const leadFields: INodeProperties[] = [
// ----------------------------------
// lead: create
// ----------------------------------
{
displayName: 'Campaign Name or ID',
name: 'campaignId',
type: 'options',
required: true,
default: [],
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
description:
'ID of the campaign to create the lead under. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
},
},
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
description: 'Email of the lead to create',
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: ['lead'],
operation: ['create'],
},
},
options: [
{
displayName: 'Company Name',
name: 'companyName',
type: 'string',
default: '',
description: 'Company name of the lead to create',
},
{
displayName: 'Deduplicate',
name: 'deduplicate',
type: 'boolean',
default: false,
description:
'Whether to do not insert if this email is already present in another campaign',
},
{
displayName: 'First Name',
name: 'firstName',
type: 'string',
default: '',
description: 'First name of the lead to create',
},
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
default: '',
description: 'Last name of the lead to create',
},
{
displayName: 'Icebreaker',
name: 'icebreaker',
type: 'string',
default: '',
description: 'Icebreaker of the lead to create',
},
{
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
description: 'Phone number of the lead to create',
},
{
displayName: 'Picture URL',
name: 'picture',
type: 'string',
default: '',
description: 'Picture URL of the lead to create',
},
{
displayName: 'LinkedIn URL',
name: 'linkedinUrl',
type: 'string',
default: '',
description: 'LinkedIn URL of the lead to create',
},
],
},
// ----------------------------------
// lead: delete
// ----------------------------------
{
displayName: 'Campaign Name or ID',
name: 'campaignId',
type: 'options',
required: true,
default: [],
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
description:
'ID of the campaign to remove the lead from. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
displayOptions: {
show: {
resource: ['lead'],
operation: ['delete'],
},
},
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
description: 'Email of the lead to delete',
displayOptions: {
show: {
resource: ['lead'],
operation: ['delete'],
},
},
},
// ----------------------------------
// lead: get
// ----------------------------------
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
description: 'Email of the lead to retrieve',
displayOptions: {
show: {
resource: ['lead'],
operation: ['get'],
},
},
},
// ----------------------------------
// lead: unsubscribe
// ----------------------------------
{
displayName: 'Campaign Name or ID',
name: 'campaignId',
type: 'options',
required: true,
default: [],
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
description:
'ID of the campaign to unsubscribe the lead from. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>.',
displayOptions: {
show: {
resource: ['lead'],
operation: ['unsubscribe'],
},
},
},
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
description: 'Email of the lead to unsubscribe',
displayOptions: {
show: {
resource: ['lead'],
operation: ['unsubscribe'],
},
},
},
];

View File

@@ -0,0 +1,29 @@
import type { INodeProperties } from 'n8n-workflow';
export const teamOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'get',
options: [
{
name: 'Get',
value: 'get',
action: 'Get a team',
},
],
displayOptions: {
show: {
resource: ['team'],
},
},
},
];
export const teamFields: INodeProperties[] = [
// ----------------------------------
// team: get
// ----------------------------------
];

View File

@@ -0,0 +1,106 @@
import type { INodeProperties } from 'n8n-workflow';
export const unsubscribeOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
default: 'add',
options: [
{
name: 'Add',
value: 'add',
action: 'Add an email to an unsubscribe list',
},
{
name: 'Delete',
value: 'delete',
action: 'Delete an email from an unsubscribe list',
},
{
name: 'Get Many',
value: 'getAll',
action: 'Get many unsubscribed emails',
},
],
displayOptions: {
show: {
resource: ['unsubscribe'],
},
},
},
];
export const unsubscribeFields: INodeProperties[] = [
// ----------------------------------
// unsubscribe: add
// ----------------------------------
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
description: 'Email to add to the unsubscribes',
displayOptions: {
show: {
resource: ['unsubscribe'],
operation: ['add'],
},
},
},
// ----------------------------------
// unsubscribe: delete
// ----------------------------------
{
displayName: 'Email',
name: 'email',
type: 'string',
placeholder: 'name@email.com',
default: '',
description: 'Email to delete from the unsubscribes',
displayOptions: {
show: {
resource: ['unsubscribe'],
operation: ['delete'],
},
},
},
// ----------------------------------
// unsubscribe: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: ['unsubscribe'],
operation: ['getAll'],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 5,
description: 'Max number of results to return',
typeOptions: {
minValue: 1,
maxValue: 1000,
},
displayOptions: {
show: {
resource: ['unsubscribe'],
operation: ['getAll'],
returnAll: [false],
},
},
},
];

View File

@@ -0,0 +1,5 @@
export * from './ActivityDescription';
export * from './CampaignDescription';
export * from './LeadDescription';
export * from './TeamDescription';
export * from './UnsubscribeDescription';