bamboohr.com 1.5.6 → 1.5.7

package/dist/BambooHR.d.ts

@@ -0,0 +1,7 @@
+import type { API, ClientOptions } from './interfaces';
+export declare class BambooHR {
+    readonly api: API;
+    private readonly apiClient;
+    private readonly options;
+    constructor(options: ClientOptions);
+}

package/dist/BambooHR.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BambooHR = void 0;
+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) {
+        this.options = options;
+        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,
+            },
+            headers: {
+                Accept: 'application/json',
+            },
+        });
+        this.apiClient.interceptors.response.push(response => {
+            const errorMessage = response.headers.get('x-bamboohr-error-message') || response.statusText;
+            throw new Error(`HTTP error ${response.status}: ${errorMessage}`);
+        });
+        this.api = {
+            employees: new api_1.EmployeesAPI(this.apiClient),
+            timeOff: new api_1.TimeOffAPI(this.apiClient),
+        };
+    }
+}
+exports.BambooHR = BambooHR;

package/dist/Endpoints.d.ts

@@ -0,0 +1,21 @@
+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;
+    TimeOff: {
+        timeOffPolicies(): string;
+        timeOffRequests(): string;
+        timeOffTypes(): string;
+        whosOut(): string;
+    };
+    TYPES: string;
+    WHOS_OUT: string;
+};

package/dist/Endpoints.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+exports.Endpoint = {
+    DIRECTORY: 'directory',
+    EMPLOYEES: 'employees',
+    Employees: {
+        employeeDirectory() {
+            return `/${exports.Endpoint.EMPLOYEES}/${exports.Endpoint.DIRECTORY}/`;
+        },
+        employees(id, fields) {
+            const url = new URL(`/${exports.Endpoint.EMPLOYEES}/`, 'https://example.com');
+            if (id) {
+                url.pathname += `${id}/`;
+            }
+            if (fields) {
+                const params = new URLSearchParams();
+                params.append('fields', fields.join(','));
+                url.search = params.toString();
+            }
+            return `${url.pathname}${url.search}`;
+        },
+    },
+    META: 'meta',
+    POLICIES: 'policies',
+    REQUESTS: 'requests',
+    TIME_OFF: 'time_off',
+    TimeOff: {
+        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

@@ -0,0 +1,26 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Employee, EmployeeDirectory, Fields, WritableFields } from '../interfaces';
+export declare class EmployeesAPI {
+    private readonly apiClient;
+    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

@@ -0,0 +1,63 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmployeesAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class EmployeesAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /**
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.Employees.employees();
+            const { data } = yield this.apiClient.post(endpoint, fields);
+            return data;
+        });
+    }
+    /**
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.Employees.employees(id, fields);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * Gets employee directory.
+     * @see https://documentation.bamboohr.com/reference#get-employees-directory-1
+     */
+    getEmployeeDirectory() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Employees.employeeDirectory();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.Employees.employees(id);
+            const { data } = yield this.apiClient.post(endpoint, fields);
+            return data;
+        });
+    }
+}
+exports.EmployeesAPI = EmployeesAPI;

package/dist/api/TimeOffAPI.d.ts

@@ -0,0 +1,38 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { OffEmployee, TimeOffPolicy, TimeOffRequest, TimeOffRequestsOptions, TimeOffTypes } from '../interfaces';
+export declare class TimeOffAPI {
+    private readonly apiClient;
+    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[]>;
+    /**
+     * The response will be limited to those employees and time off types that the owner of the API key used to make the request has view access to.
+     *
+     * The start and end date parameters will show time off if any day in the time off request falls within the dates specified, even if part of the time off falls outside of the time specified.
+     *
+     * Clients should be ready for any number of "note" elements.
+     *
+     * 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[]>;
+    /**
+     * 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

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeOffAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class TimeOffAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    /**
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.TimeOff.timeOffPolicies();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    /**
+     * The response will be limited to those employees and time off types that the owner of the API key used to make the request has view access to.
+     *
+     * The start and end date parameters will show time off if any day in the time off request falls within the dates specified, even if part of the time off falls outside of the time specified.
+     *
+     * Clients should be ready for any number of "note" elements.
+     *
+     * 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* () {
+            const endpoint = Endpoints_1.Endpoint.TimeOff.timeOffRequests();
+            const { data } = yield this.apiClient.get(endpoint, { params: options });
+            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/api/index.d.ts

@@ -0,0 +1,2 @@
+export * from './EmployeesAPI';
+export * from './TimeOffAPI';

package/dist/api/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./EmployeesAPI"), exports);
+__exportStar(require("./TimeOffAPI"), exports);

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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/API.d.ts

@@ -0,0 +1,5 @@
+import type { EmployeesAPI, TimeOffAPI } from '../api/';
+export interface API {
+    employees: EmployeesAPI;
+    timeOff: TimeOffAPI;
+}

package/dist/interfaces/API.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/ClientOptions.d.ts

@@ -0,0 +1,5 @@
+export interface ClientOptions {
+    apiKey: string;
+    /** The subdomain used to access your account (If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany") */
+    companyDomain: string;
+}

