mirror of
https://github.com/n8n-io/n8n.git
synced 2024-11-10 22:54:05 -08:00
88dea330b9
* ⚡ Update `lintfix` script * ⚡ Run baseline `lintfix` * 🔥 Remove unneeded exceptions (#3538) * 🔥 Remove exceptions for `node-param-default-wrong-for-simplify` * 🔥 Remove exceptions for `node-param-placeholder-miscased-id` * ⚡ Update version * 👕 Apply `node-param-placeholder-missing` (#3542) * 👕 Apply `filesystem-wrong-cred-filename` (#3543) * 👕 Apply `node-param-description-missing-from-dynamic-options` (#3545) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * 👕 Apply `node-class-description-empty-string` (#3546) * 👕 Apply `node-class-description-icon-not-svg` (#3548) * 👕 Apply `filesystem-wrong-node-filename` (#3549) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * 👕 Expand lintings to credentials (#3550) * 👕 Apply `node-param-multi-options-type-unsorted-items` (#3552) * ⚡ fix * ⚡ Minor fixes Co-authored-by: Michael Kret <michael.k@radency.com> * 👕 Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541) * ⚡ Add new lint rule, node-param-description-wrong-for-dynamic-multi-options * ⚡ Fix with updated linting rules * ⚡ Minor fixes Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * 👕 Apply `node-param-description-boolean-without-whether` (#3553) * ⚡ fix * Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * 👕 Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537) * 👕 Add exceptions * 👕 Add exception * ✏️ Alphabetize rules * ⚡ Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com> Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com> Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
327 lines
8.7 KiB
TypeScript
327 lines
8.7 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
INodeExecutionData,
|
|
INodePropertyOptions,
|
|
INodeType,
|
|
INodeTypeDescription,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
getresponseApiRequest,
|
|
getResponseApiRequestAllItems,
|
|
} from './GenericFunctions';
|
|
|
|
import {
|
|
contactFields,
|
|
contactOperations,
|
|
} from './ContactDescription';
|
|
|
|
import moment from 'moment-timezone';
|
|
|
|
export class GetResponse implements INodeType {
|
|
description: INodeTypeDescription = {
|
|
displayName: 'GetResponse',
|
|
name: 'getResponse',
|
|
// eslint-disable-next-line n8n-nodes-base/node-class-description-icon-not-svg
|
|
icon: 'file:getResponse.png',
|
|
group: ['input'],
|
|
version: 1,
|
|
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
|
|
description: 'Consume GetResponse API',
|
|
defaults: {
|
|
name: 'GetResponse',
|
|
},
|
|
inputs: ['main'],
|
|
outputs: ['main'],
|
|
credentials: [
|
|
{
|
|
name: 'getResponseApi',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
authentication: [
|
|
'apiKey',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: 'getResponseOAuth2Api',
|
|
required: true,
|
|
displayOptions: {
|
|
show: {
|
|
authentication: [
|
|
'oAuth2',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
],
|
|
properties: [
|
|
{
|
|
displayName: 'Authentication',
|
|
name: 'authentication',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
name: 'API Key',
|
|
value: 'apiKey',
|
|
},
|
|
{
|
|
name: 'OAuth2',
|
|
value: 'oAuth2',
|
|
},
|
|
],
|
|
default: 'apiKey',
|
|
},
|
|
{
|
|
displayName: 'Resource',
|
|
name: 'resource',
|
|
type: 'options',
|
|
noDataExpression: true,
|
|
options: [
|
|
{
|
|
name: 'Contact',
|
|
value: 'contact',
|
|
},
|
|
],
|
|
default: 'contact',
|
|
},
|
|
...contactOperations,
|
|
...contactFields,
|
|
],
|
|
};
|
|
|
|
methods = {
|
|
loadOptions: {
|
|
// Get all the campaigns to display them to user so that he can
|
|
// select them easily
|
|
async getCampaigns(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const campaigns = await getresponseApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/campaigns`,
|
|
);
|
|
for (const campaign of campaigns) {
|
|
returnData.push({
|
|
name: campaign.name as string,
|
|
value: campaign.campaignId,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
// Get all the tagd to display them to user so that he can
|
|
// select them easily
|
|
async getTags(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const tags = await getresponseApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/tags`,
|
|
);
|
|
for (const tag of tags) {
|
|
returnData.push({
|
|
name: tag.name as string,
|
|
value: tag.tagId,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
// Get all the custom fields to display them to user so that he can
|
|
// select them easily
|
|
async getCustomFields(
|
|
this: ILoadOptionsFunctions,
|
|
): Promise<INodePropertyOptions[]> {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
const customFields = await getresponseApiRequest.call(
|
|
this,
|
|
'GET',
|
|
`/custom-fields`,
|
|
);
|
|
for (const customField of customFields) {
|
|
returnData.push({
|
|
name: customField.name as string,
|
|
value: customField.customFieldId,
|
|
});
|
|
}
|
|
return returnData;
|
|
},
|
|
},
|
|
};
|
|
|
|
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
|
|
const items = this.getInputData();
|
|
const returnData: IDataObject[] = [];
|
|
const length = items.length;
|
|
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 < length; i++) {
|
|
try {
|
|
if (resource === 'contact') {
|
|
//https://apireference.getresponse.com/#operation/createContact
|
|
if (operation === 'create') {
|
|
const email = this.getNodeParameter('email', i) as string;
|
|
|
|
const campaignId = this.getNodeParameter('campaignId', i) as string;
|
|
|
|
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
|
|
|
|
const body: IDataObject = {
|
|
email,
|
|
campaign: {
|
|
campaignId,
|
|
},
|
|
};
|
|
|
|
Object.assign(body, additionalFields);
|
|
|
|
if (additionalFields.customFieldsUi) {
|
|
const customFieldValues = (additionalFields.customFieldsUi as IDataObject).customFieldValues as IDataObject[];
|
|
if (customFieldValues) {
|
|
body.customFieldValues = customFieldValues;
|
|
for (let i = 0; i < customFieldValues.length; i++) {
|
|
if (!Array.isArray(customFieldValues[i].value)) {
|
|
customFieldValues[i].value = [customFieldValues[i].value];
|
|
}
|
|
}
|
|
delete body.customFieldsUi;
|
|
}
|
|
}
|
|
|
|
responseData = await getresponseApiRequest.call(this, 'POST', '/contacts', body);
|
|
|
|
responseData = { success: true };
|
|
}
|
|
//https://apireference.getresponse.com/?_ga=2.160836350.2102802044.1604719933-1897033509.1604598019#operation/deleteContact
|
|
if (operation === 'delete') {
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
responseData = await getresponseApiRequest.call(this, 'DELETE', `/contacts/${contactId}`, {}, qs);
|
|
|
|
responseData = { success: true };
|
|
}
|
|
//https://apireference.getresponse.com/?_ga=2.160836350.2102802044.1604719933-1897033509.1604598019#operation/getContactById
|
|
if (operation === 'get') {
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
Object.assign(qs, options);
|
|
|
|
responseData = await getresponseApiRequest.call(this, 'GET', `/contacts/${contactId}`, {}, qs);
|
|
}
|
|
//https://apireference.getresponse.com/?_ga=2.160836350.2102802044.1604719933-1897033509.1604598019#operation/getContactList
|
|
if (operation === 'getAll') {
|
|
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
|
|
|
|
const options = this.getNodeParameter('options', i) as IDataObject;
|
|
|
|
const timezone = this.getTimezone();
|
|
|
|
Object.assign(qs, options);
|
|
|
|
const isNotQuery = [
|
|
'sortBy',
|
|
'sortOrder',
|
|
'additionalFlags',
|
|
'fields',
|
|
'exactMatch',
|
|
];
|
|
|
|
const isDate = [
|
|
'createdOnFrom',
|
|
'createdOnTo',
|
|
'changeOnFrom',
|
|
'changeOnTo',
|
|
];
|
|
|
|
const dateMapToKey: { [key: string]: string; } = {
|
|
'createdOnFrom': '[createdOn][from]',
|
|
'createdOnTo': '[createdOn][to]',
|
|
'changeOnFrom': '[changeOn][from]',
|
|
'changeOnTo': '[changeOn][to]',
|
|
};
|
|
|
|
for (const key of Object.keys(qs)) {
|
|
if (!isNotQuery.includes(key)) {
|
|
if (isDate.includes(key)) {
|
|
qs[`query${dateMapToKey[key]}`] = moment.tz(qs[key], timezone).format('YYYY-MM-DDTHH:mm:ssZZ');
|
|
} else {
|
|
qs[`query[${key}]`] = qs[key];
|
|
}
|
|
delete qs[key];
|
|
}
|
|
}
|
|
|
|
if (qs.sortBy) {
|
|
qs[`sort[${qs.sortBy}]`] = qs.sortOrder || 'ASC';
|
|
}
|
|
|
|
if (qs.exactMatch === true) {
|
|
qs['additionalFlags'] = 'exactMatch';
|
|
delete qs.exactMatch;
|
|
}
|
|
|
|
if (returnAll) {
|
|
responseData = await getResponseApiRequestAllItems.call(this, 'GET', `/contacts`, {}, qs);
|
|
} else {
|
|
qs.perPage = this.getNodeParameter('limit', i) as number;
|
|
responseData = await getresponseApiRequest.call(this, 'GET', `/contacts`, {}, qs);
|
|
}
|
|
}
|
|
//https://apireference.getresponse.com/?_ga=2.160836350.2102802044.1604719933-1897033509.1604598019#operation/updateContact
|
|
if (operation === 'update') {
|
|
|
|
const contactId = this.getNodeParameter('contactId', i) as string;
|
|
|
|
const updateFields = this.getNodeParameter('updateFields', i) as IDataObject;
|
|
|
|
const body: IDataObject = {};
|
|
|
|
Object.assign(body, updateFields);
|
|
|
|
if (updateFields.customFieldsUi) {
|
|
const customFieldValues = (updateFields.customFieldsUi as IDataObject).customFieldValues as IDataObject[];
|
|
if (customFieldValues) {
|
|
body.customFieldValues = customFieldValues;
|
|
delete body.customFieldsUi;
|
|
}
|
|
}
|
|
|
|
responseData = await getresponseApiRequest.call(this, 'POST', `/contacts/${contactId}`, body);
|
|
}
|
|
}
|
|
if (Array.isArray(responseData)) {
|
|
returnData.push.apply(returnData, responseData as IDataObject[]);
|
|
|
|
} else if (responseData !== undefined) {
|
|
returnData.push(responseData as IDataObject);
|
|
}
|
|
} catch (error) {
|
|
if (this.continueOnFail()) {
|
|
returnData.push({ error: error.message });
|
|
continue;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
return [this.helpers.returnJsonArray(returnData)];
|
|
}
|
|
}
|