bamboohr.com 1.5.5 → 1.5.7

package/dist/BambooHR.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BambooHR = void 0;
-const node_crypto_1 = __importDefault(require("node:crypto"));
 const api_client_1 = require("@ffflorian/api-client");
+const node_crypto_1 = __importDefault(require("node:crypto"));
 const api_1 = require("./api");
 class BambooHR {
     constructor(options) {
@@ -13,6 +13,7 @@ class BambooHR {
         const baseURL = `https://api.bamboohr.com/api/gateway.php/${options.companyDomain}/v1/`;
         this.apiClient = new api_client_1.APIClient(baseURL, {
             auth: {
+                // eslint-disable-next-line no-magic-numbers
                 password: node_crypto_1.default.randomBytes(16).toString('base64').substring(0, 7),
                 username: this.options.apiKey,
             },

package/dist/Endpoints.d.ts

@@ -2,20 +2,20 @@ import type { Fields } from './interfaces/Fields';
 export declare const Endpoint: {
     DIRECTORY: string;
     EMPLOYEES: string;
+    Employees: {
+        employeeDirectory(): string;
+        employees(id?: number, fields?: Array<keyof Fields>): string;
+    };
     META: string;
     POLICIES: string;
     REQUESTS: string;
     TIME_OFF: string;
-    TYPES: string;
-    WHOS_OUT: string;
-    Employees: {
-        employees(id?: number, fields?: Array<keyof Fields>): string;
-        employeeDirectory(): string;
-    };
     TimeOff: {
-        whosOut(): string;
-        timeOffTypes(): string;
         timeOffPolicies(): string;
         timeOffRequests(): string;
+        timeOffTypes(): string;
+        whosOut(): string;
     };
+    TYPES: string;
+    WHOS_OUT: string;
 };

package/dist/Endpoints.js

@@ -4,13 +4,10 @@ exports.Endpoint = void 0;
 exports.Endpoint = {
     DIRECTORY: 'directory',
     EMPLOYEES: 'employees',
-    META: 'meta',
-    POLICIES: 'policies',
-    REQUESTS: 'requests',
-    TIME_OFF: 'time_off',
-    TYPES: 'types',
-    WHOS_OUT: 'whos_out',
     Employees: {
+        employeeDirectory() {
+            return `/${exports.Endpoint.EMPLOYEES}/${exports.Endpoint.DIRECTORY}/`;
+        },
         employees(id, fields) {
             const url = new URL(`/${exports.Endpoint.EMPLOYEES}/`, 'https://example.com');
             if (id) {
@@ -23,22 +20,25 @@ exports.Endpoint = {
             }
             return `${url.pathname}${url.search}`;
         },
-        employeeDirectory() {
-            return `/${exports.Endpoint.EMPLOYEES}/${exports.Endpoint.DIRECTORY}/`;
-        },
     },
+    META: 'meta',
+    POLICIES: 'policies',
+    REQUESTS: 'requests',
+    TIME_OFF: 'time_off',
     TimeOff: {
-        whosOut() {
-            return `/${exports.Endpoint.TIME_OFF}/${exports.Endpoint.WHOS_OUT}/`;
-        },
-        timeOffTypes() {
-            return `/${exports.Endpoint.META}/${exports.Endpoint.TIME_OFF}/${exports.Endpoint.TYPES}/`;
-        },
         timeOffPolicies() {
             return `/${exports.Endpoint.META}/${exports.Endpoint.TIME_OFF}/${exports.Endpoint.POLICIES}/`;
         },
         timeOffRequests() {
             return `/${exports.Endpoint.TIME_OFF}/${exports.Endpoint.REQUESTS}/`;
         },
+        timeOffTypes() {
+            return `/${exports.Endpoint.META}/${exports.Endpoint.TIME_OFF}/${exports.Endpoint.TYPES}/`;
+        },
+        whosOut() {
+            return `/${exports.Endpoint.TIME_OFF}/${exports.Endpoint.WHOS_OUT}/`;
+        },
     },
+    TYPES: 'types',
+    WHOS_OUT: 'whos_out',
 };

package/dist/api/EmployeesAPI.d.ts

@@ -1,5 +1,5 @@
 import type { APIClient } from '@ffflorian/api-client';
-import type { Fields, Employee, WritableFields, EmployeeDirectory } from '../interfaces';
+import type { Employee, EmployeeDirectory, Fields, WritableFields } from '../interfaces';
 export declare class EmployeesAPI {
     private readonly apiClient;
     constructor(apiClient: APIClient);

package/dist/api/TimeOffAPI.d.ts

@@ -1,22 +1,8 @@
 import type { APIClient } from '@ffflorian/api-client';
-import type { OffEmployee, TimeOffPolicy, TimeOffTypes, TimeOffRequestsOptions, TimeOffRequest } from '../interfaces';
+import type { OffEmployee, TimeOffPolicy, TimeOffRequest, TimeOffRequestsOptions, TimeOffTypes } from '../interfaces';
 export declare class TimeOffAPI {
     private readonly apiClient;
     constructor(apiClient: APIClient);
-    /**
-     * 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[]>;
-    /**
-     * This endpoint gets a list of time off types.
-     * @param mode set to 'request' to get a list of all time off types with which this user can create a time off
-     * 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 gets a list of time off policies.
      * @see https://documentation.bamboohr.com/reference#get-time-off-policies
@@ -35,4 +21,18 @@ export declare class TimeOffAPI {
      * @see https://documentation.bamboohr.com/reference#time-off-get-time-off-requests-1
      */
     timeOffRequests(options: TimeOffRequestsOptions): Promise<TimeOffRequest[]>;
+    /**
+     * This endpoint gets a list of time off types.
+     * @param mode set to 'request' to get a list of all time off types with which this user can create a time off
+     * 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

@@ -15,32 +15,6 @@ class TimeOffAPI {
     constructor(apiClient) {
         this.apiClient = apiClient;
     }
-    /**
-     * 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* () {
-            const endpoint = Endpoints_1.Endpoint.TimeOff.whosOut();
-            const { data } = yield this.apiClient.get(endpoint, { params: { end, start } });
-            return data;
-        });
-    }
-    /**
-     * This endpoint gets a list of time off types.
-     * @param mode set to 'request' to get a list of all time off types with which this user can create a time off
-     * 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* () {
-            const endpoint = Endpoints_1.Endpoint.TimeOff.timeOffTypes();
-            const { data } = yield this.apiClient.get(endpoint, { params: { mode } });
-            return data;
-        });
-    }
     /**
      * This endpoint gets a list of time off policies.
      * @see https://documentation.bamboohr.com/reference#get-time-off-policies
@@ -71,5 +45,31 @@ class TimeOffAPI {
             return data;
         });
     }
+    /**
+     * This endpoint gets a list of time off types.
+     * @param mode set to 'request' to get a list of all time off types with which this user can create a time off
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.TimeOff.timeOffTypes();
+            const { data } = yield this.apiClient.get(endpoint, { params: { mode } });
+            return data;
+        });
+    }
+    /**
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.TimeOff.whosOut();
+            const { data } = yield this.apiClient.get(endpoint, { params: { end, start } });
+            return data;
+        });
+    }
 }
 exports.TimeOffAPI = TimeOffAPI;

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * from './api/';
 export * from './BambooHR';
 export * from './interfaces/';

package/dist/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api/"), exports);
 __exportStar(require("./BambooHR"), exports);
 __exportStar(require("./interfaces/"), exports);

package/dist/interfaces/Employee.d.ts

@@ -1,8 +1,5 @@
 import { Fields } from './Fields';
-type PartialNull<T> = {
-    [P in keyof T]?: T[P] | null;
-};
-interface BaseEmployee {
+export interface BaseEmployee {
     firstName: string;
     id: string;
     lastName: string;
@@ -24,4 +21,6 @@ export interface OffEmployee {
     start: string;
     type: string;
 }
-export {};
+export type PartialNull<T> = {
+    [P in keyof T]?: null | T[P];
+};

package/dist/interfaces/Fields.d.ts

@@ -1,32 +1,15 @@
-export type Writeable<T> = {
-    -readonly [P in keyof T]: T[P];
-};
 /**
- * A complete date with a four-digit year.
- *
- * Format: yyyy-mm-dd
- *
- * Example: "2010-03-19"
- */
-export type DateField = string;
-/**
- * A standard United States Social Security number, with dashes.
- *
- * Example: "123-45-6789"
- */
-export type SSNField = string;
-/**
- * A plain text string with a phone number, no formatting is enforced.
+ * "yes" or "checkbox" will mark the checkbox checked and everything else will default to unchecked
  *
- * Example: "1-866-387-9595"
+ * Example: "yes", "checkbox", "no"
  */
-export type PhoneField = string;
+export type CheckboxField = 'checkbox' | 'no' | 'yes';
 /**
- * The plain text name of the gender.
+ * The name of the country. Must exist in the BambooHR country list.
  *
- * Example: "Male" or "Female"
+ * Example: "Australia", "United States", etc.
  */
-export type GenderField = string;
+export type CountryField = string;
 /**
  * A simple quantity value without thousands separators or currency signs using a period as a decimal point.
  * Example: "27000.00"
@@ -35,76 +18,30 @@ export type GenderField = string;
  *
  * Example: `“payRate”: { “value”: “27000.00”, “currency”: “EUR”}`
  */
-export type CurrencyField = string | {
+export type CurrencyField = {
     currency: string;
     value: string;
-};
-/**
- * "yes" or "checkbox" will mark the checkbox checked and everything else will default to unchecked
- *
- * Example: "yes", "checkbox", "no"
- */
-export type CheckboxField = 'yes' | 'checkbox' | 'no';
-/**
- * The name of the country. Must exist in the BambooHR country list.
- *
- * Example: "Australia", "United States", etc.
- */
-export type CountryField = string;
-/**
- * The full name of the state/province.
- *
- * Example: "Florida"
- */
-export type StateField = string;
+} | string;
 /**
- * Plain text status of marriage.
+ * A complete date with a four-digit year.
  *
- * Example: "Single" or "Married"
- */
-export type MaritalStatusField = string;
-/**
- * The employee's employment status as used to filter employees in BambooHR.
+ * Format: yyyy-mm-dd
  *
- * Example: "Active" or "Inactive"
+ * Example: "2010-03-19"
  */
-export type StatusField = 'Active' | 'Inactive';
+export type DateField = string;
 /**
- * One of several predefined options for the unit of pay.
+ * An email address.
  *
- * Example: "Hourly", "Salary", "Commission", "Exception Hourly", "Monthly", "Piece Rate", "Contract" or "Daily"
+ * Example: "support@bamboohr.com"
  */
-export type PayTypeField = string;
+export type EmailField = string;
 /**
  * A reference to another employee expressed as preferred name-space-last name.
  *
  * Example: "Robert Smith"
  */
 export type EmployeeField = string;
-/**
- * The UTC time that an event occurred.
- *
- * Format: ####-##-##T##:##:##+##:##
- *
- * Example: "2012-10-17T20:27:17+00:00"
- */
-export type TimestampField = string;
-/**
- * A larger section of text that can include line feed characters.
- */
-export type TextareaField = string;
-/**
- * The exact text for an option from a list.
- *
- * Example: "Marketing"
- */
-export type ListField = string;
-/**
- * An email address.
- *
- * Example: "support@bamboohr.com"
- */
-export type EmailField = string;
 export interface Fields {
     /** @deprecated please use ‘acaStatusCategory’ */
     acaStatus: string;
@@ -267,4 +204,67 @@ export interface Fields {
     /** The employee's ZIP code. */
     zipcode: string;
 }
+/**
+ * The plain text name of the gender.
+ *
+ * Example: "Male" or "Female"
+ */
+export type GenderField = string;
+/**
+ * The exact text for an option from a list.
+ *
+ * Example: "Marketing"
+ */
+export type ListField = string;
+/**
+ * Plain text status of marriage.
+ *
+ * Example: "Single" or "Married"
+ */
+export type MaritalStatusField = string;
+/**
+ * One of several predefined options for the unit of pay.
+ *
+ * Example: "Hourly", "Salary", "Commission", "Exception Hourly", "Monthly", "Piece Rate", "Contract" or "Daily"
+ */
+export type PayTypeField = string;
+/**
+ * A plain text string with a phone number, no formatting is enforced.
+ *
+ * Example: "1-866-387-9595"
+ */
+export type PhoneField = string;
+/**
+ * A standard United States Social Security number, with dashes.
+ *
+ * Example: "123-45-6789"
+ */
+export type SSNField = string;
+/**
+ * The full name of the state/province.
+ *
+ * Example: "Florida"
+ */
+export type StateField = string;
+/**
+ * The employee's employment status as used to filter employees in BambooHR.
+ *
+ * Example: "Active" or "Inactive"
+ */
+export type StatusField = 'Active' | 'Inactive';
+/**
+ * A larger section of text that can include line feed characters.
+ */
+export type TextareaField = string;
+/**
+ * The UTC time that an event occurred.
+ *
+ * Format: ####-##-##T##:##:##+##:##
+ *
+ * Example: "2012-10-17T20:27:17+00:00"
+ */
+export type TimestampField = string;
 export type WritableFields = Partial<Writeable<Fields>>;
+export type Writeable<T> = {
+    -readonly [P in keyof T]: T[P];
+};

package/dist/interfaces/TimeOffRequest.d.ts

@@ -1,21 +1,4 @@
 import { TimeOffType } from './TimeOffType';
-interface TimeOffRequestActions {
-    approve: boolean;
-    bypass: boolean;
-    cancel: boolean;
-    deny: boolean;
-    edit: boolean;
-    view: boolean;
-}
-interface TimeOffRequestAmount {
-    amount: string;
-    unit: string;
-}
-interface TimeOffRequestStatus {
-    lastChanged: string;
-    lastChangedByUserId: string;
-    status: string;
-}
 export interface TimeOffRequest {
     actions: TimeOffRequestActions;
     amount: TimeOffRequestAmount;
@@ -30,4 +13,20 @@ export interface TimeOffRequest {
     status: TimeOffRequestStatus;
     type: TimeOffType;
 }
-export {};
+export interface TimeOffRequestActions {
+    approve: boolean;
+    bypass: boolean;
+    cancel: boolean;
+    deny: boolean;
+    edit: boolean;
+    view: boolean;
+}
+export interface TimeOffRequestAmount {
+    amount: string;
+    unit: string;
+}
+export interface TimeOffRequestStatus {
+    lastChanged: string;
+    lastChangedByUserId: string;
+    status: string;
+}

package/dist/interfaces/TimeOffType.d.ts

@@ -1,5 +1,5 @@
 export interface TimeOffType {
-    color: string | null;
+    color: null | string;
     icon: string;
     id: string;
     name: string;

package/package.json

@@ -1,16 +1,16 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0",
+    "@ffflorian/api-client": "2.5.1",
     "@hapi/hawk": "8.0.0"
   },
   "description": "An bamboohr.com API client",
   "devDependencies": {
     "@types/hapi__hawk": "8.0.7",
     "@types/node": "~24",
-    "rimraf": "6.1.2",
-    "typedoc": "0.28.15",
-    "typescript": "5.9.3"
+    "rimraf": "6.1.3",
+    "typedoc": "0.28.18",
+    "typescript": "6.0.2"
   },
   "engines": {
     "node": ">= 21"
@@ -30,12 +30,12 @@
   "readme": "https://github.com/ffflorian/api-clients#readme",
   "repository": "https://github.com/ffflorian/api-clients.git",
   "scripts": {
+    "build": "yarn build:ts",
     "build:ts": "tsc -p tsconfig.build.json",
     "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/bamboohr.com src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
+    "dist": "yarn clean && yarn build",
     "test": "exit 0"
   },
-  "version": "1.5.5",
-  "gitHead": "8d7471cbe490305b3e441c27acbc81e36a4bd9df"
+  "version": "1.5.7"
 }