@tryfinch/finch-api 5.14.3 → 5.16.0

package/resources/sandbox/connections/connections.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connections.js","sourceRoot":"","sources":["../../../src/resources/sandbox/connections/connections.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;AAGrD,2DAA2D;AAE3D,wGAA0F;AAE1F,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAW1E,CAAC;IATC;;OAEG;IACH,MAAM,CACJ,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAZD,kCAYC;AA8BD,WAAiB,WAAW;IAGZ,oBAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;AAKhD,CAAC,EARgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAQ3B"}

package/resources/sandbox/connections/connections.mjs

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '@tryfinch/finch-api/resource';
+import * as AccountsAPI from '@tryfinch/finch-api/resources/sandbox/connections/accounts';
+export class Connections extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.accounts = new AccountsAPI.Accounts(this._client);
+    }
+    /**
+     * Create a new connection (new company/provider pair) with a new account
+     */
+    create(body, options) {
+        return this._client.post('/sandbox/connections', { body, ...options });
+    }
+}
+(function (Connections) {
+    Connections.Accounts = AccountsAPI.Accounts;
+})(Connections || (Connections = {}));
+//# sourceMappingURL=connections.mjs.map

package/resources/sandbox/connections/connections.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"connections.mjs","sourceRoot":"","sources":["../../../src/resources/sandbox/connections/connections.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;OAEnD,KAAK,WAAW,MAAM,4DAA4D;AAEzF,MAAM,OAAO,WAAY,SAAQ,WAAW;IAA5C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAW1E,CAAC;IATC;;OAEG;IACH,MAAM,CACJ,IAA4B,EAC5B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AA8BD,WAAiB,WAAW;IAGZ,oBAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC;AAKhD,CAAC,EARgB,WAAW,KAAX,WAAW,QAQ3B"}

package/resources/sandbox/connections/index.d.ts

@@ -0,0 +1,3 @@
+export { AccountCreateResponse, AccountUpdateResponse, AccountCreateParams, AccountUpdateParams, Accounts, } from "./accounts.js";
+export { ConnectionCreateResponse, ConnectionCreateParams, Connections } from "./connections.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/sandbox/connections/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/sandbox/connections/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,EACnB,QAAQ,GACT,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC"}

package/resources/sandbox/connections/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connections = exports.Accounts = void 0;
+var accounts_1 = require("./accounts.js");
+Object.defineProperty(exports, "Accounts", { enumerable: true, get: function () { return accounts_1.Accounts; } });
+var connections_1 = require("./connections.js");
+Object.defineProperty(exports, "Connections", { enumerable: true, get: function () { return connections_1.Connections; } });
+//# sourceMappingURL=index.js.map

package/resources/sandbox/connections/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/sandbox/connections/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,0CAMoB;AADlB,oGAAA,QAAQ,OAAA;AAEV,gDAA8F;AAAnC,0GAAA,WAAW,OAAA"}

package/resources/sandbox/connections/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless.
+export { Accounts, } from "./accounts.mjs";
+export { Connections } from "./connections.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/sandbox/connections/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/sandbox/connections/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAKL,QAAQ,GACT;OACM,EAAoD,WAAW,EAAE"}

package/resources/sandbox/directory.d.ts

