n8n/packages/nodes-base/nodes/AgileCrm/GenericFunctions.ts

241 lines
6.3 KiB
TypeScript
Raw Normal View History

import { OptionsWithUri } from 'request';
2020-04-30 05:03:36 -07:00
import {
IExecuteFunctions,
IExecuteSingleFunctions,
2020-04-30 05:03:36 -07:00
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import { IDataObject, NodeApiError } from 'n8n-workflow';
import { IContactUpdate } from './ContactInterface';
import { IFilterRules, ISearchConditions } from './FilterInterface';
export async function agileCrmApiRequest(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
// tslint:disable-next-line:no-any
body: any = {},
query: IDataObject = {},
uri?: string,
sendAsForm?: boolean,
// tslint:disable-next-line:no-any
): Promise<any> {
const credentials = await this.getCredentials('agileCrmApi');
2020-04-30 05:03:36 -07:00
const options: OptionsWithUri = {
method,
headers: {
Accept: 'application/json',
2020-04-30 05:03:36 -07:00
},
2020-05-11 11:22:31 -07:00
auth: {
username: credentials.email as string,
password: credentials.apiKey as string,
2020-04-30 05:03:36 -07:00
},
qs: query,
uri: uri || `https://${credentials.subdomain}.agilecrm.com/dev/${endpoint}`,
2020-05-11 11:22:31 -07:00
json: true,
2020-04-30 05:03:36 -07:00
};
// To send the request as 'content-type': 'application/x-www-form-urlencoded' add form to options instead of body
if (sendAsForm) {
options.form = body;
}
2020-05-04 06:14:22 -07:00
// Only add Body property if method not GET or DELETE to avoid 400 response
// And when not sending a form
else if (method !== 'GET' && method !== 'DELETE') {
2020-05-02 04:59:17 -07:00
options.body = body;
}
2020-04-30 05:03:36 -07:00
try {
return await this.helpers.request!(options);
} catch (error) {
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
throw new NodeApiError(this.getNode(), error);
2020-04-30 05:03:36 -07:00
}
}
2020-05-05 02:08:30 -07:00
export async function agileCrmApiRequestAllItems(
this: IHookFunctions | ILoadOptionsFunctions | IExecuteFunctions,
method: string,
resource: string,
// tslint:disable-next-line:no-any
body: any = {},
query: IDataObject = {},
uri?: string,
sendAsForm?: boolean,
// tslint:disable-next-line:no-any
): Promise<any> {
// https://github.com/agilecrm/rest-api#11-listing-contacts-
const returnData: IDataObject[] = [];
let responseData;
do {
responseData = await agileCrmApiRequest.call(
this,
method,
resource,
body,
query,
uri,
sendAsForm,
);
if (responseData.length !== 0) {
returnData.push.apply(returnData, responseData);
if (sendAsForm) {
body.cursor = responseData[responseData.length - 1].cursor;
} else {
query.cursor = responseData[responseData.length - 1].cursor;
}
}
} while (
responseData.length !== 0 &&
responseData[responseData.length - 1].hasOwnProperty('cursor')
);
return returnData;
2020-05-05 02:08:30 -07:00
}
export async function agileCrmApiRequestUpdate(
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions,
method = 'PUT',
endpoint?: string,
// tslint:disable-next-line:no-any
body: any = {},
_query: IDataObject = {},
uri?: string,
// tslint:disable-next-line:no-any
): Promise<any> {
const credentials = await this.getCredentials('agileCrmApi');
const baseUri = `https://${credentials.subdomain}.agilecrm.com/dev/`;
2020-05-05 02:08:30 -07:00
const options: OptionsWithUri = {
method,
headers: {
Accept: 'application/json',
2020-05-05 02:08:30 -07:00
},
2020-05-11 11:22:31 -07:00
body: { id: body.id },
auth: {
username: credentials.email as string,
password: credentials.apiKey as string,
2020-05-05 02:08:30 -07:00
},
uri: uri || baseUri,
2020-05-11 11:22:31 -07:00
json: true,
2020-05-05 02:08:30 -07:00
};
2020-05-11 11:22:31 -07:00
const successfulUpdates = [];
let lastSuccesfulUpdateReturn: any; // tslint:disable-line:no-any
const payload: IContactUpdate = body;
2020-05-05 02:08:30 -07:00
try {
// Due to API, we must update each property separately. For user it looks like one seamless update
2020-05-11 11:22:31 -07:00
if (payload.properties) {
2020-05-05 02:08:30 -07:00
options.body.properties = payload.properties;
options.uri = baseUri + 'api/contacts/edit-properties';
lastSuccesfulUpdateReturn = await this.helpers.request!(options);
// Iterate trough properties and show them as individial updates instead of only vague "properties"
// tslint:disable-next-line:no-any
payload.properties?.map((property: any) => {
2020-05-11 11:22:31 -07:00
successfulUpdates.push(`${property.name}`);
2020-05-06 01:27:01 -07:00
});
2020-05-05 02:08:30 -07:00
delete options.body.properties;
}
2020-05-11 11:22:31 -07:00
if (payload.lead_score) {
2020-05-05 02:08:30 -07:00
options.body.lead_score = payload.lead_score;
options.uri = baseUri + 'api/contacts/edit/lead-score';
lastSuccesfulUpdateReturn = await this.helpers.request!(options);
successfulUpdates.push('lead_score');
delete options.body.lead_score;
}
2020-05-11 11:22:31 -07:00
if (body.tags) {
2020-05-05 02:08:30 -07:00
options.body.tags = payload.tags;
2020-05-05 02:10:27 -07:00
options.uri = baseUri + 'api/contacts/edit/tags';
2020-05-05 02:08:30 -07:00
lastSuccesfulUpdateReturn = await this.helpers.request!(options);
2020-05-11 11:22:31 -07:00
payload.tags?.map((tag: string) => {
successfulUpdates.push(`(Tag) ${tag}`);
2020-05-06 01:27:01 -07:00
});
2020-05-05 02:08:30 -07:00
delete options.body.tags;
}
2020-05-11 11:22:31 -07:00
if (body.star_value) {
2020-05-05 02:08:30 -07:00
options.body.star_value = payload.star_value;
options.uri = baseUri + 'api/contacts/edit/add-star';
lastSuccesfulUpdateReturn = await this.helpers.request!(options);
successfulUpdates.push('star_value');
delete options.body.star_value;
}
return lastSuccesfulUpdateReturn;
} catch (error) {
2020-05-11 11:22:31 -07:00
if (successfulUpdates.length === 0) {
:sparkles: Improve node error handling (#1309) * Add path mapping and response error interfaces * Add error handling and throwing functionality * Refactor error handling into a single function * Re-implement error handling in Hacker News node * Fix linting details * Re-implement error handling in Spotify node * Re-implement error handling in G Suite Admin node * :construction: create basic setup NodeError * :construction: add httpCodes * :construction: add path priolist * :construction: handle statusCode in error, adjust interfaces * :construction: fixing type issues w/Ivan * :construction: add error exploration * 👔 fix linter issues * :wrench: improve object check * :construction: remove path passing from NodeApiError * :construction: add multi error + refactor findProperty method * 👔 allow any * :wrench: handle multi error message callback * :zap: change return type of callback * :zap: add customCallback to MultiError * :construction: refactor to use INode * :hammer: handle arrays, continue search after first null property found * 🚫 refactor method access * :construction: setup NodeErrorView * :zap: change timestamp to Date.now * :books: Add documentation for methods and constants * :construction: change message setting * 🚚 move NodeErrors to workflow * :sparkles: add new ErrorView for Nodes * :art: improve error notification * :art: refactor interfaces * :zap: add WorkflowOperationError, refactor error throwing * 👕 fix linter issues * :art: rename param * :bug: fix handling normal errors * :zap: add usage of NodeApiError * :art: fix throw new error instead of constructor * :art: remove unnecessary code/comments * :art: adjusted spacing + updated status messages * :art: fix tab indentation * ✨ Replace current errors with custom errors (#1576) * :zap: Introduce NodeApiError in catch blocks * :zap: Introduce NodeOperationError in nodes * :zap: Add missing errors and remove incompatible * :zap: Fix NodeOperationError in incompatible nodes * :wrench: Adjust error handling in missed nodes PayPal, FileMaker, Reddit, Taiga and Facebook Graph API nodes * :hammer: Adjust Strava Trigger node error handling * :hammer: Adjust AWS nodes error handling * :hammer: Remove duplicate instantiation of NodeApiError * :bug: fix strava trigger node error handling * Add XML parsing to NodeApiError constructor (#1633) * :bug: Remove type annotation from catch variable * :sparkles: Add XML parsing to NodeApiError * :zap: Simplify error handling in Rekognition node * :zap: Pass in XML flag in generic functions * :fire: Remove try/catch wrappers at call sites * :hammer: Refactor setting description from XML * :hammer: Refactor let to const in resource loaders * :zap: Find property in parsed XML * :zap: Change let to const * :fire: Remove unneeded try/catch block * :shirt: Fix linting issues * :bug: Fix errors from merge conflict resolution * :zap: Add custom errors to latest contributions * :shirt: Fix linting issues * :zap: Refactor MongoDB helpers for custom errors * :bug: Correct custom error type * :zap: Apply feedback to A nodes * :zap: Apply feedback to missed A node * :zap: Apply feedback to B-D nodes * :zap: Apply feedback to E-F nodes * :zap: Apply feedback to G nodes * :zap: Apply feedback to H-L nodes * :zap: Apply feedback to M nodes * :zap: Apply feedback to P nodes * :zap: Apply feedback to R nodes * :zap: Apply feedback to S nodes * :zap: Apply feedback to T nodes * :zap: Apply feedback to V-Z nodes * :zap: Add HTTP code to iterable node error * :hammer: Standardize e as error * :hammer: Standardize err as error * :zap: Fix error handling for non-standard nodes Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <b.hesseldieck@gmail.com> Co-authored-by: Ben Hesseldieck <1849459+BHesseldieck@users.noreply.github.com>
2021-04-16 09:33:36 -07:00
throw new NodeApiError(this.getNode(), error);
2020-05-11 11:22:31 -07:00
} else {
throw new NodeApiError(this.getNode(), error, {
message: `Not all properties updated. Updated properties: ${successfulUpdates.join(', ')}`,
description: error.message,
httpCode: error.statusCode,
});
2020-05-05 02:08:30 -07:00
}
}
2020-04-30 05:03:36 -07:00
}
// tslint:disable-next-line:no-any
export function validateJSON(json: string | undefined): any {
2020-04-30 05:03:36 -07:00
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = undefined;
}
return result;
}
export function getFilterRules(conditions: ISearchConditions[], matchType: string): IDataObject {
const rules = [];
for (const key in conditions) {
if (conditions.hasOwnProperty(key)) {
const searchConditions: ISearchConditions = conditions[key] as ISearchConditions;
const rule: IFilterRules = {
LHS: searchConditions.field,
CONDITION: searchConditions.condition_type,
RHS: searchConditions.value as string,
RHS_NEW: searchConditions.value2 as string,
};
rules.push(rule);
}
}
if (matchType === 'anyFilter') {
return {
or_rules: rules,
};
} else {
return {
rules,
};
}
}
export function simplifyResponse(
records: [{ id: string; properties: [{ name: string; value: string }] }],
) {
const results = [];
for (const record of records) {
results.push(
record.properties.reduce(
(obj, value) => Object.assign(obj, { [`${value.name}`]: value.value }),
{ id: record.id },
),
);
}
return results;
}