n8n/packages/nodes-base/nodes/BambooHr/v1/transport/index.ts

60 lines
1.4 KiB
TypeScript
Raw Normal View History

import { IExecuteFunctions, IHookFunctions, ILoadOptionsFunctions } from 'n8n-core';
:sparkles: Add BambooHR Node (#2471) * Feature // Created BambooHR Node, Init Simple Api Calls for Employees * BambooHR Added EmployeesFiles, CompanyFiles API Operations * BambooHR / Refactor the code * Bamboo HR Node // Refactor + Optimization of Employee Api Requests * Bamboo HR Node // Refactor + Optimization of EmployeeFiles Api Requests * Bamboo HR Node // Refactor + Optimization of CompanyFiles Api Requests * Bamboo HR Node // Add Reports - Get Reports by ID * Bamboo HR Node // Format BambooAPI Credential files * Bamboo HR Node // Added Account Information API operations * Bamboo HR Node //Add Https Reposnse Code for All API Operations, Implement new Http Helper * Bamboo HR Node // Added Tabular Data Api Operations * Bamboo HR Node // Added Time Off Api Operations * Bamboo HR Node //Fixed bugs for AccountInformation Operation, Uploading Employees File, TimeOff EstimationTime * Bamboo HR Node // Update AccountInformation - UpdateFields Api operation * Bamboo HR Node //Fixed Add and Update Table rows // Tabular Data API Operations * Update AccountInformation - Added TimeOff Operations - Get Requests, Create Request, Create History Item, Fixed Get Types * Bamboo HR Node // Fixed Adjust Time - TimeOff API Operation, Wrote comments, Finished TimeOff Api Operations * Bamboo HR Node // Add Multi choice Property for Employee Operations, Expand and Add new Optional Fields for Creating and Updating Employee, Write Comments, Fixed Employee API operations * Bamboo HR Node // Add Multi choice Property + Update Fields and Write Comments for Employee Files & Company Files & Reports Acc Info API Operation * N8N-2603 Move Company Name Prop to Credentials, Changed Execution Function * N8N-2603 Obtain Employee ID and bind to the response after create an employee, Refactor GetDirectoy to GetAll + update the output of the response * N8N-2603 Refactor, Added ID in responses, Added Pagination to some operations * N8N-2603 Refactor Employee Files to Employee File * N8N-2603 Refactor CompanyFiles to Company File, Refactor CompanyFile:Create -> CompanyFile:addCategory * N8N-2603 Refactor employeeFile:create -> employeeFile:addCategory, Get rid off Account Information resources * N8N-2603 EmployeeFile:Update -> Change ShareWithEmployee Parameter to be boolean * N8N-2603 CompanyFIle:update -> Change shareWithCompany prop to boolean * N8N-2603 Added Load Options for getTimeOffTypeId, Rename AdditionalFields to UpdateFields * N8N-2603 Updated Logo and Border * N8N-2603 Refactor Employees to Employee * N8N-2603 Linter Fixes * N8N-2603 Refactor EmployeeFile:get -> EmployeeFile:download, CompanyFile:get -> CompanyFile:download * N8N-2603 Linter fix * N8N-2603 Linter Fixes * N8N-2603 Hotfix * N8N-2603 Fixed EmployeeFile:Download * N8N-2603 Updated Assertion * N8N-2603 Remove unnecesary description, optimized code, created separate loadOptions file * N8N-2603 Added Download Function for CompanyFile operation * N8N-2603 Added DateTime Fields instead of string, Removed Color prop from Node * N8N-2603 Refactor Del to Delete * N8N-2603 Added Upload Employ File Operation * N8N-2603 Updated Possible Types of the Request * N8N-2603 Fixed Linter Errors * N8N-2603 Hotfix Upload Employee File Description * N8N-2603 Added options to download the report * :zap: Improvements * :zap: Improvements * :zap: Simplify node * :zap: Fix linting issue * :zap: Improvements * :zap: Fix returned mimeType Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-01-22 01:46:13 -08:00
import { IDataObject, NodeApiError, NodeOperationError } from 'n8n-workflow';
:sparkles: Add BambooHR Node (#2471) * Feature // Created BambooHR Node, Init Simple Api Calls for Employees * BambooHR Added EmployeesFiles, CompanyFiles API Operations * BambooHR / Refactor the code * Bamboo HR Node // Refactor + Optimization of Employee Api Requests * Bamboo HR Node // Refactor + Optimization of EmployeeFiles Api Requests * Bamboo HR Node // Refactor + Optimization of CompanyFiles Api Requests * Bamboo HR Node // Add Reports - Get Reports by ID * Bamboo HR Node // Format BambooAPI Credential files * Bamboo HR Node // Added Account Information API operations * Bamboo HR Node //Add Https Reposnse Code for All API Operations, Implement new Http Helper * Bamboo HR Node // Added Tabular Data Api Operations * Bamboo HR Node // Added Time Off Api Operations * Bamboo HR Node //Fixed bugs for AccountInformation Operation, Uploading Employees File, TimeOff EstimationTime * Bamboo HR Node // Update AccountInformation - UpdateFields Api operation * Bamboo HR Node //Fixed Add and Update Table rows // Tabular Data API Operations * Update AccountInformation - Added TimeOff Operations - Get Requests, Create Request, Create History Item, Fixed Get Types * Bamboo HR Node // Fixed Adjust Time - TimeOff API Operation, Wrote comments, Finished TimeOff Api Operations * Bamboo HR Node // Add Multi choice Property for Employee Operations, Expand and Add new Optional Fields for Creating and Updating Employee, Write Comments, Fixed Employee API operations * Bamboo HR Node // Add Multi choice Property + Update Fields and Write Comments for Employee Files & Company Files & Reports Acc Info API Operation * N8N-2603 Move Company Name Prop to Credentials, Changed Execution Function * N8N-2603 Obtain Employee ID and bind to the response after create an employee, Refactor GetDirectoy to GetAll + update the output of the response * N8N-2603 Refactor, Added ID in responses, Added Pagination to some operations * N8N-2603 Refactor Employee Files to Employee File * N8N-2603 Refactor CompanyFiles to Company File, Refactor CompanyFile:Create -> CompanyFile:addCategory * N8N-2603 Refactor employeeFile:create -> employeeFile:addCategory, Get rid off Account Information resources * N8N-2603 EmployeeFile:Update -> Change ShareWithEmployee Parameter to be boolean * N8N-2603 CompanyFIle:update -> Change shareWithCompany prop to boolean * N8N-2603 Added Load Options for getTimeOffTypeId, Rename AdditionalFields to UpdateFields * N8N-2603 Updated Logo and Border * N8N-2603 Refactor Employees to Employee * N8N-2603 Linter Fixes * N8N-2603 Refactor EmployeeFile:get -> EmployeeFile:download, CompanyFile:get -> CompanyFile:download * N8N-2603 Linter fix * N8N-2603 Linter Fixes * N8N-2603 Hotfix * N8N-2603 Fixed EmployeeFile:Download * N8N-2603 Updated Assertion * N8N-2603 Remove unnecesary description, optimized code, created separate loadOptions file * N8N-2603 Added Download Function for CompanyFile operation * N8N-2603 Added DateTime Fields instead of string, Removed Color prop from Node * N8N-2603 Refactor Del to Delete * N8N-2603 Added Upload Employ File Operation * N8N-2603 Updated Possible Types of the Request * N8N-2603 Fixed Linter Errors * N8N-2603 Hotfix Upload Employee File Description * N8N-2603 Added options to download the report * :zap: Improvements * :zap: Improvements * :zap: Simplify node * :zap: Fix linting issue * :zap: Improvements * :zap: Fix returned mimeType Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-01-22 01:46:13 -08:00
import { OptionsWithUrl } from 'request';
:sparkles: Add BambooHR Node (#2471) * Feature // Created BambooHR Node, Init Simple Api Calls for Employees * BambooHR Added EmployeesFiles, CompanyFiles API Operations * BambooHR / Refactor the code * Bamboo HR Node // Refactor + Optimization of Employee Api Requests * Bamboo HR Node // Refactor + Optimization of EmployeeFiles Api Requests * Bamboo HR Node // Refactor + Optimization of CompanyFiles Api Requests * Bamboo HR Node // Add Reports - Get Reports by ID * Bamboo HR Node // Format BambooAPI Credential files * Bamboo HR Node // Added Account Information API operations * Bamboo HR Node //Add Https Reposnse Code for All API Operations, Implement new Http Helper * Bamboo HR Node // Added Tabular Data Api Operations * Bamboo HR Node // Added Time Off Api Operations * Bamboo HR Node //Fixed bugs for AccountInformation Operation, Uploading Employees File, TimeOff EstimationTime * Bamboo HR Node // Update AccountInformation - UpdateFields Api operation * Bamboo HR Node //Fixed Add and Update Table rows // Tabular Data API Operations * Update AccountInformation - Added TimeOff Operations - Get Requests, Create Request, Create History Item, Fixed Get Types * Bamboo HR Node // Fixed Adjust Time - TimeOff API Operation, Wrote comments, Finished TimeOff Api Operations * Bamboo HR Node // Add Multi choice Property for Employee Operations, Expand and Add new Optional Fields for Creating and Updating Employee, Write Comments, Fixed Employee API operations * Bamboo HR Node // Add Multi choice Property + Update Fields and Write Comments for Employee Files & Company Files & Reports Acc Info API Operation * N8N-2603 Move Company Name Prop to Credentials, Changed Execution Function * N8N-2603 Obtain Employee ID and bind to the response after create an employee, Refactor GetDirectoy to GetAll + update the output of the response * N8N-2603 Refactor, Added ID in responses, Added Pagination to some operations * N8N-2603 Refactor Employee Files to Employee File * N8N-2603 Refactor CompanyFiles to Company File, Refactor CompanyFile:Create -> CompanyFile:addCategory * N8N-2603 Refactor employeeFile:create -> employeeFile:addCategory, Get rid off Account Information resources * N8N-2603 EmployeeFile:Update -> Change ShareWithEmployee Parameter to be boolean * N8N-2603 CompanyFIle:update -> Change shareWithCompany prop to boolean * N8N-2603 Added Load Options for getTimeOffTypeId, Rename AdditionalFields to UpdateFields * N8N-2603 Updated Logo and Border * N8N-2603 Refactor Employees to Employee * N8N-2603 Linter Fixes * N8N-2603 Refactor EmployeeFile:get -> EmployeeFile:download, CompanyFile:get -> CompanyFile:download * N8N-2603 Linter fix * N8N-2603 Linter Fixes * N8N-2603 Hotfix * N8N-2603 Fixed EmployeeFile:Download * N8N-2603 Updated Assertion * N8N-2603 Remove unnecesary description, optimized code, created separate loadOptions file * N8N-2603 Added Download Function for CompanyFile operation * N8N-2603 Added DateTime Fields instead of string, Removed Color prop from Node * N8N-2603 Refactor Del to Delete * N8N-2603 Added Upload Employ File Operation * N8N-2603 Updated Possible Types of the Request * N8N-2603 Fixed Linter Errors * N8N-2603 Hotfix Upload Employee File Description * N8N-2603 Added options to download the report * :zap: Improvements * :zap: Improvements * :zap: Simplify node * :zap: Fix linting issue * :zap: Improvements * :zap: Fix returned mimeType Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-01-22 01:46:13 -08:00
/**
* 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 = {},
) {
2022-01-22 09:48:58 -08:00
const credentials = await this.getCredentials('bambooHrApi');
:sparkles: Add BambooHR Node (#2471) * Feature // Created BambooHR Node, Init Simple Api Calls for Employees * BambooHR Added EmployeesFiles, CompanyFiles API Operations * BambooHR / Refactor the code * Bamboo HR Node // Refactor + Optimization of Employee Api Requests * Bamboo HR Node // Refactor + Optimization of EmployeeFiles Api Requests * Bamboo HR Node // Refactor + Optimization of CompanyFiles Api Requests * Bamboo HR Node // Add Reports - Get Reports by ID * Bamboo HR Node // Format BambooAPI Credential files * Bamboo HR Node // Added Account Information API operations * Bamboo HR Node //Add Https Reposnse Code for All API Operations, Implement new Http Helper * Bamboo HR Node // Added Tabular Data Api Operations * Bamboo HR Node // Added Time Off Api Operations * Bamboo HR Node //Fixed bugs for AccountInformation Operation, Uploading Employees File, TimeOff EstimationTime * Bamboo HR Node // Update AccountInformation - UpdateFields Api operation * Bamboo HR Node //Fixed Add and Update Table rows // Tabular Data API Operations * Update AccountInformation - Added TimeOff Operations - Get Requests, Create Request, Create History Item, Fixed Get Types * Bamboo HR Node // Fixed Adjust Time - TimeOff API Operation, Wrote comments, Finished TimeOff Api Operations * Bamboo HR Node // Add Multi choice Property for Employee Operations, Expand and Add new Optional Fields for Creating and Updating Employee, Write Comments, Fixed Employee API operations * Bamboo HR Node // Add Multi choice Property + Update Fields and Write Comments for Employee Files & Company Files & Reports Acc Info API Operation * N8N-2603 Move Company Name Prop to Credentials, Changed Execution Function * N8N-2603 Obtain Employee ID and bind to the response after create an employee, Refactor GetDirectoy to GetAll + update the output of the response * N8N-2603 Refactor, Added ID in responses, Added Pagination to some operations * N8N-2603 Refactor Employee Files to Employee File * N8N-2603 Refactor CompanyFiles to Company File, Refactor CompanyFile:Create -> CompanyFile:addCategory * N8N-2603 Refactor employeeFile:create -> employeeFile:addCategory, Get rid off Account Information resources * N8N-2603 EmployeeFile:Update -> Change ShareWithEmployee Parameter to be boolean * N8N-2603 CompanyFIle:update -> Change shareWithCompany prop to boolean * N8N-2603 Added Load Options for getTimeOffTypeId, Rename AdditionalFields to UpdateFields * N8N-2603 Updated Logo and Border * N8N-2603 Refactor Employees to Employee * N8N-2603 Linter Fixes * N8N-2603 Refactor EmployeeFile:get -> EmployeeFile:download, CompanyFile:get -> CompanyFile:download * N8N-2603 Linter fix * N8N-2603 Linter Fixes * N8N-2603 Hotfix * N8N-2603 Fixed EmployeeFile:Download * N8N-2603 Updated Assertion * N8N-2603 Remove unnecesary description, optimized code, created separate loadOptions file * N8N-2603 Added Download Function for CompanyFile operation * N8N-2603 Added DateTime Fields instead of string, Removed Color prop from Node * N8N-2603 Refactor Del to Delete * N8N-2603 Added Upload Employ File Operation * N8N-2603 Updated Possible Types of the Request * N8N-2603 Fixed Linter Errors * N8N-2603 Hotfix Upload Employee File Description * N8N-2603 Added options to download the report * :zap: Improvements * :zap: Improvements * :zap: Simplify node * :zap: Fix linting issue * :zap: Improvements * :zap: Fix returned mimeType Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2022-01-22 01:46:13 -08:00
//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: OptionsWithUrl = {
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, { message, description });
}
}