@@ -0,0 +1,156 @@
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import * as DirectoryAPI from '@tryfinch/finch-api/resources/sandbox/directory';
+import * as HRISAPI from '@tryfinch/finch-api/resources/hris/hris';
+export declare class Directory extends APIResource {
+    /**
+     * Add new individuals to a sandbox company
+     */
+    create(body: DirectoryCreateParams, options?: Core.RequestOptions): Core.APIPromise<DirectoryCreateResponse>;
+}
+/**
+ * The individuals which were created
+ */
+export type DirectoryCreateResponse = Array<unknown>;
+export type DirectoryCreateParams = Array<DirectoryCreateParams.Body>;
+export declare namespace DirectoryCreateParams {
+    interface Body {
+        /**
+         * Worker's compensation classification code for this employee
+         */
+        class_code?: string | null;
+        /**
+         * Custom fields for the individual. These are fields which are defined by the
+         * employer in the system. Custom fields are not currently supported for assisted
+         * connections.
+         */
+        custom_fields?: Array<Body.CustomField>;
+        /**
+         * The department object.
+         */
+        department?: Body.Department | null;
+        dob?: string | null;
+        emails?: Array<Body.Email> | null;
+        /**
+         * The employment object.
+         */
+        employment?: Body.Employment | null;
+        /**
+         * Social Security Number of the individual in **encrypted** format. This field is
+         * only available with the `ssn` scope enabled and the
+         * `options: { include: ['ssn'] }` param set in the body.
+         */
+        encrypted_ssn?: string | null;
+        end_date?: string | null;
+        /**
+         * The EEOC-defined ethnicity of the individual.
+         */
+        ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null;
+        /**
+         * The legal first name of the individual.
+         */
+        first_name?: string | null;
+        /**
+         * The gender of the individual.
+         */
+        gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
+        /**
+         * The employee's income as reported by the provider. This may not always be
+         * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+         * depending on what information the provider returns.
+         */
+        income?: HRISAPI.Income | null;
+        /**
+         * The array of income history.
+         */
+        income_history?: Array<HRISAPI.Income | null> | null;
+        /**
+         * `true` if the individual an an active employee or contractor at the company.
+         */
+        is_active?: boolean | null;
+        /**
+         * The legal last name of the individual.
+         */
+        last_name?: string | null;
+        location?: HRISAPI.Location | null;
+        /**
+         * The manager object representing the manager of the individual within the org.
+         */
+        manager?: Body.Manager | null;
+        /**
+         * The legal middle name of the individual.
+         */
+        middle_name?: string | null;
+        phone_numbers?: Array<Body.PhoneNumber | null> | null;
+        /**
+         * The preferred name of the individual.
+         */
+        preferred_name?: string | null;
+        residence?: HRISAPI.Location | null;
+        /**
+         * The source system's unique employment identifier for this individual
+         */
+        source_id?: string;
+        /**
+         * Social Security Number of the individual. This field is only available with the
+         * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+         * body.
+         */
+        ssn?: string | null;
+        start_date?: string | null;
+        /**
+         * The current title of the individual.
+         */
+        title?: string | null;
+    }
+    namespace Body {
+        interface CustomField {
+            name?: string | null;
+            value?: unknown;
+        }
+        /**
+         * The department object.
+         */
+        interface Department {
+            /**
+             * The name of the department associated with the individual.
+             */
+            name?: string | null;
+        }
+        interface Email {
+            data?: string;
+            type?: 'work' | 'personal';
+        }
+        /**
+         * The employment object.
+         */
+        interface Employment {
+            /**
+             * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+             */
+            subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+            /**
+             * The main employment type of the individual.
+             */
+            type?: 'employee' | 'contractor' | null;
+        }
+        /**
+         * The manager object representing the manager of the individual within the org.
+         */
+        interface Manager {
+            /**
+             * A stable Finch `id` (UUID v4) for an individual in the company.
+             */
+            id?: string;
+        }
+        interface PhoneNumber {
+            data?: string;
+            type?: 'work' | 'personal';
+        }
+    }
+}
+export declare namespace Directory {
+    export import DirectoryCreateResponse = DirectoryAPI.DirectoryCreateResponse;
+    export import DirectoryCreateParams = DirectoryAPI.DirectoryCreateParams;
+}
+//# sourceMappingURL=directory.d.ts.map

package/resources/sandbox/directory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/directory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,YAAY,MAAM,iDAAiD,CAAC;AAChF,OAAO,KAAK,OAAO,MAAM,yCAAyC,CAAC;AAEnE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;CAG5C;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;AAErD,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;AAEtE,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;;WAIG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAExC;;WAEG;QACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpC;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,SAAS,CAAC,EACN,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;QAEnE;;;;WAIG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAErD;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEpC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,WAAW;YAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB,KAAK,CAAC,EAAE,OAAO,CAAC;SACjB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;QAED,UAAiB,KAAK;YACpB,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;YAEtG;;eAEG;YACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;SACzC;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;SACb;QAED,UAAiB,WAAW;YAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;SAC5B;KACF;CACF;AAED,yBAAiB,SAAS,CAAC;IACzB,MAAM,QAAQ,uBAAuB,GAAG,YAAY,CAAC,uBAAuB,CAAC;IAC7E,MAAM,QAAQ,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;CAC1E"}

package/resources/sandbox/directory.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Directory = void 0;
+const resource_1 = require("@tryfinch/finch-api/resource");
+class Directory extends resource_1.APIResource {
+    /**
+     * Add new individuals to a sandbox company
+     */
+    create(body, options) {
+        return this._client.post('/sandbox/directory', { body, ...options });
+    }
+}
+exports.Directory = Directory;
+(function (Directory) {
+})(Directory = exports.Directory || (exports.Directory = {}));
+//# sourceMappingURL=directory.js.map

