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

85 lines
2.4 KiB
TypeScript
Raw Normal View History

2020-04-06 16:11:50 -07:00
import {
OptionsWithUri,
} from 'request';
2020-01-05 10:34:09 -08:00
import {
IExecuteFunctions,
IExecuteSingleFunctions,
2020-01-05 10:34:09 -08:00
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
2020-04-06 16:11:50 -07:00
import {
IDataObject,
} from 'n8n-workflow';
2020-01-05 10:34:09 -08:00
export async function zendeskApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('zendeskApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
const base64Key = Buffer.from(`${credentials.email}/token:${credentials.apiToken}`).toString('base64');
2020-01-05 10:34:09 -08:00
let options: OptionsWithUri = {
headers: { 'Authorization': `Basic ${base64Key}`},
method,
qs,
body,
2020-01-06 16:30:40 -08:00
uri: uri ||`${credentials.url}/api/v2${resource}.json`,
2020-01-05 10:34:09 -08:00
json: true
};
options = Object.assign({}, options, option);
if (Object.keys(options.body).length === 0) {
delete options.body;
}
try {
return await this.helpers.request!(options);
2020-01-05 18:32:22 -08:00
} catch (err) {
let errorMessage = err.message;
if (err.response && err.response.body && err.response.body.error) {
errorMessage = err.response.body.error;
if (typeof err.response.body.error !== 'string') {
errorMessage = JSON.stringify(errorMessage);
}
}
2020-04-06 16:11:50 -07:00
throw new Error(`Zendesk error response [${err.statusCode}]: ${errorMessage}`);
2020-01-05 10:34:09 -08:00
}
}
2020-01-06 16:30:40 -08:00
/**
* Make an API request to paginated flow endpoint
* and return all results
*/
export async function zendeskApiRequestAllItems(this: IHookFunctions | IExecuteFunctions| ILoadOptionsFunctions, propertyName: string, method: string, resource: string, body: any = {}, query: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const returnData: IDataObject[] = [];
let responseData;
let uri: string | undefined;
do {
responseData = await zendeskApiRequest.call(this, method, resource, body, query, uri);
uri = responseData.next_page;
2020-01-06 16:30:40 -08:00
returnData.push.apply(returnData, responseData[propertyName]);
2020-04-09 13:13:14 -07:00
if (query.limit && query.limit <= returnData.length) {
return returnData;
}
2020-01-06 16:30:40 -08:00
} while (
responseData.next_page !== undefined &&
responseData.next_page !== null
);
return returnData;
}
2020-04-09 13:13:14 -07:00
export function validateJSON(json: string | undefined): any { // tslint:disable-line:no-any
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = undefined;
}
return result;
}