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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

105 lines
2.6 KiB
TypeScript
Raw Normal View History

import type {
IDataObject,
2020-01-15 05:55:46 -08:00
IExecuteFunctions,
IHookFunctions,
ILoadOptionsFunctions,
JsonObject,
} from 'n8n-workflow';
import { NodeApiError } from 'n8n-workflow';
import type { OptionsWithUri } from 'request';
2020-02-10 14:04:15 -08:00
export async function mauticApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
body: any = {},
query?: IDataObject,
uri?: string,
): Promise<any> {
2020-06-10 14:37:01 -07:00
const authenticationMethod = this.getNodeParameter('authentication', 0, 'credentials') as string;
2020-01-15 05:55:46 -08:00
const options: OptionsWithUri = {
2020-06-10 14:37:01 -07:00
headers: {},
2020-01-15 05:55:46 -08:00
method,
qs: query,
uri: uri || `/api${endpoint}`,
2020-01-15 05:55:46 -08:00
body,
2020-10-22 06:46:03 -07:00
json: true,
2020-01-15 05:55:46 -08:00
};
2020-06-10 14:37:01 -07:00
2020-01-15 05:55:46 -08:00
try {
2020-06-10 14:37:01 -07:00
let returnData;
if (authenticationMethod === 'credentials') {
const credentials = await this.getCredentials('mauticApi');
const baseUrl = credentials.url as string;
options.uri = `${baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl}${options.uri}`;
2020-06-10 14:37:01 -07:00
//@ts-ignore
returnData = await this.helpers.requestWithAuthentication.call(this, 'mauticApi', options);
2020-06-10 14:37:01 -07:00
} else {
const credentials = await this.getCredentials('mauticOAuth2Api');
const baseUrl = credentials.url as string;
2020-06-10 14:37:01 -07:00
options.uri = `${baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl}${options.uri}`;
2020-06-10 14:37:01 -07:00
//@ts-ignore
returnData = await this.helpers.requestOAuth2.call(this, 'mauticOAuth2Api', options, {
includeCredentialsOnRefreshOnBody: true,
});
2020-06-10 14:37:01 -07:00
}
if (returnData.errors) {
2020-02-10 14:04:15 -08:00
// They seem to to sometimes return 200 status but still error.
throw new NodeApiError(this.getNode(), returnData as JsonObject);
2020-02-10 14:04:15 -08:00
}
2020-01-15 05:55:46 -08:00
2020-02-10 14:04:15 -08:00
return returnData;
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
2020-01-15 05:55:46 -08:00
}
}
/**
* Make an API request to paginated mautic endpoint
* and return all results
*/
export async function mauticApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
propertyName: string,
method: string,
endpoint: string,
body: any = {},
query: IDataObject = {},
): Promise<any> {
2020-01-15 05:55:46 -08:00
const returnData: IDataObject[] = [];
let responseData;
query.limit = 30;
query.start = 0;
do {
responseData = await mauticApiRequest.call(this, method, endpoint, body, query);
const values = Object.values(responseData[propertyName] as IDataObject[]);
//@ts-ignore
returnData.push.apply(returnData, values);
query.start += query.limit;
2020-01-15 05:55:46 -08:00
} while (
responseData.total !== undefined &&
returnData.length - parseInt(responseData.total as string, 10) < 0
);
2020-01-15 05:55:46 -08:00
return returnData;
}
export function validateJSON(json: string | undefined): any {
2020-01-15 05:55:46 -08:00
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = undefined;
}
return result;
}