Class EmployeesAPI

Index

Constructors

Methods

addEmployee getEmployee getEmployeeDirectory listEmployees updateEmployee

Constructors

constructor

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

Methods

addEmployee

addEmployee(fields: WritableFields): Promise<Employee>
Update an employee, based on employee id.
Parameters
- fields: WritableFields
Returns Promise<Employee>
- Defined in api/EmployeesAPI.ts:20

getEmployee

getEmployee(
    id: number,
    fields?: (keyof Fields)[],
    onlyCurrent?: boolean,
): 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)[]
- OptionalonlyCurrent: boolean
Returns Promise<Employee>
- Defined in api/EmployeesAPI.ts:29

getEmployeeDirectory

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

Returns Promise<EmployeeDirectory>
- Defined in api/EmployeesAPI.ts:38

listEmployees

listEmployees(options?: EmployeesListOptions): Promise<EmployeesListResponse>
Returns a cursor-paginated collection of employees with optional filter and sort criteria.
Parameters
- Optionaloptions: EmployeesListOptions
Returns Promise<EmployeesListResponse>
See
https://documentation.bamboohr.com/reference/list-employees
- Defined in api/EmployeesAPI.ts:48

updateEmployee

updateEmployee(id: number, fields: WritableFields): Promise<Employee>
Update an employee, based on employee id.
Parameters
- id: number
- fields: WritableFields
Returns Promise<Employee>
- Defined in api/EmployeesAPI.ts:57