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

217 lines
5.5 KiB
TypeScript
Raw Normal View History

import {
OptionsWithUri,
} from 'request';
2020-02-12 07:04:43 -08:00
import {
IExecuteFunctions,
2021-04-29 02:56:19 -07:00
IHookFunctions,
2020-02-12 07:04:43 -08:00
} from 'n8n-core';
2021-04-29 02:56:19 -07:00
2020-02-12 07:04:43 -08:00
import {
2021-04-29 02:56:19 -07:00
IDataObject,
NodeApiError,
2020-02-12 07:04:43 -08:00
} from 'n8n-workflow';
2021-04-29 02:56:19 -07:00
import {
flow,
} from 'lodash';
export async function zohoApiRequest(
this: IExecuteFunctions | IHookFunctions,
method: string,
endpoint: string,
body: IDataObject = {},
qs: IDataObject = {},
uri?: string,
) {
const operation = this.getNodeParameter('operation', 0) as string;
const { oauthTokenData: { api_domain: apiDomain } } = this.getCredentials('zohoOAuth2Api') as { oauthTokenData: { api_domain: string} };
2021-04-29 02:56:19 -07:00
2020-02-12 07:04:43 -08:00
const options: OptionsWithUri = {
body: {
data: [
body,
],
},
2021-04-29 02:56:19 -07:00
method,
2020-02-12 07:04:43 -08:00
qs,
uri: uri ?? `${apiDomain}/crm/v2${endpoint}`,
2020-10-22 06:46:03 -07:00
json: true,
2020-02-12 07:04:43 -08:00
};
2021-04-29 02:56:19 -07:00
if (!Object.keys(body).length) {
delete options.body;
}
if (!Object.keys(qs).length) {
delete options.qs;
}
2020-02-12 07:04:43 -08:00
try {
console.log(JSON.stringify(options, null, 2));
2021-04-29 02:56:19 -07:00
const responseData = await this.helpers.requestOAuth2.call(this, 'zohoOAuth2Api', options);
return operation === 'getAll' ? responseData : responseData.data;
2020-02-12 07:04:43 -08:00
} 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-02-12 07:04:43 -08:00
}
}
2021-04-29 02:56:19 -07:00
/**
* Make an authenticated API request to Zoho CRM API and return all items.
*/
export async function zohoApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions,
method: string,
endpoint: string,
body: IDataObject,
qs: IDataObject,
) {
2020-02-12 07:04:43 -08:00
const returnData: IDataObject[] = [];
let responseData;
let uri: string | undefined;
2021-04-29 02:56:19 -07:00
qs.per_page = 200;
qs.page = 0;
2020-02-12 07:04:43 -08:00
do {
2021-04-29 02:56:19 -07:00
responseData = await zohoApiRequest.call(this, method, endpoint, body, qs, uri);
2020-02-15 16:23:22 -08:00
uri = responseData.info.more_records;
2021-04-29 02:56:19 -07:00
returnData.push.apply(returnData, responseData['data']);
qs.page++;
2020-02-12 07:04:43 -08:00
} while (
2020-02-15 16:23:22 -08:00
responseData.info.more_records !== undefined &&
responseData.info.more_records === true
2020-02-12 07:04:43 -08:00
);
return returnData;
2020-02-12 07:04:43 -08:00
}
2021-04-29 02:56:19 -07:00
/**
* Handle a Zoho CRM API listing by returning all items or up to a limit.
*/
export async function handleListing(
this: IExecuteFunctions,
method: string,
endpoint: string,
body: IDataObject = {},
qs: IDataObject = {},
) {
let responseData;
2021-05-09 05:43:57 -07:00
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
2021-04-29 02:56:19 -07:00
if (returnAll) {
return await zohoApiRequestAllItems.call(this, method, endpoint, body, qs);
}
const limit = this.getNodeParameter('limit', 0) as number;
responseData = await zohoApiRequestAllItems.call(this, method, endpoint, body, qs);
return responseData.slice(0, limit);
}
// ----------------------------------------
// field adjusters
// ----------------------------------------
/**
* Place a location field's contents at the top level of the payload.
*/
2021-05-09 05:43:57 -07:00
const adjustLocationFields = (locationType: LocationType) => (allFields: AllFields) => {
2021-04-29 02:56:19 -07:00
const locationField = allFields[locationType];
2021-05-09 05:43:57 -07:00
if (!locationField) return allFields;
return {
...omit(locationType, allFields),
...locationField.address_fields,
};
2021-04-29 02:56:19 -07:00
};
const adjustAddressFields = adjustLocationFields('Address');
const adjustBillingAddressFields = adjustLocationFields('Billing_Address');
const adjustMailingAddressFields = adjustLocationFields('Mailing_Address');
const adjustShippingAddressFields = adjustLocationFields('Shipping_Address');
const adjustOtherAddressFields = adjustLocationFields('Other_Address');
2021-05-07 04:19:01 -07:00
/**
2021-05-09 06:19:25 -07:00
* Remove from a date field the timestamp set by the datepicker.
2021-05-07 04:19:01 -07:00
*/
2021-05-09 05:43:57 -07:00
const adjustDateField = (dateType: DateType) => (allFields: AllFields) => {
2021-05-07 04:19:01 -07:00
const dateField = allFields[dateType];
if (!dateField) return allFields;
allFields[dateType] = dateField.split('T')[0];
2021-05-07 01:58:12 -07:00
return allFields;
};
2021-05-07 04:19:01 -07:00
const adjustDateOfBirthField = adjustDateField('Date_of_Birth');
const adjustClosingDateField = adjustDateField('Closing_Date');
2021-05-07 08:28:42 -07:00
const adjustInvoiceDateField = adjustDateField('Invoice_Date');
const adjustDueDateField = adjustDateField('Due_Date');
2021-05-09 05:43:57 -07:00
/**
* Place an account name field's contents at the top level of the payload.
*/
const adjustAccountField = (allFields: AllFields) => {
2021-05-07 08:28:42 -07:00
if (!allFields.Account_Name) return allFields;
2021-05-09 05:43:57 -07:00
return {
...omit('Account_Name', allFields),
...allFields.Account_Name.account_name_fields,
};
2021-05-07 08:28:42 -07:00
};
export const adjustAccountFields = flow(
adjustBillingAddressFields,
adjustShippingAddressFields,
);
export const adjustContactFields = flow(
adjustMailingAddressFields,
adjustOtherAddressFields,
adjustDateOfBirthField,
);
2021-05-07 04:19:01 -07:00
export const adjustDealFields = adjustClosingDateField;
2021-05-07 08:28:42 -07:00
export const adjustInvoiceFields = flow(
adjustBillingAddressFields,
adjustShippingAddressFields,
adjustInvoiceDateField,
adjustDueDateField,
adjustAccountField,
);
2021-04-29 02:56:19 -07:00
export const adjustLeadFields = adjustAddressFields;
2021-05-07 08:28:42 -07:00
2021-04-29 02:56:19 -07:00
export const adjustPurchaseOrderFields = adjustInvoiceFields;
2021-05-07 08:28:42 -07:00
2021-04-29 02:56:19 -07:00
export const adjustQuoteFields = adjustInvoiceFields;
2021-05-07 08:28:42 -07:00
2021-04-29 02:56:19 -07:00
export const adjustSalesOrderFields = adjustInvoiceFields;
// ----------------------------------------
// helpers
// ----------------------------------------
2021-05-09 05:43:57 -07:00
const omit = (keyToOmit: string, { [keyToOmit]: _, ...omittedPropObj }) => omittedPropObj;
2021-04-29 02:56:19 -07:00
// ----------------------------------------
// types
// ----------------------------------------
type LocationType = 'Address' | 'Billing_Address' | 'Mailing_Address' | 'Shipping_Address' | 'Other_Address';
2021-05-07 08:28:42 -07:00
type DateType = 'Date_of_Birth' | 'Closing_Date' | 'Due_Date' | 'Invoice_Date';
2021-05-07 04:19:01 -07:00
2021-05-09 05:43:57 -07:00
export type AllFields =
{ [Date in DateType]?: string } &
{ [Location in LocationType]?: { address_fields: { [key: string]: string } } } &
{ Account_Name?: { account_name_fields: { [key: string]: string } } } &
IDataObject;