package/resources/sandbox/directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory.js","sourceRoot":"","sources":["../../src/resources/sandbox/directory.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAI3D,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,MAAM,CACJ,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAVD,8BAUC;AA6LD,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGzB"}

package/resources/sandbox/directory.mjs

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '@tryfinch/finch-api/resource';
+export class Directory extends APIResource {
+    /**
+     * Add new individuals to a sandbox company
+     */
+    create(body, options) {
+        return this._client.post('/sandbox/directory', { body, ...options });
+    }
+}
+(function (Directory) {
+})(Directory || (Directory = {}));
+//# sourceMappingURL=directory.mjs.map

package/resources/sandbox/directory.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/directory.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;AAI1D,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,MAAM,CACJ,IAA2B,EAC3B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AA6LD,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,KAAT,SAAS,QAGzB"}

package/resources/sandbox/employment.d.ts

@@ -0,0 +1,216 @@
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import * as EmploymentAPI from '@tryfinch/finch-api/resources/sandbox/employment';
+import * as HRISAPI from '@tryfinch/finch-api/resources/hris/hris';
+export declare class Employment extends APIResource {
+    /**
+     * Update sandbox employment
+     */
+    update(individualId: string, body?: EmploymentUpdateParams, options?: Core.RequestOptions): Core.APIPromise<EmploymentUpdateResponse>;
+    update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<EmploymentUpdateResponse>;
+}
+export interface EmploymentUpdateResponse {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id?: string;
+    /**
+     * Worker's compensation classification code for this employee
+     */
+    class_code?: string | null;
+    /**
+     * Custom fields for the individual. These are fields which are defined by the
+     * employer in the system. Custom fields are not currently supported for assisted
+     * connections.
+     */
+    custom_fields?: Array<EmploymentUpdateResponse.CustomField>;
+    /**
+     * The department object.
+     */
+    department?: EmploymentUpdateResponse.Department | null;
+    /**
+     * The employment object.
+     */
+    employment?: EmploymentUpdateResponse.Employment | null;
+    end_date?: string | null;
+    /**
+     * The legal first name of the individual.
+     */
+    first_name?: string | null;
+    /**
+     * The employee's income as reported by the provider. This may not always be
+     * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+     * depending on what information the provider returns.
+     */
+    income?: HRISAPI.Income | null;
+    /**
+     * The array of income history.
+     */
+    income_history?: Array<HRISAPI.Income | null> | null;
+    /**
+     * `true` if the individual an an active employee or contractor at the company.
+     */
+    is_active?: boolean | null;
+    /**
+     * The legal last name of the individual.
+     */
+    last_name?: string | null;
+    location?: HRISAPI.Location | null;
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    manager?: EmploymentUpdateResponse.Manager | null;
+    /**
+     * The legal middle name of the individual.
+     */
+    middle_name?: string | null;
+    /**
+     * The source system's unique employment identifier for this individual
+     */
+    source_id?: string;
+    start_date?: string | null;
+    /**
+     * The current title of the individual.
+     */
+    title?: string | null;
+}
+export declare namespace EmploymentUpdateResponse {
+    interface CustomField {
+        name?: string | null;
+        value?: unknown;
+    }
+    /**
+     * The department object.
+     */
+    interface Department {
+        /**
+         * The name of the department associated with the individual.
+         */
+        name?: string | null;
+    }
+    /**
+     * The employment object.
+     */
+    interface Employment {
+        /**
+         * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+         */
+        subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+        /**
+         * The main employment type of the individual.
+         */
+        type?: 'employee' | 'contractor' | null;
+    }
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    interface Manager {
+        /**
+         * A stable Finch `id` (UUID v4) for an individual in the company.
+         */
+        id?: string;
+    }
+}
+export interface EmploymentUpdateParams {
+    /**
+     * Worker's compensation classification code for this employee
+     */
+    class_code?: string | null;
+    /**
+     * Custom fields for the individual. These are fields which are defined by the
+     * employer in the system. Custom fields are not currently supported for assisted
+     * connections.
+     */
+    custom_fields?: Array<EmploymentUpdateParams.CustomField>;
+    /**
+     * The department object.
+     */
+    department?: EmploymentUpdateParams.Department | null;
+    /**
+     * The employment object.
+     */
+    employment?: EmploymentUpdateParams.Employment | null;
+    end_date?: string | null;
+    /**
+     * The legal first name of the individual.
+     */
+    first_name?: string | null;
+    /**
+     * The employee's income as reported by the provider. This may not always be
+     * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+     * depending on what information the provider returns.
+     */
+    income?: HRISAPI.Income | null;
+    /**
+     * The array of income history.
+     */
+    income_history?: Array<HRISAPI.Income | null> | null;
+    /**
+     * `true` if the individual an an active employee or contractor at the company.
+     */
+    is_active?: boolean | null;
+    /**
+     * The legal last name of the individual.
+     */
+    last_name?: string | null;
+    location?: HRISAPI.Location | null;
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    manager?: EmploymentUpdateParams.Manager | null;
+    /**
+     * The legal middle name of the individual.
+     */
+    middle_name?: string | null;
+    /**
+     * The source system's unique employment identifier for this individual
+     */
+    source_id?: string;
+    start_date?: string | null;
+    /**
+     * The current title of the individual.
+     */
+    title?: string | null;
+}
+export declare namespace EmploymentUpdateParams {
+    interface CustomField {
+        name?: string | null;
+        value?: unknown;
+    }
+    /**
+     * The department object.
+     */
+    interface Department {
+        /**
+         * The name of the department associated with the individual.
+         */
+        name?: string | null;
+    }
+    /**
+     * The employment object.
+     */
+    interface Employment {
+        /**
+         * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+         */
+        subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+        /**
+         * The main employment type of the individual.
+         */
+        type?: 'employee' | 'contractor' | null;
+    }
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    interface Manager {
+        /**
+         * A stable Finch `id` (UUID v4) for an individual in the company.
+         */
+        id?: string;
+    }
+}
+export declare namespace Employment {
+    export import EmploymentUpdateResponse = EmploymentAPI.EmploymentUpdateResponse;
+    export import EmploymentUpdateParams = EmploymentAPI.EmploymentUpdateParams;
+}
+//# sourceMappingURL=employment.d.ts.map

