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

94 lines
2.7 KiB
TypeScript
Raw Normal View History

import {
OptionsWithUri,
} from 'request';
2019-11-06 16:58:18 -08:00
import {
IExecuteFunctions,
ILoadOptionsFunctions,
2019-11-06 22:06:19 -08:00
BINARY_ENCODING
2019-11-06 16:58:18 -08:00
} from 'n8n-core';
import {
IDataObject,
} from 'n8n-workflow';
2019-11-06 16:58:18 -08:00
export async function freshdeskApiRequest(this: IExecuteFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, query: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
2019-11-10 14:14:36 -08:00
2019-11-06 22:06:19 -08:00
const credentials = this.getCredentials('freshdeskApi');
2019-11-06 16:58:18 -08:00
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
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}`,
2019-11-06 16:58:18 -08:00
json: true
};
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);
} catch (error) {
if (error.response) {
let errorMessage = error.response.body.message || error.response.body.description || error.message;
if (error.response.body && error.response.body.errors) {
errorMessage = error.response.body.errors.map((err: IDataObject) => `"${err.field}" => ${err.message}`).join(', ');
}
throw new Error(`Freshdesk error response [${error.statusCode}]: ${errorMessage}`);
}
throw error;
}
}
2019-11-06 16:58:18 -08:00
export async function freshdeskApiRequestAllItems(this: IExecuteFunctions | ILoadOptionsFunctions, method: string, endpoint: string, body: any = {}, query: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
2019-11-06 16:58:18 -08:00
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'] !== undefined &&
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 { // tslint:disable-line:no-any
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);
}