Class EmployeesAPI

Index

Constructors

Methods

addEmployee getEmployee getEmployeeDirectory updateEmployee

Constructors

constructor

new EmployeesAPI(apiClient: APIClient): EmployeesAPI
Parameters
- apiClient: APIClient
Returns EmployeesAPI
- Defined in api/EmployeesAPI.ts:8

Methods

addEmployee

addEmployee(fields: Pick<Fields, "firstName" | "lastName">): Promise<Employee>
Update an employee, based on employee id.
Parameters
- fields: Pick<Fields, "firstName" | "lastName">
Returns Promise<Employee>
See
https://documentation.bamboohr.com/reference#add-employee-1
- Defined in api/EmployeesAPI.ts:14

getEmployee

getEmployee(id: number, fields?: (keyof Fields)[]): Promise<Employee>
Get employee data by specifying a set of fields. This is suitable for getting basic employee information, including current values for fields that are part of a historical table, like job title, or compensation information.
Parameters
- id: number
- Optionalfields: (keyof Fields)[]
Returns Promise<Employee>
See
https://documentation.bamboohr.com/reference#get-employee
- Defined in api/EmployeesAPI.ts:24

getEmployeeDirectory

getEmployeeDirectory(): Promise<EmployeeDirectory>
Gets employee directory.

Returns Promise<EmployeeDirectory>
See
https://documentation.bamboohr.com/reference#get-employees-directory-1
- Defined in api/EmployeesAPI.ts:34

updateEmployee

updateEmployee(id: number, fields: WritableFields): Promise<Employee>
Update an employee, based on employee id.
Parameters
- id: number
- fields: WritableFields
Returns Promise<Employee>
See
https://documentation.bamboohr.com/reference#update-employee
- Defined in api/EmployeesAPI.ts:44