package/resources/sandbox/employment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"employment.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/employment.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,KAAK,aAAa,MAAM,kDAAkD,CAAC;AAClF,OAAO,KAAK,OAAO,MAAM,yCAAyC,CAAC;AAEnE,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAC5C,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;CAWvG;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAE5D;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,UAAU,GAAG,IAAI,CAAC;IAExD;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC,UAAU,GAAG,IAAI,CAAC;IAExD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,OAAO,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;QAEtG;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;KACzC;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;IAE1D;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;QAEtG;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;KACzC;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;CACF;AAED,yBAAiB,UAAU,CAAC;IAC1B,MAAM,QAAQ,wBAAwB,GAAG,aAAa,CAAC,wBAAwB,CAAC;IAChF,MAAM,QAAQ,sBAAsB,GAAG,aAAa,CAAC,sBAAsB,CAAC;CAC7E"}

package/resources/sandbox/employment.js

@@ -0,0 +1,18 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Employment = void 0;
+const resource_1 = require("@tryfinch/finch-api/resource");
+const core_1 = require("@tryfinch/finch-api/core");
+class Employment extends resource_1.APIResource {
+    update(individualId, body = {}, options) {
+        if ((0, core_1.isRequestOptions)(body)) {
+            return this.update(individualId, {}, body);
+        }
+        return this._client.put(`/sandbox/employment/${individualId}`, { body, ...options });
+    }
+}
+exports.Employment = Employment;
+(function (Employment) {
+})(Employment = exports.Employment || (exports.Employment = {}));
+//# sourceMappingURL=employment.js.map

package/resources/sandbox/employment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"employment.js","sourceRoot":"","sources":["../../src/resources/sandbox/employment.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAC3D,mDAA4D;AAI5D,MAAa,UAAW,SAAQ,sBAAW;IAUzC,MAAM,CACJ,YAAoB,EACpB,OAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AApBD,gCAoBC;AAuPD,WAAiB,UAAU;AAG3B,CAAC,EAHgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAG1B"}

package/resources/sandbox/employment.mjs

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+export class Employment extends APIResource {
+    update(individualId, body = {}, options) {
+        if (isRequestOptions(body)) {
+            return this.update(individualId, {}, body);
+        }
+        return this._client.put(`/sandbox/employment/${individualId}`, { body, ...options });
+    }
+}
+(function (Employment) {
+})(Employment || (Employment = {}));
+//# sourceMappingURL=employment.mjs.map

