mirror of
https://github.com/n8n-io/n8n.git
synced 2024-09-21 07:17:38 -07:00
b03e358a12
* 👕 Enable `consistent-type-imports` for nodes-base
* 👕 Apply to nodes-base
* ⏪ Undo unrelated changes
* 🚚 Move to `.eslintrc.js` in nodes-base
* ⏪ Revert "Enable `consistent-type-imports` for nodes-base"
This reverts commit 529ad72b05.
* 👕 Fix severity
671 lines
19 KiB
TypeScript
671 lines
19 KiB
TypeScript
import type { IExecuteFunctions } from 'n8n-core';
|
|
|
|
import type {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
} from 'n8n-workflow';
|
|
import { NodeOperationError } from 'n8n-workflow';
|
|
|
|
import { listFields, listOperations } from './ListDescription';
|
|
|
|
import { contactFields, contactOperations } from './ContactDescription';
|
|
|
|
import type { SendMailBody } from './MailDescription';
|
|
import { mailFields, mailOperations } from './MailDescription';
|
|
|
|
import { sendGridApiRequest, sendGridApiRequestAllItems } from './GenericFunctions';
|
|
|
|
import moment from 'moment-timezone';
|
|
|
|
export class SendGrid implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'SendGrid',
|
|
name: 'sendGrid',
|
|
icon: 'file:sendGrid.svg',
|
|
group: ['transform'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ":" + $parameter["resource"]}}',
|
|
description: 'Consume SendGrid API',
|
|
defaults: {
|
|
name: 'SendGrid',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'sendGridApi',
|
|
required: true,
|
|
},
|
|
],
|
|
properties: [
|
|
// Node properties which the user gets displayed and
|
|
// can change on the node.
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
options: [
|
|
{
|
|
name: 'Contact',
|
|
value: 'contact',
|
|
},
|
|
{
|
|
name: 'List',
|
|
value: 'list',
|
|
},
|
|
{
|
|
name: 'Mail',
|
|
value: 'mail',
|
|
},
|
|
],
|
|
default: 'list',
|
|
required: true,
|
|
},
|
|
...listOperations,
|
|
...listFields,
|
|
...contactOperations,
|
|
...contactFields,
|
|
...mailOperations,
|
|
...mailFields,
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
// Get custom fields to display to user so that they can select them easily
|
|
async getCustomFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const { custom_fields } = await sendGridApiRequest.call(
|
|
this,
|
|
'/marketing/field_definitions',
|
|
'GET',
|
|
{},
|
|
{},
|
|
);
|
|
if (custom_fields !== undefined) {
|
|
for (const customField of custom_fields) {
|
|
returnData.push({
|
|
name: customField.name,
|
|
value: customField.id,
|
|
});
|
|
}
|
|
}
|
|
return returnData;
|
|
},
|
|
// Get lists to display to user so that they can select them easily
|
|
async getListIds(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const lists = await sendGridApiRequestAllItems.call(
|
|
this,
|
|
'/marketing/lists',
|
|
'GET',
|
|
'result',
|
|
{},
|
|
{},
|
|
);
|
|
for (const list of lists) {
|
|
returnData.push({
|
|
name: list.name,
|
|
value: list.id,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
async getTemplateIds(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
|
|
const responseData = await sendGridApiRequest.call(
|
|
this,
|
|
'/templates',
|
|
'GET',
|
|
{},
|
|
{ generations: 'dynamic' },
|
|
);
|
|
return responseData.templates.map(({ id, name }: { id: string; name: string }) => ({
|
|
name,
|
|
value: id,
|
|
}));
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const length = items.length;
|
|
const qs: IDataObject = {};
|
|
let responseData;
|
|
const timezone = this.getTimezone();
|
|
const returnData: INodeExecutionData[] = [];
|
|
const resource = this.getNodeParameter('resource', 0);
|
|
const operation = this.getNodeParameter('operation', 0);
|
|
// https://sendgrid.com/docs/api-reference/
|
|
if (resource === 'contact') {
|
|
if (operation === 'getAll') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const returnAll = this.getNodeParameter('returnAll', i);
|
|
const filters = this.getNodeParameter('filters', i);
|
|
let endpoint = '/marketing/contacts';
|
|
let method = 'GET';
|
|
const body: IDataObject = {};
|
|
if (filters.query && filters.query !== '') {
|
|
endpoint = '/marketing/contacts/search';
|
|
method = 'POST';
|
|
Object.assign(body, { query: filters.query });
|
|
}
|
|
responseData = await sendGridApiRequestAllItems.call(
|
|
this,
|
|
endpoint,
|
|
method,
|
|
'result',
|
|
body,
|
|
qs,
|
|
);
|
|
if (!returnAll) {
|
|
const limit = this.getNodeParameter('limit', i);
|
|
responseData = responseData.splice(0, limit);
|
|
}
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'get') {
|
|
const by = this.getNodeParameter('by', 0) as string;
|
|
let endpoint;
|
|
let method;
|
|
const body: IDataObject = {};
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
if (by === 'id') {
|
|
method = 'GET';
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
endpoint = `/marketing/contacts/${contactId}`;
|
|
} else {
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
endpoint = '/marketing/contacts/search';
|
|
method = 'POST';
|
|
Object.assign(body, { query: `email LIKE '${email}' ` });
|
|
}
|
|
responseData = await sendGridApiRequest.call(this, endpoint, method, body, qs);
|
|
responseData = responseData.result || responseData;
|
|
if (Array.isArray(responseData)) {
|
|
responseData = responseData[0];
|
|
}
|
|
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'upsert') {
|
|
try {
|
|
const contacts = [];
|
|
let lists;
|
|
for (let i = 0; i < length; i++) {
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
const additionalFields = this.getNodeParameter('additionalFields', i);
|
|
const contact: IDataObject = {
|
|
email,
|
|
};
|
|
if (additionalFields.addressUi) {
|
|
const addressValues = (additionalFields.addressUi as IDataObject)
|
|
.addressValues as IDataObject;
|
|
const addressLine1 = addressValues.address1 as string;
|
|
const addressLine2 = addressValues.address2 as string;
|
|
if (addressLine2) {
|
|
Object.assign(contact, { address_line_2: addressLine2 });
|
|
}
|
|
Object.assign(contact, { address_line_1: addressLine1 });
|
|
}
|
|
if (additionalFields.city) {
|
|
const city = additionalFields.city as string;
|
|
Object.assign(contact, { city });
|
|
}
|
|
if (additionalFields.country) {
|
|
const country = additionalFields.country as string;
|
|
Object.assign(contact, { country });
|
|
}
|
|
if (additionalFields.firstName) {
|
|
const firstName = additionalFields.firstName as string;
|
|
Object.assign(contact, { first_name: firstName });
|
|
}
|
|
if (additionalFields.lastName) {
|
|
const lastName = additionalFields.lastName as string;
|
|
Object.assign(contact, { last_name: lastName });
|
|
}
|
|
if (additionalFields.postalCode) {
|
|
const postalCode = additionalFields.postalCode as string;
|
|
Object.assign(contact, { postal_code: postalCode });
|
|
}
|
|
if (additionalFields.stateProvinceRegion) {
|
|
const stateProvinceRegion = additionalFields.stateProvinceRegion as string;
|
|
Object.assign(contact, { state_province_region: stateProvinceRegion });
|
|
}
|
|
if (additionalFields.alternateEmails) {
|
|
const alternateEmails = (additionalFields.alternateEmails as string)
|
|
.split(',')
|
|
.filter((mail) => !!mail);
|
|
if (alternateEmails.length !== 0) {
|
|
Object.assign(contact, { alternate_emails: alternateEmails });
|
|
}
|
|
}
|
|
if (additionalFields.listIdsUi) {
|
|
const listIdValues = (additionalFields.listIdsUi as IDataObject)
|
|
.listIdValues as IDataObject;
|
|
const listIds = listIdValues.listIds as IDataObject[];
|
|
lists = listIds;
|
|
}
|
|
if (additionalFields.customFieldsUi) {
|
|
const customFields = (additionalFields.customFieldsUi as IDataObject)
|
|
.customFieldValues as IDataObject[];
|
|
if (customFields) {
|
|
const data = customFields.reduce(
|
|
(obj, value) => Object.assign(obj, { [`${value.fieldId}`]: value.fieldValue }),
|
|
{},
|
|
);
|
|
Object.assign(contact, { custom_fields: data });
|
|
}
|
|
}
|
|
contacts.push(contact);
|
|
}
|
|
responseData = await sendGridApiRequest.call(
|
|
this,
|
|
'/marketing/contacts',
|
|
'PUT',
|
|
{ list_ids: lists, contacts },
|
|
qs,
|
|
);
|
|
returnData.push(responseData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
returnData.push({ json: { error: error.message } });
|
|
} else {
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'delete') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const deleteAll = this.getNodeParameter('deleteAll', i) as boolean;
|
|
if (deleteAll) {
|
|
qs.delete_all_contacts = 'true';
|
|
}
|
|
qs.ids = (this.getNodeParameter('ids', i) as string).replace(/\s/g, '');
|
|
responseData = await sendGridApiRequest.call(
|
|
this,
|
|
'/marketing/contacts',
|
|
'DELETE',
|
|
{},
|
|
qs,
|
|
);
|
|
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (resource === 'list') {
|
|
if (operation === 'getAll') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const returnAll = this.getNodeParameter('returnAll', i);
|
|
responseData = await sendGridApiRequestAllItems.call(
|
|
this,
|
|
'/marketing/lists',
|
|
'GET',
|
|
'result',
|
|
{},
|
|
qs,
|
|
);
|
|
if (!returnAll) {
|
|
const limit = this.getNodeParameter('limit', i);
|
|
responseData = responseData.splice(0, limit);
|
|
}
|
|
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'get') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
qs.contact_sample = this.getNodeParameter('contactSample', i) as boolean;
|
|
responseData = await sendGridApiRequest.call(
|
|
this,
|
|
`/marketing/lists/${listId}`,
|
|
'GET',
|
|
{},
|
|
qs,
|
|
);
|
|
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'create') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const name = this.getNodeParameter('name', i) as string;
|
|
responseData = await sendGridApiRequest.call(
|
|
this,
|
|
'/marketing/lists',
|
|
'POST',
|
|
{ name },
|
|
qs,
|
|
);
|
|
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'delete') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
qs.delete_contacts = this.getNodeParameter('deleteContacts', i) as boolean;
|
|
responseData = await sendGridApiRequest.call(
|
|
this,
|
|
`/marketing/lists/${listId}`,
|
|
'DELETE',
|
|
{},
|
|
qs,
|
|
);
|
|
responseData = { success: true };
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
if (operation === 'update') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const name = this.getNodeParameter('name', i) as string;
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
responseData = await sendGridApiRequest.call(
|
|
this,
|
|
`/marketing/lists/${listId}`,
|
|
'PATCH',
|
|
{ name },
|
|
qs,
|
|
);
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray(responseData),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (resource === 'mail') {
|
|
if (operation === 'send') {
|
|
for (let i = 0; i < length; i++) {
|
|
try {
|
|
const toEmail = this.getNodeParameter('toEmail', i) as string;
|
|
|
|
const parsedToEmail = toEmail.includes(',')
|
|
? toEmail.split(',').map((entry) => ({ email: entry.trim() }))
|
|
: [{ email: toEmail.trim() }];
|
|
|
|
const {
|
|
bccEmail,
|
|
ccEmail,
|
|
enableSandbox,
|
|
sendAt,
|
|
headers,
|
|
attachments,
|
|
categories,
|
|
ipPoolName,
|
|
} = this.getNodeParameter('additionalFields', i) as {
|
|
bccEmail: string;
|
|
ccEmail: string;
|
|
enableSandbox: boolean;
|
|
sendAt: string;
|
|
headers: { details: Array<{ key: string; value: string }> };
|
|
attachments: string;
|
|
categories: string;
|
|
ipPoolName: string;
|
|
};
|
|
|
|
const body: SendMailBody = {
|
|
personalizations: [
|
|
{
|
|
to: parsedToEmail,
|
|
},
|
|
],
|
|
from: {
|
|
email: (this.getNodeParameter('fromEmail', i) as string).trim(),
|
|
name: this.getNodeParameter('fromName', i) as string,
|
|
},
|
|
mail_settings: {
|
|
sandbox_mode: {
|
|
enable: enableSandbox || false,
|
|
},
|
|
},
|
|
};
|
|
|
|
const dynamicTemplateEnabled = this.getNodeParameter('dynamicTemplate', i);
|
|
|
|
// dynamic template
|
|
if (dynamicTemplateEnabled) {
|
|
body.template_id = this.getNodeParameter('templateId', i) as string;
|
|
|
|
const { fields } = this.getNodeParameter('dynamicTemplateFields', i) as {
|
|
fields: Array<{ [key: string]: string }>;
|
|
};
|
|
|
|
if (fields) {
|
|
body.personalizations[0].dynamic_template_data = {};
|
|
fields.forEach((field) => {
|
|
body.personalizations[0].dynamic_template_data![field.key] = field.value;
|
|
});
|
|
}
|
|
|
|
// message body
|
|
} else {
|
|
body.personalizations[0].subject = this.getNodeParameter('subject', i) as string;
|
|
body.content = [
|
|
{
|
|
type: this.getNodeParameter('contentType', i) as string,
|
|
value: this.getNodeParameter('contentValue', i) as string,
|
|
},
|
|
];
|
|
}
|
|
|
|
if (attachments) {
|
|
const attachmentsToSend = [];
|
|
const binaryProperties = attachments.split(',').map((p) => p.trim());
|
|
|
|
for (const property of binaryProperties) {
|
|
if (!items[i].binary?.hasOwnProperty(property)) {
|
|
throw new NodeOperationError(
|
|
this.getNode(),
|
|
`The binary property ${property} does not exist`,
|
|
{ itemIndex: i },
|
|
);
|
|
}
|
|
|
|
const binaryProperty = items[i].binary![property];
|
|
|
|
const dataBuffer = await this.helpers.getBinaryDataBuffer(i, property);
|
|
|
|
attachmentsToSend.push({
|
|
content: dataBuffer.toString('base64'),
|
|
filename: binaryProperty.fileName || 'unknown',
|
|
type: binaryProperty.mimeType,
|
|
});
|
|
}
|
|
|
|
if (attachmentsToSend.length) {
|
|
body.attachments = attachmentsToSend;
|
|
}
|
|
}
|
|
|
|
if (bccEmail) {
|
|
body.personalizations[0].bcc = bccEmail
|
|
.split(',')
|
|
.map((entry) => ({ email: entry.trim() }));
|
|
}
|
|
|
|
if (ccEmail) {
|
|
body.personalizations[0].cc = ccEmail
|
|
.split(',')
|
|
.map((entry) => ({ email: entry.trim() }));
|
|
}
|
|
|
|
if (headers?.details.length) {
|
|
const parsedHeaders: { [key: string]: string } = {};
|
|
headers.details.forEach((obj) => (parsedHeaders[obj.key] = obj.value));
|
|
body.headers = parsedHeaders;
|
|
}
|
|
|
|
if (categories) {
|
|
body.categories = categories.split(',');
|
|
}
|
|
|
|
if (ipPoolName) {
|
|
body.ip_pool_name = ipPoolName;
|
|
}
|
|
|
|
if (sendAt) {
|
|
body.personalizations[0].send_at = moment.tz(sendAt, timezone).unix();
|
|
}
|
|
|
|
const data = await sendGridApiRequest.call(this, '/mail/send', 'POST', body, qs, {
|
|
resolveWithFullResponse: true,
|
|
});
|
|
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ messageId: data.headers['x-message-id'] }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
const executionData = this.helpers.constructExecutionMetaData(
|
|
this.helpers.returnJsonArray({ error: error.message }),
|
|
{ itemData: { item: i } },
|
|
);
|
|
returnData.push(...executionData);
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return this.prepareOutputData(returnData);
|
|
}
|
|
}
|