N8N-2603 BambooHR Node #2471

SchnapsterDog · 2021-11-23T14:19:01Z

BambooHR Node

##Here is the list of the tasks related to BambooHR Node. The list should be expanded with new task related to the API operations present in https://documentation.bamboohr.com/docs/getting-started

Tasks:

Employees

Employees Files

Add requests for all operations / Employee Files
List employee files and categories
Add Employee File Category
Update Employee File
Delete Employee File
Get an Employee File

Company Files

Reports

Add requests for all operations // Reports
Get a company Report

Tabular Data

Add requests for all operations // Tabular Data
Gets table rows for a given employee and table combination
Adds a table row
Updates a table row
Gets all updated employee table data

Account Information

Add request for all Account Information operations
Get a list of fields
Get a list of tabular fields
Get details for liest fields
Get a list of users

Time Off

Feel free to test the Draft PR and expand the list below.

###Bugs & Improvements

Add Multi choice Property /Editor UI
Add list fields (Need for some API Calls)
Expand optional Fields when creating Employees
Add Selectable / Optional Fields
Code Refactor & Three shaking Code
Check the responses codes and return string if API is returning empty object on successful request

###TODO

When an employee is ‘hired’ in Bamboo, trigger creating a user account in Google admin.
When an employee is ‘terminated’ in Bamboo, suspend the account in Google admin.

…ement new Http Helper

…ng Employees File, TimeOff EstimationTime

…Operations

…Create Request, Create History Item, Fixed Get Types

…mments, Finished TimeOff Api Operations

…Expand and Add new Optional Fields for Creating and Updating Employee, Write Comments, Fixed Employee API operations

… Comments for Employee Files & Company Files & Reports Acc Info API Operation

…ction

…employee, Refactor GetDirectoy to GetAll + update the output of the response

…erations

…Create -> CompanyFile:addCategory

…t rid off Account Information resources

… be boolean

…elds to UpdateFields

ivov

Thank you for taking this on

ivov · 2021-12-09T15:35:25Z

packages/nodes-base/credentials/BambooHRApi.credentials.ts

