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

89 lines
2.2 KiB
TypeScript
Raw Normal View History

import type { OptionsWithUri } from 'request';
2019-11-06 16:58:18 -08:00
import type { IExecuteFunctions, ILoadOptionsFunctions } from 'n8n-core';
import { BINARY_ENCODING } from 'n8n-core';
2019-11-06 16:58:18 -08:00
import type { IDataObject } from 'n8n-workflow';
import { NodeApiError } from 'n8n-workflow';
2019-11-10 14:14:36 -08:00
export async function freshdeskApiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: string,
resource: string,
body: any = {},
query: IDataObject = {},
uri?: string,
option: IDataObject = {},
) {
const credentials = await this.getCredentials('freshdeskApi');
2019-11-06 16:58:18 -08:00
2019-11-10 14:14:36 -08:00
const apiKey = `${credentials.apiKey}:X`;
2019-11-06 16:58:18 -08:00
const endpoint = 'freshdesk.com/api/v2';
2019-11-06 22:06:19 -08:00
let options: OptionsWithUri = {
headers: {
'Content-Type': 'application/json',
Authorization: `${Buffer.from(apiKey).toString(BINARY_ENCODING)}`,
},
2019-11-06 16:58:18 -08:00
method,
2019-11-06 22:06:19 -08:00
body,
qs: query,
uri: uri || `https://${credentials.domain}.${endpoint}${resource}`,
2020-10-22 06:46:03 -07:00
json: true,
2019-11-06 16:58:18 -08:00
};
if (!Object.keys(body).length) {
2019-11-07 10:07:29 -08:00
delete options.body;
2019-11-06 22:06:19 -08:00
}
if (!Object.keys(query).length) {
delete options.qs;
}
options = Object.assign({}, options, option);
2019-11-06 16:58:18 -08:00
try {
return await this.helpers.request(options);
2019-11-06 16:58:18 -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);
}
}
2019-11-06 16:58:18 -08:00
export async function freshdeskApiRequestAllItems(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
body: any = {},
query: IDataObject = {},
) {
const returnData: IDataObject[] = [];
let responseData;
let uri: string | undefined;
query.per_page = 100;
do {
responseData = await freshdeskApiRequest.call(this, method, endpoint, body, query, uri, {
resolveWithFullResponse: true,
});
if (responseData.headers.link) {
uri = responseData.headers.link.split(';')[0].replace('<', '').replace('>', '');
2019-11-06 16:58:18 -08:00
}
returnData.push.apply(returnData, responseData.body);
} while (responseData.headers.link?.includes('rel="next"'));
return returnData;
2019-11-06 16:58:18 -08:00
}
2019-11-08 07:41:10 -08:00
export function validateJSON(json: string | undefined): any {
2019-11-08 07:41:10 -08:00
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = [];
}
return result;
}
2019-11-10 14:14:36 -08:00
export function capitalize(s: string): string {
2019-11-08 07:41:10 -08:00
if (typeof s !== 'string') return '';
return s.charAt(0).toUpperCase() + s.slice(1);
}