n8n/packages/nodes-base/nodes/BambooHr/v1/transport/index.ts
Elias Meire 100d9bc087
refactor: Add IRequestOptions type to helpers.request for more type safety (no-changelog) (#8563)
Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
2024-02-14 16:29:09 +01:00

64 lines
1.4 KiB
TypeScript

import type {
IDataObject,
IExecuteFunctions,
IHookFunctions,
ILoadOptionsFunctions,
JsonObject,
IRequestOptions,
} from 'n8n-workflow';
import { NodeApiError } from 'n8n-workflow';
/**
* Make an API request to Mattermost
*/
export async function apiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: 'GET' | 'POST' | 'PUT' | 'DELETE',
endpoint: string,
body: string[] | IDataObject = {},
query: IDataObject = {},
option: IDataObject = {},
) {
const credentials = await this.getCredentials('bambooHrApi');
//set-up credentials
const apiKey = credentials.apiKey;
const subdomain = credentials.subdomain;
//set-up uri
const uri = `https://api.bamboohr.com/api/gateway.php/${subdomain}/v1/${endpoint}`;
const options: IRequestOptions = {
method,
body,
qs: query,
url: uri,
auth: {
username: apiKey as string,
password: 'x',
},
json: true,
};
if (Object.keys(option).length) {
Object.assign(options, option);
}
if (!Object.keys(body).length) {
delete options.body;
}
if (!Object.keys(query).length) {
delete options.qs;
}
try {
//@ts-ignore
return await this.helpers.request(options);
} catch (error) {
const description = error?.response?.headers['x-bamboohr-error-messsage'] || '';
const message = error?.message || '';
throw new NodeApiError(this.getNode(), error as JsonObject, { message, description });
}
}