import { IExecuteFunctions, } from 'n8n-core'; import { IDataObject, INodeTypeDescription, INodeExecutionData, INodeType, } from 'n8n-workflow'; import { activeCampaignApiRequest, activeCampaignApiRequestAllItems, } from './GenericFunctions'; import { type } from 'os'; interface CustomProperty { name: string; value: string; } /** * Add the additional fields to the body * * @param {IDataObject} body The body object to add fields to * @param {IDataObject} additionalFields The fields to add */ function addAdditionalFields(body: IDataObject, additionalFields: IDataObject) { for (const key of Object.keys(additionalFields)) { if (key === 'customProperties' && (additionalFields.customProperties as IDataObject).property !== undefined) { for (const customProperty of (additionalFields.customProperties as IDataObject)!.property! as CustomProperty[]) { body[customProperty.name] = customProperty.value; } } else { body[key] = additionalFields[key]; } } } /** * Add one additional field to the body * * @param {IDataObject} body The body object to add the field to * @param {IDataObject} additionalField The field to add */ function addAdditionalField(body: IDataObject, additionalField: string | number) { body.additionalField = additionalField; } export class ActiveCampaign implements INodeType { description: INodeTypeDescription = { displayName: 'ActiveCampaign', name: 'activeCampaign', icon: 'file:activeCampaign.png', group: ['transform'], version: 1, subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', description: 'Create and edit data in ActiveCampaign', defaults: { name: 'ActiveCampaign', color: '#356ae6', }, inputs: ['main'], outputs: ['main'], credentials: [ { name: 'activeCampaignApi', required: true, } ], properties: [ // ---------------------------------- // resources // ---------------------------------- { displayName: 'Resource', name: 'resource', type: 'options', options: [ { name: 'Contact', value: 'contact', }, { name: 'Deal', value: 'deal', } ], default: 'contact', description: 'The resource to operate on.', }, // ---------------------------------- // operations // ---------------------------------- { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'contact', ], }, }, options: [ { name: 'Create', value: 'create', description: 'Create a contact', }, { name: 'Delete', value: 'delete', description: 'Delete a contact', }, { name: 'Get', value: 'get', description: 'Get data of a contact', }, { name: 'Get All', value: 'getAll', description: 'Get data of all contact', }, { name: 'Update', value: 'update', description: 'Update a contact', }, ], default: 'create', description: 'The operation to perform.', }, { displayName: 'Operation', name: 'operation', type: 'options', displayOptions: { show: { resource: [ 'deal', ], }, }, options: [ { name: 'Create', value: 'create', description: 'Create a deal', }, { name: 'Delete', value: 'delete', description: 'Delete a deal', }, { name: 'Get', value: 'get', description: 'Get data of a deal', }, { name: 'Get All', value: 'getAll', description: 'Get data of all deals', }, { name: 'Update', value: 'update', description: 'Update a deal', }, { name: 'Create Note', value: 'createNote', description: 'Create a deal note', }, { name: 'Update deal note', value: 'updateNote', description: 'Update a deal note', }, ], default: 'create', description: 'The operation to perform.', }, // ---------------------------------- // contact // ---------------------------------- // ---------------------------------- // contact:create // ---------------------------------- { displayName: 'Email', name: 'email', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'contact', ], }, }, description: 'The email of the contact to create', }, { displayName: 'Update if exists', name: 'updateIfExists', type: 'boolean', displayOptions: { show: { operation: [ 'create', ], resource: [ 'contact', ], }, }, default: false, description: 'Update user if it exists already. If not set and user exists it will error instead.', }, { displayName: 'Additional Fields', name: 'additionalFields', type: 'collection', placeholder: 'Add Field', displayOptions: { show: { operation: [ 'create', ], resource: [ 'contact', ], }, }, default: {}, options: [ { displayName: 'First Name', name: 'firstName', type: 'string', default: '', description: 'The first name of the contact to create', }, { displayName: 'Last Name', name: 'lastName', type: 'string', default: '', description: 'The last name of the contact to create', }, { displayName: 'Phone', name: 'phone', type: 'string', default: '', description: 'Phone number of the contact.', }, { displayName: 'Custom Properties', name: 'customProperties', placeholder: 'Add Custom Property', description: 'Adds a custom property to set also values which have not been predefined.', type: 'fixedCollection', typeOptions: { multipleValues: true, }, default: {}, options: [ { name: 'property', displayName: 'Property', values: [ { displayName: 'Property Name', name: 'name', type: 'string', default: '', description: 'Name of the property to set.', }, { displayName: 'Property Value', name: 'value', type: 'string', default: '', description: 'Value of the property to set.', }, ] }, ], }, ], }, // ---------------------------------- // contact:update // ---------------------------------- { displayName: 'Contact ID', name: 'contactId', type: 'number', displayOptions: { show: { operation: [ 'update', ], resource: [ 'contact', ], }, }, default: 0, required: true, description: 'ID of the contact to update.', }, { displayName: 'Update Fields', name: 'updateFields', type: 'collection', description: 'The fields to update.', placeholder: 'Add Field', displayOptions: { show: { operation: [ 'update', ], resource: [ 'contact', ], }, }, default: {}, options: [ { displayName: 'Email', name: 'email', type: 'string', default: '', description: 'Email of the contact.', }, { displayName: 'First Name', name: 'firstName', type: 'string', default: '', description: 'First name of the contact', }, { displayName: 'Last Name', name: 'lastName', type: 'string', default: '', description: 'Last name of the contact', }, { displayName: 'Phone', name: 'phone', type: 'string', default: '', description: 'Phone number of the contact.', }, { displayName: 'Custom Properties', name: 'customProperties', placeholder: 'Add Custom Property', description: 'Adds a custom property to set also values which have not been predefined.', type: 'fixedCollection', typeOptions: { multipleValues: true, }, default: {}, options: [ { name: 'property', displayName: 'Property', values: [ { displayName: 'Property Name', name: 'name', type: 'string', default: '', description: 'Name of the property to set.', }, { displayName: 'Property Value', name: 'value', type: 'string', default: '', description: 'Value of the property to set.', }, ] }, ], }, ], }, // ---------------------------------- // contact:delete // ---------------------------------- { displayName: 'Contact ID', name: 'contactId', type: 'number', displayOptions: { show: { operation: [ 'delete', ], resource: [ 'contact', ], }, }, default: 0, required: true, description: 'ID of the contact to delete.', }, // ---------------------------------- // contact:get // ---------------------------------- { displayName: 'Contact ID', name: 'contactId', type: 'number', displayOptions: { show: { operation: [ 'get', ], resource: [ 'contact', ], }, }, default: 0, required: true, description: 'ID of the contact to get.', }, // ---------------------------------- // contact:getAll // ---------------------------------- { displayName: 'Return All', name: 'returnAll', type: 'boolean', displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'contact', ], }, }, default: false, description: 'If all results should be returned or only up to a given limit.', }, { displayName: 'Limit', name: 'limit', type: 'number', displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'contact', ], returnAll: [ false, ], }, }, typeOptions: { minValue: 1, maxValue: 500, }, default: 100, description: 'How many results to return.', }, // ---------------------------------- // deal // ---------------------------------- // ---------------------------------- // deal:create // ---------------------------------- { displayName: 'Title', name: 'dealTitle', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The title of the deal', }, { displayName: 'Description', name: 'dealDescription', type: 'string', default: '', displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The description of the deal', }, { displayName: 'Deal\'s contact ID', name: 'dealContactId', type: 'number', default: 0, required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal\'s contact', }, { displayName: 'Deal value', name: 'dealValue', type: 'number', default: 0, required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The value of the deal in cents', }, { displayName: 'Currency', name: 'dealCurrency', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The currency of the deal in 3-character ISO format', }, { displayName: 'Deal group ID', name: 'dealGroup', type: 'string', default: '', displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The group ID of the deal', }, { displayName: 'Deal stage ID', name: 'dealStage', type: 'string', default: '', displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The stage ID of the deal', }, { displayName: 'Deal owner ID', name: 'dealOwner', type: 'string', default: '', displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The owner ID of the deal', }, { displayName: 'Deal percentage', name: 'dealPercentage', type: 'number', default: 0, displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The percentage of the deal', }, { displayName: 'Deal status', name: 'dealStatus', type: 'number', default: 0, displayOptions: { show: { operation: [ 'create', ], resource: [ 'deal', ], }, }, description: 'The status of the deal', }, // ---------------------------------- // deal:update // ---------------------------------- { displayName: 'Deal ID', name: 'dealId', type: 'number', default: 0, required: true, displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal', }, { displayName: 'Title', name: 'dealTitle', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The title of the deal', }, { displayName: 'Description', name: 'dealDescription', type: 'string', default: '', displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The description of the deal', }, { displayName: 'Deal\'s contact ID', name: 'dealContactId', type: 'number', default: 0, displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal\'s contact', }, { displayName: 'Deal value', name: 'dealValue', type: 'number', default: 0, displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The value of the deal in cents', }, { displayName: 'Currency', name: 'dealCurrency', type: 'string', default: '', displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The currency of the deal in 3-character ISO format', }, { displayName: 'Deal group ID', name: 'dealGroup', type: 'string', default: '', displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The group ID of the deal', }, { displayName: 'Deal stage ID', name: 'dealStage', type: 'string', default: '', displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The stage ID of the deal', }, { displayName: 'Deal owner ID', name: 'dealOwner', type: 'string', default: '', displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The owner ID of the deal', }, { displayName: 'Deal percentage', name: 'dealPercentage', type: 'number', default: 0, displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The percentage of the deal', }, { displayName: 'Deal status', name: 'dealStatus', type: 'number', default: 0, displayOptions: { show: { operation: [ 'update', ], resource: [ 'deal', ], }, }, description: 'The status of the deal', }, // ---------------------------------- // deal:delete // ---------------------------------- { displayName: 'Deal ID', name: 'dealId', type: 'number', default: 0, required: true, displayOptions: { show: { operation: [ 'delete', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal', }, // ---------------------------------- // deal:get // ---------------------------------- { displayName: 'Deal ID', name: 'dealId', type: 'number', default: 0, required: true, displayOptions: { show: { operation: [ 'get', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal', }, // ---------------------------------- // deal:getAll // ---------------------------------- { displayName: 'Return All', name: 'returnAll', type: 'boolean', displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'deal', ], }, }, default: false, description: 'If all results should be returned or only up to a given limit.', }, { displayName: 'Limit', name: 'limit', type: 'number', displayOptions: { show: { operation: [ 'getAll', ], resource: [ 'deal', ], returnAll: [ false, ], }, }, typeOptions: { minValue: 1, maxValue: 500, }, default: 100, description: 'How many results to return.', }, // ---------------------------------- // dealNote:create // ---------------------------------- { displayName: 'Deal ID', name: 'dealId', type: 'number', default: '', required: true, displayOptions: { show: { operation: [ 'createNote', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal note', }, { displayName: 'Deal Note', name: 'dealNote', type: 'string', default: '', required: true, displayOptions: { show: { operation: [ 'createNote', ], resource: [ 'deal', ], }, }, description: 'The content of the deal note', }, // ---------------------------------- // dealNote:update // ---------------------------------- { displayName: 'Deal ID', name: 'dealId', type: 'number', default: '', required: true, displayOptions: { show: { operation: [ 'updateNote', ], resource: [ 'deal', ], }, }, description: 'The ID of the deal note', }, { displayName: 'Deal Note', name: 'dealNote', type: 'string', default: '', displayOptions: { show: { operation: [ 'updateNote', ], resource: [ 'deal', ], }, }, description: 'The content of the deal note', }, ], }; async execute(this: IExecuteFunctions): Promise { const items = this.getInputData(); const returnData: IDataObject[] = []; let resource: string; let operation: string; // For Post let body: IDataObject; // For Query string let qs: IDataObject; let requestMethod: string; let endpoint: string; let returnAll = false; let dataKey: string | undefined; for (let i = 0; i < items.length; i++) { dataKey = undefined; resource = this.getNodeParameter('resource', 0) as string; operation = this.getNodeParameter('operation', 0) as string; requestMethod = 'GET'; endpoint = ''; body = {} as IDataObject; qs = {} as IDataObject; if (resource === 'contact') { if (operation === 'create') { // ---------------------------------- // contact:create // ---------------------------------- requestMethod = 'POST'; const updateIfExists = this.getNodeParameter('updateIfExists', i) as boolean; if (updateIfExists === true) { endpoint = '/api/3/contact/sync'; } else { endpoint = '/api/3/contacts'; } dataKey = 'contact'; body.contact = { email: this.getNodeParameter('email', i) as string, } as IDataObject; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; addAdditionalFields(body.contact as IDataObject, additionalFields); } else if (operation === 'delete') { // ---------------------------------- // contact:delete // ---------------------------------- requestMethod = 'DELETE'; const contactId = this.getNodeParameter('contactId', i) as number; endpoint = `/api/3/contacts/${contactId}`; } else if (operation === 'get') { // ---------------------------------- // contact:get // ---------------------------------- requestMethod = 'GET'; const contactId = this.getNodeParameter('contactId', i) as number; endpoint = `/api/3/contacts/${contactId}`; } else if (operation === 'getAll') { // ---------------------------------- // persons:getAll // ---------------------------------- requestMethod = 'GET'; returnAll = this.getNodeParameter('returnAll', i) as boolean; if (returnAll === false) { qs.limit = this.getNodeParameter('limit', i) as number; } dataKey = 'contacts'; endpoint = `/api/3/contacts`; } else if (operation === 'update') { // ---------------------------------- // contact:update // ---------------------------------- requestMethod = 'PUT'; const contactId = this.getNodeParameter('contactId', i) as number; endpoint = `/api/3/contacts/${contactId}`; dataKey = 'contact'; body.contact = {} as IDataObject; const updateFields = this.getNodeParameter('updateFields', i) as IDataObject; addAdditionalFields(body.contact as IDataObject, updateFields); } } else if (resource === 'deal') { if (operation === 'create') { // ---------------------------------- // deal:create // ---------------------------------- requestMethod = 'POST'; dataKey = 'deal'; body.deal = { title: this.getNodeParameter('dealTitle', i) as string, contact: this.getNodeParameter('dealContactId', i) as string, value: this.getNodeParameter('dealValue', i) as number, currency: '', } as IDataObject; let currency= this.getNodeParameter('dealCurrency', i) as string if (currency.length === 3) { currency = currency.toLowerCase(); addAdditionalField(body.deal as IDataObject, currency) } else { throw new Error('Currency must be in 3-character ISO format') } let description = this.getNodeParameter('dealDescription', i) as string; if (description.length !== 0){ addAdditionalField(body.deal as IDataObject, description) } let group = this.getNodeParameter('dealGroup', i) as string; if (group.length !== 0){ addAdditionalField(body.deal as IDataObject, group) } let stage = this.getNodeParameter('dealStage', i) as string; if (stage.length !== 0){ addAdditionalField(body.deal as IDataObject, stage) } let percentage = this.getNodeParameter('dealPercentage', i) as number; if (percentage !== 0){ addAdditionalField(body.deal as IDataObject, percentage) } let status = this.getNodeParameter('dealStatus', i) as number; if (status !== 0){ addAdditionalField(body.deal as IDataObject, status) } } else if (operation === 'delete') { // ---------------------------------- // deal:delete // ---------------------------------- requestMethod = 'DELETE'; const dealId = this.getNodeParameter('dealId', i) as number; endpoint = `/api/3/deals/${dealId}`; } else if (operation === 'get') { // ---------------------------------- // deal:get // ---------------------------------- requestMethod = 'GET'; const dealId = this.getNodeParameter('dealId', i) as number; endpoint = `/api/3/deals/${dealId}`; } else if (operation === 'getAll') { // ---------------------------------- // persons:getAll // ---------------------------------- requestMethod = 'GET'; returnAll = this.getNodeParameter('returnAll', i) as boolean; if (returnAll === false) { qs.limit = this.getNodeParameter('limit', i) as number; } dataKey = 'deals'; endpoint = `/api/3/deals`; } else if (operation === 'update') { // ---------------------------------- // deal:update // ---------------------------------- requestMethod = 'PUT'; const dealId = this.getNodeParameter('dealId', i) as number; endpoint = `/api/3/deals/${dealId}`; dataKey = 'deal'; body.deal = {} as IDataObject; const updateFields = this.getNodeParameter('updateFields', i) as IDataObject; addAdditionalFields(body.deal as IDataObject, updateFields); } else { throw new Error(`The resource "${resource}" is not known!`); } let responseData; if (returnAll === true) { responseData = await activeCampaignApiRequestAllItems.call(this, requestMethod, endpoint, body, qs, dataKey); } else { responseData = await activeCampaignApiRequest.call(this, requestMethod, endpoint, body, qs, dataKey); } if (Array.isArray(responseData)) { returnData.push.apply(returnData, responseData as IDataObject[]); } else { returnData.push(responseData as IDataObject); } } return [this.helpers.returnJsonArray(returnData)]; } }