bamboohr.com 1.5.7 → 1.6.0

package/README.md

@@ -1,6 +1,6 @@
 # bamboohr.com [![npm version](https://img.shields.io/npm/v/bamboohr.com.svg)](https://www.npmjs.com/package/bamboohr.com)
 
-An [BambooHR](https://bamboohr.com) API client. For a documentation on the API see the [BambooHR API](https://documentation.bamboohr.com/reference).
+An [BambooHR](https://bamboohr.com) API client. For a documentation on the API see the [BambooHR API reference](https://documentation.bamboohr.com/reference).
 
 ### Installation
 

package/dist/api/EmployeesAPI.d.ts

@@ -5,22 +5,18 @@ export declare class EmployeesAPI {
     constructor(apiClient: APIClient);
     /**
      * Update an employee, based on employee id.
-     * @see https://documentation.bamboohr.com/reference#add-employee-1
      */
     addEmployee(fields: Pick<Fields, 'firstName' | 'lastName'>): 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.
-     * @see https://documentation.bamboohr.com/reference#get-employee
      */
     getEmployee(id: number, fields?: Array<keyof Fields>): Promise<Employee>;
     /**
      * Gets employee directory.
-     * @see https://documentation.bamboohr.com/reference#get-employees-directory-1
      */
     getEmployeeDirectory(): Promise<EmployeeDirectory>;
     /**
      * Update an employee, based on employee id.
-     * @see https://documentation.bamboohr.com/reference#update-employee
      */
     updateEmployee(id: number, fields: WritableFields): Promise<Employee>;
 }

package/dist/api/EmployeesAPI.js

@@ -17,7 +17,6 @@ class EmployeesAPI {
     }
     /**
      * Update an employee, based on employee id.
-     * @see https://documentation.bamboohr.com/reference#add-employee-1
      */
     addEmployee(fields) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -28,7 +27,6 @@ class EmployeesAPI {
     }
     /**
      * 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.
-     * @see https://documentation.bamboohr.com/reference#get-employee
      */
     getEmployee(id, fields) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -39,7 +37,6 @@ class EmployeesAPI {
     }
     /**
      * Gets employee directory.
-     * @see https://documentation.bamboohr.com/reference#get-employees-directory-1
      */
     getEmployeeDirectory() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -50,7 +47,6 @@ class EmployeesAPI {
     }
     /**
      * Update an employee, based on employee id.
-     * @see https://documentation.bamboohr.com/reference#update-employee
      */
     updateEmployee(id, fields) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/api/TimeOffAPI.d.ts

@@ -5,7 +5,6 @@ export declare class TimeOffAPI {
     constructor(apiClient: APIClient);
     /**
      * This endpoint gets a list of time off policies.
-     * @see https://documentation.bamboohr.com/reference#get-time-off-policies
      */
     timeOffPolicies(): Promise<TimeOffPolicy[]>;
     /**
@@ -18,7 +17,6 @@ export declare class TimeOffAPI {
      * If there are zero notes for a request then the "notes" tag will be still included as an empty array.
      *
      * Newer time off requests may also include details for each day of the request in a element.
-     * @see https://documentation.bamboohr.com/reference#time-off-get-time-off-requests-1
      */
     timeOffRequests(options: TimeOffRequestsOptions): Promise<TimeOffRequest[]>;
     /**
@@ -27,12 +25,10 @@ export declare class TimeOffAPI {
      * request. The default is to return the list of time off types the user has permissions on. This distinction is
      * important, as employees can request time off for types that they don't have permission to view balances and
      * requests for.
-     * @see https://documentation.bamboohr.com/reference#get-time-off-types
      */
     timeOffTypes(mode?: 'request'): Promise<TimeOffTypes>;
     /**
      * This endpoint will return a list, sorted by date, of employees who will be out, and company holidays, for a period of time.
-     * @see https://documentation.bamboohr.com/reference#get-a-list-of-whos-out-1
      */
     whosOut(start?: string, end?: string): Promise<OffEmployee[]>;
 }

package/dist/api/TimeOffAPI.js

@@ -17,7 +17,6 @@ class TimeOffAPI {
     }
     /**
      * This endpoint gets a list of time off policies.
-     * @see https://documentation.bamboohr.com/reference#get-time-off-policies
      */
     timeOffPolicies() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -36,7 +35,6 @@ class TimeOffAPI {
      * If there are zero notes for a request then the "notes" tag will be still included as an empty array.
      *
      * Newer time off requests may also include details for each day of the request in a element.
-     * @see https://documentation.bamboohr.com/reference#time-off-get-time-off-requests-1
      */
     timeOffRequests(options) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -51,7 +49,6 @@ class TimeOffAPI {
      * request. The default is to return the list of time off types the user has permissions on. This distinction is
      * important, as employees can request time off for types that they don't have permission to view balances and
      * requests for.
-     * @see https://documentation.bamboohr.com/reference#get-time-off-types
      */
     timeOffTypes(mode) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -62,7 +59,6 @@ class TimeOffAPI {
     }
     /**
      * This endpoint will return a list, sorted by date, of employees who will be out, and company holidays, for a period of time.
-     * @see https://documentation.bamboohr.com/reference#get-a-list-of-whos-out-1
      */
     whosOut(start, end) {
         return __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -9,8 +9,8 @@
     "@types/hapi__hawk": "8.0.7",
     "@types/node": "~24",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3"
   },
   "engines": {
     "node": ">= 21"
@@ -37,5 +37,5 @@
     "dist": "yarn clean && yarn build",
     "test": "exit 0"
   },
-  "version": "1.5.7"
+  "version": "1.6.0"
 }