n8n/packages/nodes-base/nodes/ConvertKit/ConvertKit.node.ts

487 lines
12 KiB
TypeScript
Raw Normal View History

import {
IExecuteFunctions,
2020-08-05 18:55:53 -07:00
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
convertKitApiRequest,
} from './GenericFunctions';
import {
2020-08-05 18:55:53 -07:00
customFieldFields,
customFieldOperations,
2020-08-05 18:55:53 -07:00
} from './CustomFieldDescription';
import {
formFields,
formOperations,
} from './FormDescription';
import {
sequenceFields,
sequenceOperations,
} from './SequenceDescription';
import {
tagFields,
tagOperations,
} from './TagDescription';
2020-08-05 18:55:53 -07:00
import {
tagSubscriberFields,
tagSubscriberOperations,
2020-08-05 18:55:53 -07:00
} from './TagSubscriberDescription';
export class ConvertKit implements INodeType {
description: INodeTypeDescription = {
displayName: 'ConvertKit',
name: 'convertKit',
icon: 'file:convertKit.svg',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume ConvertKit API.',
defaults: {
name: 'ConvertKit',
color: '#fb6970',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'convertKitApi',
required: true,
2020-10-22 06:46:03 -07:00
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
2020-08-05 18:55:53 -07:00
name: 'Custom Field',
value: 'customField',
},
{
name: 'Form',
value: 'form',
},
{
name: 'Sequence',
value: 'sequence',
},
{
name: 'Tag',
value: 'tag',
},
2020-08-05 18:55:53 -07:00
{
name: 'Tag Subscriber',
value: 'tagSubscriber',
},
],
default: 'form',
2020-10-22 06:46:03 -07:00
description: 'The resource to operate on.',
},
//--------------------
// Field Description
//--------------------
2020-08-05 18:55:53 -07:00
...customFieldOperations,
...customFieldFields,
//--------------------
// FormDescription
//--------------------
...formOperations,
...formFields,
//--------------------
// Sequence Description
//--------------------
...sequenceOperations,
...sequenceFields,
//--------------------
// Tag Description
//--------------------
...tagOperations,
...tagFields,
2020-08-05 18:55:53 -07:00
//--------------------
// Tag Subscriber Description
//--------------------
...tagSubscriberOperations,
...tagSubscriberFields,
],
};
2020-08-05 18:55:53 -07:00
methods = {
loadOptions: {
// Get all the tags to display them to user so that he can
// select them easily
async getTags(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { tags } = await convertKitApiRequest.call(this, 'GET', '/tags');
for (const tag of tags) {
const tagName = tag.name;
const tagId = tag.id;
returnData.push({
name: tagName,
value: tagId,
});
}
return returnData;
},
// Get all the forms to display them to user so that he can
// select them easily
async getForms(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { forms } = await convertKitApiRequest.call(this, 'GET', '/forms');
for (const form of forms) {
const formName = form.name;
const formId = form.id;
returnData.push({
name: formName,
value: formId,
});
}
return returnData;
},
// Get all the sequences to display them to user so that he can
// select them easily
async getSequences(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const { courses } = await convertKitApiRequest.call(this, 'GET', '/sequences');
for (const course of courses) {
const courseName = course.name;
const courseId = course.id;
returnData.push({
name: courseName,
value: courseId,
});
}
return returnData;
},
2020-10-22 06:46:03 -07:00
},
2020-08-05 18:55:53 -07:00
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < items.length; i++) {
2020-08-05 18:55:53 -07:00
if (resource === 'customField') {
if (operation === 'create') {
const label = this.getNodeParameter('label', i) as string;
responseData = await convertKitApiRequest.call(this, 'POST', '/custom_fields', { label }, qs);
}
if (operation === 'delete') {
const id = this.getNodeParameter('id', i) as string;
2020-08-05 18:55:53 -07:00
responseData = await convertKitApiRequest.call(this, 'DELETE', `/custom_fields/${id}`);
}
if (operation === 'get') {
const id = this.getNodeParameter('id', i) as string;
2020-08-05 18:55:53 -07:00
responseData = await convertKitApiRequest.call(this, 'GET', `/custom_fields/${id}`);
}
2020-08-05 18:55:53 -07:00
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
responseData = await convertKitApiRequest.call(this, 'GET', `/custom_fields`);
responseData = responseData.custom_fields;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
2020-08-05 18:55:53 -07:00
}
if (operation === 'update') {
const id = this.getNodeParameter('id', i) as string;
const label = this.getNodeParameter('label', i) as string;
responseData = await convertKitApiRequest.call(this, 'PUT', `/custom_fields/${id}`, { label });
responseData = { success: true };
}
}
if (resource === 'form') {
if (operation === 'addSubscriber') {
const email = this.getNodeParameter('email', i) as string;
const formId = this.getNodeParameter('id', i) as string;
2020-08-05 18:55:53 -07:00
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
2020-08-05 18:55:53 -07:00
const body: IDataObject = {
email,
};
2020-08-05 18:55:53 -07:00
if (additionalFields.firstName) {
body.first_name = additionalFields.firstName as string;
}
if (additionalFields.tags) {
body.tags = additionalFields.tags as string[];
}
if (additionalFields.fieldsUi) {
const fieldValues = (additionalFields.fieldsUi as IDataObject).fieldsValues as IDataObject[];
if (fieldValues) {
body.fields = {};
for (const fieldValue of fieldValues) {
//@ts-ignore
body.fields[fieldValue.key] = fieldValue.value;
}
}
2020-08-05 18:55:53 -07:00
}
const { subscription } = await convertKitApiRequest.call(this, 'POST', `/forms/${formId}/subscribe`, body);
responseData = subscription;
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
responseData = await convertKitApiRequest.call(this, 'GET', `/forms`);
responseData = responseData.forms;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
}
if (operation === 'getSubscriptions') {
const formId = this.getNodeParameter('id', i) as string;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
if (additionalFields.subscriberState) {
qs.subscriber_state = additionalFields.subscriberState as string;
}
responseData = await convertKitApiRequest.call(this, 'GET', `/forms/${formId}/subscriptions`, {}, qs);
responseData = responseData.subscriptions;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
}
}
if (resource === 'sequence') {
if (operation === 'addSubscriber') {
const email = this.getNodeParameter('email', i) as string;
const sequenceId = this.getNodeParameter('id', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
email,
};
if (additionalFields.firstName) {
body.first_name = additionalFields.firstName as string;
}
2020-08-05 18:55:53 -07:00
if (additionalFields.tags) {
body.tags = additionalFields.tags as string[];
}
2020-08-05 18:55:53 -07:00
if (additionalFields.fieldsUi) {
const fieldValues = (additionalFields.fieldsUi as IDataObject).fieldsValues as IDataObject[];
if (fieldValues) {
body.fields = {};
for (const fieldValue of fieldValues) {
//@ts-ignore
body.fields[fieldValue.key] = fieldValue.value;
}
}
}
const { subscription } = await convertKitApiRequest.call(this, 'POST', `/sequences/${sequenceId}/subscribe`, body);
responseData = subscription;
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
responseData = await convertKitApiRequest.call(this, 'GET', `/sequences`);
responseData = responseData.courses;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
2020-08-05 18:55:53 -07:00
}
if (operation === 'getSubscriptions') {
const sequenceId = this.getNodeParameter('id', i) as string;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
if (additionalFields.subscriberState) {
qs.subscriber_state = additionalFields.subscriberState as string;
}
2020-08-05 18:55:53 -07:00
responseData = await convertKitApiRequest.call(this, 'GET', `/sequences/${sequenceId}/subscriptions`, {}, qs);
responseData = responseData.subscriptions;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
2020-08-05 18:55:53 -07:00
}
}
if (resource === 'tag') {
if (operation === 'create') {
const names = ((this.getNodeParameter('name', i) as string).split(',') as string[]).map((e) => ({ name: e }));
const body: IDataObject = {
2020-10-22 06:46:03 -07:00
tag: names,
2020-08-05 18:55:53 -07:00
};
responseData = await convertKitApiRequest.call(this, 'POST', '/tags', body);
}
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
responseData = await convertKitApiRequest.call(this, 'GET', `/tags`);
responseData = responseData.tags;
2020-08-05 18:55:53 -07:00
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
}
}
2020-08-05 18:55:53 -07:00
if (resource === 'tagSubscriber') {
if (operation === 'add') {
const tagId = this.getNodeParameter('tagId', i) as string;
const email = this.getNodeParameter('email', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
email,
};
if (additionalFields.firstName) {
body.first_name = additionalFields.firstName as string;
}
if (additionalFields.fieldsUi) {
const fieldValues = (additionalFields.fieldsUi as IDataObject).fieldsValues as IDataObject[];
if (fieldValues) {
body.fields = {};
for (const fieldValue of fieldValues) {
//@ts-ignore
body.fields[fieldValue.key] = fieldValue.value;
}
}
}
const { subscription } = await convertKitApiRequest.call(this, 'POST', `/tags/${tagId}/subscribe`, body);
responseData = subscription;
}
if (operation === 'getAll') {
const tagId = this.getNodeParameter('tagId', i) as string;
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
responseData = await convertKitApiRequest.call(this, 'GET', `/tags/${tagId}/subscriptions`);
responseData = responseData.subscriptions;
if (!returnAll) {
const limit = this.getNodeParameter('limit', i) as number;
responseData = responseData.slice(0, limit);
}
}
if (operation === 'delete') {
const tagId = this.getNodeParameter('tagId', i) as string;
const email = this.getNodeParameter('email', i) as string;
responseData = await convertKitApiRequest.call(this, 'POST', `/tags/${tagId}>/unsubscribe`, { email });
2020-08-05 18:55:53 -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)];
}
}