package/dist/interfaces/ClientOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/DefaultHour.d.ts

@@ -0,0 +1,4 @@
+export interface DefaultHour {
+    amount: string;
+    name: string;
+}

package/dist/interfaces/DefaultHour.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Employee.d.ts

@@ -0,0 +1,26 @@
+import { Fields } from './Fields';
+export interface BaseEmployee {
+    firstName: string;
+    id: string;
+    lastName: string;
+}
+export type Employee = BaseEmployee & PartialNull<Fields>;
+export interface EmployeeDirectory {
+    employees: Employee[];
+    fields: {
+        id: keyof Fields;
+        name: string;
+        type: string;
+    };
+}
+export interface OffEmployee {
+    employeeId: number;
+    end: string;
+    id: number;
+    name: string;
+    start: string;
+    type: string;
+}
+export type PartialNull<T> = {
+    [P in keyof T]?: null | T[P];
+};

package/dist/interfaces/Employee.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Fields.d.ts

@@ -0,0 +1,270 @@
+/**
+ * "yes" or "checkbox" will mark the checkbox checked and everything else will default to unchecked
+ *
+ * Example: "yes", "checkbox", "no"
+ */
+export type CheckboxField = 'checkbox' | 'no' | 'yes';
+/**
+ * The name of the country. Must exist in the BambooHR country list.
+ *
+ * Example: "Australia", "United States", etc.
+ */
+export type CountryField = string;
+/**
+ * A simple quantity value without thousands separators or currency signs using a period as a decimal point.
+ * Example: "27000.00"
+ *
+ * To add a currency code that is different from the company default, specify the code using the currency tag.
+ *
+ * Example: `“payRate”: { “value”: “27000.00”, “currency”: “EUR”}`
+ */
+export type CurrencyField = {
+    currency: string;
+    value: string;
+} | string;
+/**
+ * A complete date with a four-digit year.
+ *
+ * Format: yyyy-mm-dd
+ *
+ * Example: "2010-03-19"
+ */
+export type DateField = string;
+/**
+ * An email address.
+ *
+ * Example: "support@bamboohr.com"
+ */
+export type EmailField = string;
+/**
+ * A reference to another employee expressed as preferred name-space-last name.
+ *
+ * Example: "Robert Smith"
+ */
+export type EmployeeField = string;
+export interface Fields {
+    /** @deprecated please use ‘acaStatusCategory’ */
+    acaStatus: string;
+    /** The employee's ACA (Affordable Care Act) status. This field can not be updated directly but is calculated based on mappings for employment statuses found on the employmentStatus table. Options are: contractor, full-time, intern-eligible, intern-ineligible, part-time-eligible, part-time-ineligible, and seasonal. */
+    acaStatusCategory: string;
+    /** The employee's first address line. */
+    address1: string;
+    /** The employee's second address line. */
+    address2: string;
+    /** The employee's age. To change age, update dateOfBirth field. */
+    age: number;
+    /** The employee's work email if set, otherwise their home email. */
+    bestEmail: EmailField;
+    /** The employee's month and day of birth. To change birthday, update dateOfBirth field. */
+    birthday: string;
+    /** The amount of the most recent bonus. */
+    bonusAmount: CurrencyField;
+    /** Comment about the most recent bonus. */
+    bonusComment: string;
+    /** The date of the last bonus. */
+    bonusDate: DateField;
+    /** The reason for the most recent bonus. */
+    bonusReason: ListField;
+    /** The employee's city. */
+    city: string;
+    /** This field name contains a typo, and exists for backwards compatibility. */
+    commisionDate: DateField;
+    /** The amount of the most recent commission. */
+    commissionAmount: CurrencyField;
+    /** Comment about the most recent commission. */
+    commissionComment: string;
+    /** The date of the last commission. */
+    commissionDate: DateField;
+    /** The employee's country. */
+    country: CountryField;
+    /** The id of the user who created the employee. Read only. May be null if employee was created before the release of this field. */
+    readonly createdByUserId: number;
+    /** The date the employee was born. */
+    dateOfBirth: DateField;
+    /** The employee's **current* department. */
+    department: ListField;
+    /** The employee's name displayed in a format configured by the user. Read only. */
+    readonly displayName: string;
+    /** The employee's **current* division. */
+    division: ListField;
+    /** The employee's EEO job category. These are defined by the U.S. Equal Employment Opportunity Commission. */
+    eeo: ListField;
+    /** Employee number (assigned by your company). */
+    employeeNumber: string;
+    /** The employee's **current* employment status. Options are customized by account. Read-only starting with version 1.1; update using the `employmentStatus` table. */
+    readonly employmentHistoryStatus: ListField;
+    /** The employee's ethnicity. */
+    ethnicity: ListField;
+    /** The FLSA Overtime Status (Exempt or Non-exempt). */
+    exempt: ListField;
+    /** The employee's first name. */
+    firstName: string;
+    /** Deprecated please use 'exempt' */
+    flsaCode: ListField;
+    /** The employee's first and last name. (e.g., John Doe). Read only. */
+    readonly fullName1: string;
+    /** The employee's last and first name. (e.g., Doe, John). Read only. */
+    readonly fullName2: string;
+    /** The employee's full name and their preferred name. (e.g., Doe, John Quentin (JDog)). Read only. */
+    readonly fullName3: string;
+    /** The employee's full name without their preferred name, last name first. (e.g., Doe, John Quentin). Read only. */
+    readonly fullName4: string;
+    /** The employee's full name without their preferred name, first name first. (e.g., John Quentin Doe). Read only. */
+    readonly fullName5: string;
+    /** The employee's gender (Male or Female). */
+    gender: GenderField;
+    /** The date the employee was hired. */
+    hireDate: DateField;
+    /** The employee's home email address. */
+    homeEmail: EmailField;
+    /** The employee's home phone number. */
+    homePhone: PhoneField;
+    /** The employee ID automatically assigned by BambooHR. Read only. */
+    readonly id: number;
+    /** Should employee be included in payroll (Yes or No) */
+    includeInPayroll: boolean;
+    /** Whether a photo has been uploaded for the employee. Read only. */
+    readonly isPhotoUploaded: boolean;
+    /** The **current** value of the employee's job title, updating this field will create a new row in position history. */
+    jobTitle: ListField;
+    /** The date and time that the employee record was last changed. */
+    lastChanged: TimestampField;
+    /** The employee's last name. */
+    lastName: string;
+    /** The employee's **current** location. */
+    location: ListField;
+    /** The employee's marital status (Single, Married, or Domestic Partnership). */
+    maritalStatus: ListField;
+    /** The employee's middle name. */
+    middleName: string;
+    /** The employee's mobile phone number. */
+    mobilePhone: PhoneField;
+    /** The employee's National ID number */
+    nationalId: string;
+    /** The employee's nationality */
+    nationality: ListField;
+    /** The employee's NIN number */
+    nin: string;
+    /** The date the employee was originally hired. Available starting with version 1.1. */
+    originalHireDate: DateField;
+    /** The employee's **current** pay per. ie: "Hour", "Day", "Week", "Month", "Quarter", "Year". */
+    paidPer: string;
+    /** The reason for the employee's last pay rate change. */
+    payChangeReason: ListField;
+    /** The employee's **current** pay frequency. ie: "Weekly", "Every other week", "Twice a month", "Monthly", "Quarterly", "Twice a year", or "Yearly" */
+    payFrequency: ListField;
+    /** The custom pay group that the employee belongs to. */
+    payGroup: ListField;
+    /** The ID value corresponding to the pay group that an employee belongs to. */
+    payGroupId: number;
+    /** The employee's **current** pay rate (e.g., $8.25). */
+    payRate: CurrencyField;
+    /** The day the most recent change was made. */
+    payRateEffectiveDate: DateField;
+    /** The employee's **current** pay schedule. */
+    paySchedule: ListField;
+    /** The ID value corresponding to the pay schedule that an employee belongs to. */
+    payScheduleId: number;
+    /** The employee's **current** pay type. ie: "hourly","salary","commission","exception hourly","monthly","weekly","piece rate","contract","daily","pro rata". */
+    payType: PayTypeField;
+    /** The employee's preferred name. */
+    preferredName: string;
+    /** The employee's Canadian Social Insurance Number. */
+    sin: string;
+    /** The employee's Social Security number. */
+    ssn: SSNField;
+    /** The number of hours the employee works in a standard week. */
+    standardHoursPerWeek: number;
+    /** The employee's state/province. */
+    state: StateField;
+    /** The 2 character abbreviation for the employee's state (US only). Read only. */
+    readonly stateCode: string;
+    /** The employee's employee status (Active or Inactive). */
+    status: StatusField;
+    /** The employee’s **current** supervisor. Read only. */
+    readonly supervisor: EmployeeField;
+    /** The ID of the employee's **current** supervisor. Read only. */
+    readonly supervisorEId: number;
+    /** The email of the employee's **current** supervisor. Read only. */
+    readonly supervisorEmail: string;
+    /** The 'employeeNumber' of the employee's **current** supervisor. Read only. */
+    readonly supervisorId: number;
+    /** The date the employee was terminated. Read-only starting with version 1.1; update using the employmentStatus table. */
+    readonly terminationDate: DateField;
+    /** Should time tracking be enabled for the employee (Yes or No) */
+    timeTrackingEnabled: boolean;
+    /** The employee's work email address. */
+    workEmail: EmailField;
+    /** The employee's work phone number, without extension. */
+    workPhone: PhoneField;
+    /** The employee's work phone extension (if any). */
+    workPhoneExtension: string;
+    /** The employee's work phone and extension. Read only */
+    readonly workPhonePlusExtension: string;
+    /** 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/Fields.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/TimeOffPolicy.d.ts

@@ -0,0 +1,7 @@
+export interface TimeOffPolicy {
+    effectiveDate: string;
+    id: number;
+    name: string;
+    timeOffTypeId: number;
+    type: string;
+}

package/dist/interfaces/TimeOffPolicy.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/TimeOffRequest.d.ts

@@ -0,0 +1,32 @@
+import { TimeOffType } from './TimeOffType';
+export interface TimeOffRequest {
+    actions: TimeOffRequestActions;
+    amount: TimeOffRequestAmount;
+    created: string;
+    dates: Record<string, string>;
+    employeeId: string;
+    end: string;
+    id: string;
+    name: string;
+    notes: [];
+    start: string;
+    status: TimeOffRequestStatus;
+    type: TimeOffType;
+}
+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/TimeOffRequest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/TimeOffRequestsOptions.d.ts

@@ -0,0 +1,16 @@
+export interface TimeOffRequestsOptions {
+    /** Limit to requests that the user has a particular level of access to. Legal values are: "view" or "approve". Defaults to view. */
+    action?: string;
+    /** A particular employee ID to limit the response to. */
+    employeeId?: string;
+    /** YYYY-MM-DD. Only show time off that occurs on/before the specified end date. */
+    end: string;
+    /** A particular request ID to limit the response to. */
+    id?: number;
+    /** YYYY-MM-DD. Only show time off that occurs on/after the specified start date. */
+    start: string;
+    /** A comma separated list of request status values to include. If omitted, requests of all status values are included. Legal values are "approved", "denied", "superceded", "requested", "canceled". */
+    status?: string;
+    /** A comma separated list of time off types IDs to include limit the response to. If omitted, requests of all types are included. */
+    type?: string;
+}