package/resources/sandbox/employment.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"employment.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/employment.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;OACnD,EAAE,gBAAgB,EAAE,MAAM,0BAA0B;AAI3D,MAAM,OAAO,UAAW,SAAQ,WAAW;IAUzC,MAAM,CACJ,YAAoB,EACpB,OAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SAC5C;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AAuPD,WAAiB,UAAU;AAG3B,CAAC,EAHgB,UAAU,KAAV,UAAU,QAG1B"}

package/resources/sandbox/index.d.ts

@@ -0,0 +1,9 @@
+export { CompanyUpdateResponse, CompanyUpdateParams, Company } from "./company.js";
+export { ConnectionCreateResponse, ConnectionCreateParams, Connections } from "./connections/index.js";
+export { DirectoryCreateResponse, DirectoryCreateParams, Directory } from "./directory.js";
+export { EmploymentUpdateResponse, EmploymentUpdateParams, Employment } from "./employment.js";
+export { IndividualUpdateResponse, IndividualUpdateParams, Individual } from "./individual.js";
+export { Jobs } from "./jobs/index.js";
+export { PaymentCreateResponse, PaymentCreateParams, Payment } from "./payment.js";
+export { Sandbox } from "./sandbox.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/sandbox/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/sandbox/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}

package/resources/sandbox/index.js

@@ -0,0 +1,21 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sandbox = exports.Payment = exports.Jobs = exports.Individual = exports.Employment = exports.Directory = exports.Connections = exports.Company = void 0;
+var company_1 = require("./company.js");
+Object.defineProperty(exports, "Company", { enumerable: true, get: function () { return company_1.Company; } });
+var index_1 = require("./connections/index.js");
+Object.defineProperty(exports, "Connections", { enumerable: true, get: function () { return index_1.Connections; } });
+var directory_1 = require("./directory.js");
+Object.defineProperty(exports, "Directory", { enumerable: true, get: function () { return directory_1.Directory; } });
+var employment_1 = require("./employment.js");
+Object.defineProperty(exports, "Employment", { enumerable: true, get: function () { return employment_1.Employment; } });
+var individual_1 = require("./individual.js");
+Object.defineProperty(exports, "Individual", { enumerable: true, get: function () { return individual_1.Individual; } });
+var index_2 = require("./jobs/index.js");
+Object.defineProperty(exports, "Jobs", { enumerable: true, get: function () { return index_2.Jobs; } });
+var payment_1 = require("./payment.js");
+Object.defineProperty(exports, "Payment", { enumerable: true, get: function () { return payment_1.Payment; } });
+var sandbox_1 = require("./sandbox.js");
+Object.defineProperty(exports, "Sandbox", { enumerable: true, get: function () { return sandbox_1.Sandbox; } });
+//# sourceMappingURL=index.js.map

package/resources/sandbox/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/sandbox/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,wCAAgF;AAA3B,kGAAA,OAAO,OAAA;AAC5D,gDAAoG;AAAzC,oGAAA,WAAW,OAAA;AACtE,4CAAwF;AAA/B,sGAAA,SAAS,OAAA;AAClE,8CAA4F;AAAjC,wGAAA,UAAU,OAAA;AACrE,8CAA4F;AAAjC,wGAAA,UAAU,OAAA;AACrE,yCAAoC;AAA3B,6FAAA,IAAI,OAAA;AACb,wCAAgF;AAA3B,kGAAA,OAAO,OAAA;AAC5D,wCAAoC;AAA3B,kGAAA,OAAO,OAAA"}

package/resources/sandbox/index.mjs

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless.
+export { Company } from "./company.mjs";
+export { Connections } from "./connections/index.mjs";
+export { Directory } from "./directory.mjs";
+export { Employment } from "./employment.mjs";
+export { Individual } from "./individual.mjs";
+export { Jobs } from "./jobs/index.mjs";
+export { Payment } from "./payment.mjs";
+export { Sandbox } from "./sandbox.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/sandbox/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAA8C,OAAO,EAAE;OACvD,EAAoD,WAAW,EAAE;OACjE,EAAkD,SAAS,EAAE;OAC7D,EAAoD,UAAU,EAAE;OAChE,EAAoD,UAAU,EAAE;OAChE,EAAE,IAAI,EAAE;OACR,EAA8C,OAAO,EAAE;OACvD,EAAE,OAAO,EAAE"}