2022-08-17 08:50:24 -07:00
|
|
|
import { IExecuteFunctions } from 'n8n-core';
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
import {
|
|
|
|
IDataObject,
|
|
|
|
INodeExecutionData,
|
|
|
|
INodeType,
|
|
|
|
INodeTypeDescription,
|
2021-04-16 09:33:36 -07:00
|
|
|
NodeApiError,
|
|
|
|
NodeOperationError,
|
2020-10-13 01:48:20 -07:00
|
|
|
} from 'n8n-workflow';
|
|
|
|
|
2022-08-17 08:50:24 -07:00
|
|
|
import { sendyApiRequest } from './GenericFunctions';
|
2020-10-13 01:48:20 -07:00
|
|
|
|
2022-08-17 08:50:24 -07:00
|
|
|
import { campaignFields, campaignOperations } from './CampaignDescription';
|
2020-10-13 01:48:20 -07:00
|
|
|
|
2022-08-17 08:50:24 -07:00
|
|
|
import { subscriberFields, subscriberOperations } from './SubscriberDescription';
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
export class Sendy implements INodeType {
|
|
|
|
description: INodeTypeDescription = {
|
|
|
|
displayName: 'Sendy',
|
|
|
|
name: 'sendy',
|
2022-06-20 07:54:01 -07:00
|
|
|
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
|
2020-10-13 01:48:20 -07:00
|
|
|
icon: 'file:sendy.png',
|
|
|
|
group: ['input'],
|
|
|
|
version: 1,
|
|
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
2021-07-03 05:40:16 -07:00
|
|
|
description: 'Consume Sendy API',
|
2020-10-13 01:48:20 -07:00
|
|
|
defaults: {
|
|
|
|
name: 'Sendy',
|
|
|
|
},
|
|
|
|
inputs: ['main'],
|
|
|
|
outputs: ['main'],
|
|
|
|
credentials: [
|
|
|
|
{
|
|
|
|
name: 'sendyApi',
|
|
|
|
required: true,
|
|
|
|
},
|
|
|
|
],
|
|
|
|
properties: [
|
|
|
|
{
|
|
|
|
displayName: 'Resource',
|
|
|
|
name: 'resource',
|
|
|
|
type: 'options',
|
2022-05-20 14:47:24 -07:00
|
|
|
noDataExpression: true,
|
2020-10-13 01:48:20 -07:00
|
|
|
options: [
|
|
|
|
{
|
|
|
|
name: 'Campaign',
|
|
|
|
value: 'campaign',
|
|
|
|
},
|
|
|
|
{
|
|
|
|
name: 'Subscriber',
|
|
|
|
value: 'subscriber',
|
|
|
|
},
|
|
|
|
],
|
|
|
|
default: 'subscriber',
|
|
|
|
},
|
|
|
|
...campaignOperations,
|
|
|
|
...campaignFields,
|
|
|
|
...subscriberOperations,
|
|
|
|
...subscriberFields,
|
|
|
|
],
|
|
|
|
};
|
|
|
|
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
|
|
const items = this.getInputData();
|
|
|
|
const returnData: IDataObject[] = [];
|
2022-04-22 09:29:51 -07:00
|
|
|
const length = items.length;
|
2020-10-13 01:48:20 -07:00
|
|
|
let responseData;
|
|
|
|
const resource = this.getNodeParameter('resource', 0) as string;
|
|
|
|
const operation = this.getNodeParameter('operation', 0) as string;
|
|
|
|
for (let i = 0; i < length; i++) {
|
|
|
|
if (resource === 'campaign') {
|
|
|
|
if (operation === 'create') {
|
|
|
|
const fromName = this.getNodeParameter('fromName', i) as string;
|
|
|
|
|
|
|
|
const fromEmail = this.getNodeParameter('fromEmail', i) as string;
|
|
|
|
|
|
|
|
const replyTo = this.getNodeParameter('replyTo', i) as string;
|
|
|
|
|
|
|
|
const title = this.getNodeParameter('title', i) as string;
|
|
|
|
|
|
|
|
const subject = this.getNodeParameter('subject', i) as string;
|
|
|
|
|
|
|
|
const htmlText = this.getNodeParameter('htmlText', i) as boolean;
|
|
|
|
|
|
|
|
const sendCampaign = this.getNodeParameter('sendCampaign', i) as boolean;
|
|
|
|
|
2022-11-18 07:29:44 -08:00
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i);
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
const body: IDataObject = {
|
|
|
|
from_name: fromName,
|
|
|
|
from_email: fromEmail,
|
|
|
|
reply_to: replyTo,
|
|
|
|
title,
|
|
|
|
subject,
|
2020-10-13 01:48:46 -07:00
|
|
|
send_campaign: sendCampaign ? 1 : 0,
|
2020-10-13 01:48:20 -07:00
|
|
|
html_text: htmlText,
|
|
|
|
};
|
|
|
|
|
|
|
|
if (additionalFields.plainText) {
|
|
|
|
body.plain_text = additionalFields.plainText;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.listIds) {
|
|
|
|
body.list_ids = additionalFields.listIds as string;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.segmentIds) {
|
|
|
|
body.segment_ids = additionalFields.segmentIds as string;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.excludeListIds) {
|
|
|
|
body.exclude_list_ids = additionalFields.excludeListIds as string;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.excludeSegmentIds) {
|
|
|
|
body.exclude_segments_ids = additionalFields.excludeSegmentIds as string;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.brandId) {
|
|
|
|
body.brand_id = additionalFields.brandId as string;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.queryString) {
|
|
|
|
body.query_string = additionalFields.queryString as string;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.trackOpens) {
|
2022-08-17 08:50:24 -07:00
|
|
|
body.track_opens = (additionalFields.trackOpens as boolean) ? 1 : 0;
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
if (additionalFields.trackClicks) {
|
2022-08-17 08:50:24 -07:00
|
|
|
body.track_clicks = (additionalFields.trackClicks as boolean) ? 1 : 0;
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
responseData = await sendyApiRequest.call(
|
|
|
|
this,
|
|
|
|
'POST',
|
|
|
|
'/api/campaigns/create.php',
|
2020-10-22 09:00:28 -07:00
|
|
|
body,
|
2020-10-13 01:48:20 -07:00
|
|
|
);
|
|
|
|
|
2022-08-17 08:50:24 -07:00
|
|
|
const success = ['Campaign created', 'Campaign created and now sending'];
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
if (success.includes(responseData)) {
|
|
|
|
responseData = { message: responseData };
|
|
|
|
} else {
|
2021-04-16 09:33:36 -07:00
|
|
|
throw new NodeApiError(this.getNode(), responseData, { httpCode: '400' });
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (resource === 'subscriber') {
|
|
|
|
if (operation === 'add') {
|
|
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
|
|
|
|
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
|
|
|
2022-11-18 07:29:44 -08:00
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i);
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
const body: IDataObject = {
|
|
|
|
email,
|
|
|
|
list: listId,
|
|
|
|
};
|
|
|
|
|
|
|
|
Object.assign(body, additionalFields);
|
|
|
|
|
2022-08-17 08:50:24 -07:00
|
|
|
responseData = await sendyApiRequest.call(this, 'POST', '/subscribe', body);
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
if (responseData === '1') {
|
|
|
|
responseData = { success: true };
|
|
|
|
} else {
|
2022-08-17 08:50:24 -07:00
|
|
|
throw new NodeOperationError(
|
|
|
|
this.getNode(),
|
|
|
|
`Sendy error response [${400}]: ${responseData}`,
|
|
|
|
{ itemIndex: i },
|
|
|
|
);
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (operation === 'count') {
|
|
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
|
|
|
|
|
|
const body: IDataObject = {
|
|
|
|
list_id: listId,
|
|
|
|
};
|
|
|
|
|
|
|
|
responseData = await sendyApiRequest.call(
|
|
|
|
this,
|
|
|
|
'POST',
|
|
|
|
'/api/subscribers/active-subscriber-count.php',
|
2020-10-22 09:00:28 -07:00
|
|
|
body,
|
2020-10-13 01:48:20 -07:00
|
|
|
);
|
|
|
|
|
|
|
|
const errors = [
|
|
|
|
'No data passed',
|
|
|
|
'API key not passed',
|
|
|
|
'Invalid API key',
|
|
|
|
'List ID not passed',
|
|
|
|
'List does not exist',
|
|
|
|
];
|
|
|
|
|
|
|
|
if (!errors.includes(responseData)) {
|
|
|
|
responseData = { count: responseData };
|
|
|
|
} else {
|
2022-08-17 08:50:24 -07:00
|
|
|
throw new NodeOperationError(
|
|
|
|
this.getNode(),
|
|
|
|
`Sendy error response [${400}]: ${responseData}`,
|
|
|
|
{ itemIndex: i },
|
|
|
|
);
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (operation === 'delete') {
|
|
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
|
|
|
|
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
|
|
|
|
|
|
const body: IDataObject = {
|
|
|
|
email,
|
|
|
|
list_id: listId,
|
|
|
|
};
|
|
|
|
|
|
|
|
responseData = await sendyApiRequest.call(
|
|
|
|
this,
|
|
|
|
'POST',
|
|
|
|
'/api/subscribers/delete.php',
|
2020-10-22 09:00:28 -07:00
|
|
|
body,
|
2020-10-13 01:48:20 -07:00
|
|
|
);
|
|
|
|
|
|
|
|
if (responseData === '1') {
|
|
|
|
responseData = { success: true };
|
|
|
|
} else {
|
2022-08-17 08:50:24 -07:00
|
|
|
throw new NodeOperationError(
|
|
|
|
this.getNode(),
|
|
|
|
`Sendy error response [${400}]: ${responseData}`,
|
|
|
|
{ itemIndex: i },
|
|
|
|
);
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (operation === 'remove') {
|
|
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
|
|
|
|
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
|
|
|
|
|
|
const body: IDataObject = {
|
|
|
|
email,
|
|
|
|
list: listId,
|
|
|
|
};
|
|
|
|
|
2022-08-17 08:50:24 -07:00
|
|
|
responseData = await sendyApiRequest.call(this, 'POST', '/unsubscribe', body);
|
2020-10-13 01:48:20 -07:00
|
|
|
|
|
|
|
if (responseData === '1') {
|
|
|
|
responseData = { success: true };
|
|
|
|
} else {
|
2022-08-17 08:50:24 -07:00
|
|
|
throw new NodeOperationError(
|
|
|
|
this.getNode(),
|
|
|
|
`Sendy error response [${400}]: ${responseData}`,
|
|
|
|
{ itemIndex: i },
|
|
|
|
);
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (operation === 'status') {
|
|
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
|
|
|
|
|
|
const listId = this.getNodeParameter('listId', i) as string;
|
|
|
|
|
|
|
|
const body: IDataObject = {
|
|
|
|
email,
|
|
|
|
list_id: listId,
|
|
|
|
};
|
|
|
|
|
|
|
|
responseData = await sendyApiRequest.call(
|
|
|
|
this,
|
|
|
|
'POST',
|
|
|
|
'/api/subscribers/subscription-status.php',
|
2020-10-22 09:00:28 -07:00
|
|
|
body,
|
2020-10-13 01:48:20 -07:00
|
|
|
);
|
|
|
|
|
|
|
|
const status = [
|
|
|
|
'Subscribed',
|
|
|
|
'Unsubscribed',
|
|
|
|
'Unconfirmed',
|
|
|
|
'Bounced',
|
|
|
|
'Soft bounced',
|
|
|
|
'Complained',
|
|
|
|
];
|
|
|
|
|
|
|
|
if (status.includes(responseData)) {
|
|
|
|
responseData = { status: responseData };
|
|
|
|
} else {
|
2022-08-17 08:50:24 -07:00
|
|
|
throw new NodeOperationError(
|
|
|
|
this.getNode(),
|
|
|
|
`Sendy error response [${400}]: ${responseData}`,
|
|
|
|
{ itemIndex: i },
|
|
|
|
);
|
2020-10-13 01:48:20 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (Array.isArray(responseData)) {
|
|
|
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
|
|
|
} else if (responseData !== undefined) {
|
|
|
|
returnData.push(responseData as IDataObject);
|
|
|
|
}
|
|
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
|
|
}
|
|
|
|
}
|