package/dist/interfaces/TimeOffRequestsOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/TimeOffType.d.ts

@@ -0,0 +1,7 @@
+export interface TimeOffType {
+    color: null | string;
+    icon: string;
+    id: string;
+    name: string;
+    units: string;
+}

package/dist/interfaces/TimeOffType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/TimeOffTypes.d.ts

@@ -0,0 +1,5 @@
+import { DefaultHour, TimeOffType } from './';
+export interface TimeOffTypes {
+    defaultHours: DefaultHour[];
+    timeOffTypes: TimeOffType[];
+}

package/dist/interfaces/TimeOffTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/index.d.ts

@@ -0,0 +1,10 @@
+export * from './API';
+export * from './ClientOptions';
+export * from './DefaultHour';
+export * from './Employee';
+export * from './Fields';
+export * from './TimeOffPolicy';
+export * from './TimeOffRequest';
+export * from './TimeOffRequestsOptions';
+export * from './TimeOffType';
+export * from './TimeOffTypes';

package/dist/interfaces/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./ClientOptions"), exports);
+__exportStar(require("./DefaultHour"), exports);
+__exportStar(require("./Employee"), exports);
+__exportStar(require("./Fields"), exports);
+__exportStar(require("./TimeOffPolicy"), exports);
+__exportStar(require("./TimeOffRequest"), exports);
+__exportStar(require("./TimeOffRequestsOptions"), exports);
+__exportStar(require("./TimeOffType"), exports);
+__exportStar(require("./TimeOffTypes"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.0",
+    "@ffflorian/api-client": "2.5.1",
     "@hapi/hawk": "8.0.0"
   },
   "description": "An bamboohr.com API client",
@@ -30,11 +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.6"
+  "version": "1.5.7"
 }