+	properties = [
+		{
+			displayName: 'API Key',
+			name: 'apiKey',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},
+		{
+			displayName: 'Company name',
+			name: 'companyName',
+			type: 'string' as NodePropertyTypes,
+			default: '',
+		},


Type properties instead of asserting the type of type. Remember that type assertions override TS.

ivov · 2021-12-09T15:36:50Z

packages/nodes-base/nodes/BambooHR/BambooHR.node.ts

+	methods = {
+		loadOptions: {
+			async getTimeOffTypeID(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const body = {} as IDataObject;
+				const requestMethod = 'GET';
+				const endPoint = 'meta/time_off/types';
+
+				const response = await apiRequest.call(this, requestMethod, endPoint, body);
+				const timeOffTypeIds = response.body.timeOffTypes;
+
+				for (const item of timeOffTypeIds) {
+					returnData.push({
+						name: item.name,
+						value: item.id,
+					});
+				}
+				return returnData;
+			},
+		},
+	};


Check the Mattermost node, which has loadOptions in methods as a separate dir.

Done. Created separate dir for it.

ivov · 2021-12-09T15:37:36Z

packages/nodes-base/nodes/BambooHR/BambooHR.node.ts

+				const returnData: INodePropertyOptions[] = [];
+				const body = {} as IDataObject;
+				const requestMethod = 'GET';
+				const endPoint = 'meta/time_off/types';


endpoint without middle cap, applicable elsewhere as well.

ivov · 2021-12-09T15:37:48Z

packages/nodes-base/nodes/BambooHR/BambooHR.node.ts

+		loadOptions: {
+			async getTimeOffTypeID(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
+				const returnData: INodePropertyOptions[] = [];
+				const body = {} as IDataObject;


Type instead of asserting. Applicable elsewhere as well.

packages/nodes-base/nodes/BambooHR/BambooHR.node.ts

ivov · 2021-12-09T16:19:19Z

packages/nodes-base/nodes/BambooHR/v1/actions/versionDescription.ts

+	description: 'Consume BambooHR API',
+	defaults: {
+		name: 'BambooHR',
+		color: '#73c41d',


color has been deprecated.

ivov · 2021-12-09T16:19:36Z

packages/nodes-base/nodes/BambooHR/v1/actions/versionDescription.ts

+export const versionDescription: INodeTypeDescription = {
+	displayName: 'BambooHR',
+	name: 'bambooHR',
+	icon: 'file:bambooHR.png',


If available, SVGs are preferred.

Only the old logo was present in svg format. :/

ivov · 2021-12-09T16:19:48Z

packages/nodes-base/nodes/BambooHR/v1/actions/versionDescription.ts

+			displayName: 'Resource',
+			name: 'resource',
+			type: 'options',
+			options: [


Alphabetize.

ivov · 2021-12-09T16:20:02Z

packages/nodes-base/nodes/BambooHR/v1/actions/versionDescription.ts

+				},
+			],
+			default: 'employees',
+			description: 'The resource to operate on',


Suggested change

description: 'The resource to operate on',

ivov · 2021-12-09T16:20:21Z

packages/nodes-base/nodes/BambooHR/v1/transport/index.ts

+ */
+export async function apiRequest(
+	this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
+	method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD',


Are they all used by your implementation?

I removed only 'HEAD' form here since we are using GET, POST, PUT and DELETE

…/n8n into feature/n8n-2603-bamboohr

…ate loadOptions file

…8n-2603-bamboohr

…from Node

janober · 2022-01-22T09:46:31Z

Great, thanks a lot. Got merged.

janober · 2022-01-22T18:43:37Z

Got released with n8n@0.160.0

SchnapsterDog added 24 commits October 26, 2021 10:07

Feature // Created BambooHR Node, Init Simple Api Calls for Employees

ca34b60

BambooHR Added EmployeesFiles, CompanyFiles API Operations

ab7028d

BambooHR / Refactor the code

f446087

Bamboo HR Node // Refactor + Optimization of Employee Api Requests

70cc2a5

Bamboo HR Node // Refactor + Optimization of EmployeeFiles Api Requests

7720f92

Bamboo HR Node // Refactor + Optimization of CompanyFiles Api Requests

2d44bdf

Bamboo HR Node // Add Reports - Get Reports by ID

1fa84fe

Bamboo HR Node // Format BambooAPI Credential files

914a210

Bamboo HR Node // Added Account Information API operations

be35931

Bamboo HR Node //Add Https Reposnse Code for All API Operations, Impl…

2e5ab05

…ement new Http Helper

Bamboo HR Node // Added Tabular Data Api Operations

97c3209

Bamboo HR Node // Added Time Off Api Operations

c9ddbf0

Bamboo HR Node //Fixed bugs for AccountInformation Operation, Uploadi…

a03ff56

…ng Employees File, TimeOff EstimationTime

Bamboo HR Node // Update AccountInformation - UpdateFields Api operation

9cb0bde

Bamboo HR Node //Fixed Add and Update Table rows // Tabular Data API …

73e2a98

…Operations

Update AccountInformation - Added TimeOff Operations - Get Requests, …

64952a5

…Create Request, Create History Item, Fixed Get Types

Bamboo HR Node // Fixed Adjust Time - TimeOff API Operation, Wrote co…

bcc84ad

…mments, Finished TimeOff Api Operations

Bamboo HR Node // Add Multi choice Property for Employee Operations, …

84116e3

…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…

a1b3f51

… Comments for Employee Files & Company Files & Reports Acc Info API Operation

N8N-2603 Move Company Name Prop to Credentials, Changed Execution Fun…

d076c89

…ction

N8N-2603 Merging Conflicts

26f6863

N8N-2603 Obtain Employee ID and bind to the response after create an …

efc6cca

…employee, Refactor GetDirectoy to GetAll + update the output of the response

N8N-2603 Refactor, Added ID in responses, Added Pagination to some op…

69f2e0f

…erations

N8N-2603 Refactor Employee Files to Employee File

3f2b28d

ivov mentioned this pull request Nov 24, 2021

Feature // Created BambooHR Node #2387

Closed

49 tasks

SchnapsterDog added 5 commits December 7, 2021 10:20

N8N-2603 Refactor CompanyFiles to Company File, Refactor CompanyFile:…

d602cfa

…Create -> CompanyFile:addCategory

N8N-2603 Refactor employeeFile:create -> employeeFile:addCategory, Ge…

644be26

…t rid off Account Information resources

N8N-2603 EmployeeFile:Update -> Change ShareWithEmployee Parameter to…

d6f414f

… be boolean

N8N-2603 CompanyFIle:update -> Change shareWithCompany prop to boolean

68ae8a2

N8N-2603 Added Load Options for getTimeOffTypeId, Rename AdditionalFi…

bb6bfab

…elds to UpdateFields

SchnapsterDog requested a review from ivov December 9, 2021 15:31

ivov requested changes Dec 9, 2021

View reviewed changes

N8N-2603 Fixed EmployeeFile:Download

2744178

ivov added node/new Creation of an entirely new node n8n team Authored by the n8n team labels Dec 15, 2021

SchnapsterDog added 12 commits December 27, 2021 09:48

Merge branch 'feature/n8n-2603-bamboohr' of https://github.com/n8n-io…

1960664

…/n8n into feature/n8n-2603-bamboohr

N8N-2603 Updated Assertion

42f1a10

N8N-2603 Remove unnecesary description, optimized code, created separ…

25160c6

…ate loadOptions file

Merge branch 'master' of https://github.com/n8n-io/n8n into feature/n…

b30e8de

…8n-2603-bamboohr

N8N-2603 Added Download Function for CompanyFile operation

2455280

N8N-2603 Added DateTime Fields instead of string, Removed Color prop …

7a6345c

…from Node

N8N-2603 Refactor Del to Delete

5b6577c

N8N-2603 Added Upload Employ File Operation

853471b

N8N-2603 Updated Possible Types of the Request

f431de2

N8N-2603 Fixed Linter Errors

0671186

N8N-2603 Hotfix Upload Employee File Description

07da0bb

N8N-2603 Added options to download the report

d05a3df

SchnapsterDog requested a review from ivov December 30, 2021 00:45

RicardoE105 added 5 commits January 2, 2022 20:24

⚡ Improvements

cad8a2a

⚡ Improvements

a277a6d

⚡ Simplify node

af9a97e

⚡ Fix linting issue

12d70a6

⚡ Improvements

ccfe600

RicardoE105 force-pushed the feature/n8n-2603-bamboohr branch from 5ff8c8a to ccfe600 Compare January 21, 2022 22:22

RicardoE105 and others added 2 commits January 21, 2022 17:23

🔀 Merge branch 'master' into 'feature/n8n-2603-bamboohr'

9a78e5e

⚡ Fix returned mimeType

fa47aca

janober merged commit 8cefafa into master Jan 22, 2022

janober deleted the feature/n8n-2603-bamboohr branch January 22, 2022 09:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

N8N-2603 BambooHR Node #2471

N8N-2603 BambooHR Node #2471

SchnapsterDog commented Nov 23, 2021 •

edited

ivov left a comment

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

ivov Dec 9, 2021

SchnapsterDog Dec 29, 2021

janober commented Jan 22, 2022

janober commented Jan 22, 2022

N8N-2603 BambooHR Node #2471

N8N-2603 BambooHR Node #2471

Conversation

SchnapsterDog commented Nov 23, 2021 • edited

BambooHR Node

Employees

Employees Files

Company Files

Reports

Tabular Data

Account Information

Time Off

ivov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janober commented Jan 22, 2022

janober commented Jan 22, 2022

SchnapsterDog commented Nov 23, 2021 •

edited