@tryfinch/finch-api 6.26.0 → 6.28.0

package/resources/hris/employments.d.ts

@@ -5,130 +5,149 @@ import { ResponsesPage } from "../../pagination.js";
 export declare class Employments extends APIResource {
     /**
      * Read individual employment and income data
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const employmentDataResponse of client.hris.employments.retrieveMany(
+     *   { requests: [{ individual_id: 'individual_id' }] },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     retrieveMany(body: EmploymentRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<EmploymentDataResponsesPage, EmploymentDataResponse>;
 }
 export declare class EmploymentDataResponsesPage extends ResponsesPage<EmploymentDataResponse> {
 }
-export interface EmploymentData {
-    /**
-     * 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?: Array<EmploymentData.CustomField> | null;
-    /**
-     * The department object.
-     */
-    department?: EmploymentData.Department | null;
-    /**
-     * The employment object.
-     */
-    employment?: EmploymentData.Employment | null;
-    /**
-     * The detailed employment status of the individual. Available options: `active`,
-     * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
-     */
-    employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | 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;
-    latest_rehire_date?: string | null;
-    location?: HRISAPI.Location | null;
-    /**
-     * The manager object representing the manager of the individual within the org.
-     */
-    manager?: EmploymentData.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 | null;
-    start_date?: string | null;
-    /**
-     * The current title of the individual.
-     */
-    title?: string | null;
-    /**
-     * @deprecated This field is deprecated in favour of `source_id`
-     */
-    work_id?: string | null;
-}
+export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError;
 export declare namespace EmploymentData {
-    interface CustomField {
-        name?: string;
-        value?: unknown;
-    }
-    /**
-     * The department object.
-     */
-    interface Department {
+    interface UnionMember0 {
         /**
-         * The name of the department associated with the individual.
+         * A stable Finch `id` (UUID v4) for an individual in the company.
          */
-        name?: string | null;
-    }
-    /**
-     * The employment object.
-     */
-    interface Employment {
+        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: Array<UnionMember0.CustomField> | null;
+        /**
+         * The department object.
+         */
+        department: UnionMember0.Department | null;
+        /**
+         * The employment object.
+         */
+        employment: UnionMember0.Employment | null;
+        /**
+         * The detailed employment status of the individual. Available options: `active`,
+         * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+         */
+        employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null;
+        end_date: string | null;
+        /**
+         * The legal first name of the individual.
+         */
+        first_name: string | 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;
+        latest_rehire_date: string | null;
+        location: HRISAPI.Location | null;
         /**
-         * The secondary employment type of the individual. Options: `full_time`,
-         * `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+         * The manager object representing the manager of the individual within the org.
          */
-        subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+        manager: UnionMember0.Manager | null;
         /**
-         * The main employment type of the individual.
+         * The legal middle name of the individual.
          */
-        type?: 'employee' | 'contractor' | null;
+        middle_name: string | null;
+        /**
+         * The source system's unique employment identifier for this individual
+         */
+        source_id: string | null;
+        start_date: string | null;
+        /**
+         * The current title of the individual.
+         */
+        title: string | null;
+        /**
+         * @deprecated This field is deprecated in favour of `source_id`
+         */
+        work_id: 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;
     }
-    /**
-     * The manager object representing the manager of the individual within the org.
-     */
-    interface Manager {
+    namespace UnionMember0 {
+        interface CustomField {
+            name?: string;
+            value?: string | Array<unknown> | unknown | number | boolean | null;
+        }
         /**
-         * A stable Finch `id` (UUID v4) for an individual in the company.
+         * The department object.
          */
-        id?: string;
+        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;
+        }
+    }
+    interface BatchError {
+        code: number;
+        message: string;
+        name: string;
+        finch_code?: string;
     }
 }
 export interface EmploymentDataResponse {
-    body?: EmploymentData;
-    code?: number;
+    body: EmploymentData;
+    code: number;
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      */
-    individual_id?: string;
+    individual_id: string;
 }
 export interface EmploymentRetrieveManyParams {
     /**

package/resources/hris/employments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"employments.d.ts","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;CAOzE;AAED,qBAAa,2BAA4B,SAAQ,aAAa,CAAC,sBAAsB,CAAC;CAAG;AAEzF,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,CAAC,EACd,QAAQ,GACR,UAAU,GACV,OAAO,GACP,YAAY,GACZ,SAAS,GACT,SAAS,GACT,YAAY,GACZ,IAAI,CAAC;IAET,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,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,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;;;WAGG;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,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACvD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"employments.d.ts","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,sBAAsB,CAAC;CAOzE;AAED,qBAAa,2BAA4B,SAAQ,aAAa,CAAC,sBAAsB,CAAC;CAAG;AAEzF,MAAM,MAAM,cAAc,GAAG,cAAc,CAAC,YAAY,GAAG,cAAc,CAAC,UAAU,CAAC;AAErF,yBAAiB,cAAc,CAAC;IAC9B,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;;WAGG;QACH,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,UAAU,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI,CAAC;QAE3C;;WAEG;QACH,UAAU,EAAE,YAAY,CAAC,UAAU,GAAG,IAAI,CAAC;QAE3C;;;WAGG;QACH,iBAAiB,EACb,QAAQ,GACR,UAAU,GACV,OAAO,GACP,YAAY,GACZ,SAAS,GACT,SAAS,GACT,YAAY,GACZ,IAAI,CAAC;QAET,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;QAElC,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAElC;;WAEG;QACH,OAAO,EAAE,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC;QAErC;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;;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;KACtD;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,WAAW;YAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;SACrE;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;SACrB;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;;eAGG;YACH,OAAO,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;YAErG;;eAEG;YACH,IAAI,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;SACxC;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;KACF;IAED,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,cAAc,CAAC;IAErB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACvD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/hris/employments.js

@@ -7,6 +7,16 @@ const pagination_1 = require("../../pagination.js");
 class Employments extends resource_1.APIResource {
     /**
      * Read individual employment and income data
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const employmentDataResponse of client.hris.employments.retrieveMany(
+     *   { requests: [{ individual_id: 'individual_id' }] },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     retrieveMany(body, options) {
         return this._client.getAPIList('/employer/employment', EmploymentDataResponsesPage, {

package/resources/hris/employments.js.map

@@ -1 +1 @@
-{"version":3,"file":"employments.js","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAdD,kCAcC;AAED,MAAa,2BAA4B,SAAQ,0BAAqC;CAAG;AAAzF,kEAAyF;AAiLzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"employments.js","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,kCAwBC;AAED,MAAa,2BAA4B,SAAQ,0BAAqC;CAAG;AAAzF,kEAAyF;AA+LzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}

package/resources/hris/employments.mjs

@@ -4,6 +4,16 @@ import { ResponsesPage } from "../../pagination.mjs";
 export class Employments extends APIResource {
     /**
      * Read individual employment and income data
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const employmentDataResponse of client.hris.employments.retrieveMany(
+     *   { requests: [{ individual_id: 'individual_id' }] },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     retrieveMany(body, options) {
         return this._client.getAPIList('/employer/employment', EmploymentDataResponsesPage, {

package/resources/hris/employments.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"employments.mjs","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,aAAqC;CAAG;AAiLzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"employments.mjs","sourceRoot":"","sources":["../../src/resources/hris/employments.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,CACV,IAAkC,EAClC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,2BAA2B,EAAE;YAClF,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,aAAqC;CAAG;AA+LzF,WAAW,CAAC,2BAA2B,GAAG,2BAA2B,CAAC"}

package/resources/hris/hris.d.ts

@@ -34,48 +34,48 @@ export interface Income {
     /**
      * The income amount in cents.
      */
-    amount?: number | null;
+    amount: number | null;
     /**
      * The currency code.
      */
-    currency?: string | null;
+    currency: string | null;
     /**
      * The date the income amount went into effect.
      */
-    effective_date?: string | null;
+    effective_date: string | null;
     /**
      * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
      * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
      */
-    unit?: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null;
+    unit: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null;
 }
 export interface Location {
     /**
      * City, district, suburb, town, or village.
      */
-    city?: string | null;
+    city: string | null;
     /**
      * The 2-letter ISO 3166 country code.
      */
-    country?: string | null;
+    country: string | null;
     /**
      * Street address or PO box.
      */
-    line1?: string | null;
+    line1: string | null;
     /**
      * Apartment, suite, unit, or building.
      */
-    line2?: string | null;
-    name?: string | null;
+    line2: string | null;
     /**
      * The postal code or zip code.
      */
-    postal_code?: string | null;
-    source_id?: string | null;
+    postal_code: string | null;
     /**
      * The state code.
      */
-    state?: string | null;
+    state: string | null;
+    name?: string | null;
+    source_id?: string | null;
 }
 export interface Money {
     /**

package/resources/hris/hris.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hris.d.ts","sourceRoot":"","sources":["../../src/resources/hris/hris.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,SAAS,EACT,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,SAAS,EACT,MAAM,EACN,MAAM,EACP,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,8BAA8B,EAC9B,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACtF,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,oCAAoC,EACpC,+CAA+C,EAC/C,WAAW,EACX,mBAAmB,EACnB,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,6BAA6B,EAC7B,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7D,qBAAa,IAAK,SAAQ,WAAW;IACnC,OAAO,EAAE,UAAU,CAAC,eAAe,CAAgD;IACnF,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;CACzE;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EACD,QAAQ,GACR,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,IAAI,CAAC;CACV;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAiBD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAEjF,OAAO,EAAE,eAAe,IAAI,eAAe,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC;IAEvE,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,yBAAyB,IAAI,yBAAyB,EACtD,+CAA+C,IAAI,+CAA+C,EAClG,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"hris.d.ts","sourceRoot":"","sources":["../../src/resources/hris/hris.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,SAAS,EACT,8BAA8B,EAC9B,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,YAAY,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,SAAS,EACT,MAAM,EACN,MAAM,EACP,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,cAAc,MAAM,eAAe,CAAC;AAChD,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,4BAA4B,EAC5B,WAAW,EACZ,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,gBAAgB,MAAM,kBAAkB,CAAC;AACrD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,8BAA8B,EAC9B,aAAa,EACd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AACtF,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,oCAAoC,EACpC,+CAA+C,EAC/C,WAAW,EACX,mBAAmB,EACnB,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,yBAAyB,EACzB,6BAA6B,EAC7B,qBAAqB,EACrB,gBAAgB,EAChB,4BAA4B,EAC7B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE7D,qBAAa,IAAK,SAAQ,WAAW;IACnC,OAAO,EAAE,UAAU,CAAC,eAAe,CAAgD;IACnF,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IACvF,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,aAAa,EAAE,gBAAgB,CAAC,aAAa,CAAoD;IACjG,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;CACzE;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EACA,QAAQ,GACR,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,IAAI,CAAC;CACV;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAiBD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAEjF,OAAO,EAAE,eAAe,IAAI,eAAe,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,CAAC;IAEvE,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,2BAA2B,IAAI,2BAA2B,EAC1D,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,kBAAkB,IAAI,kBAAkB,EACxC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,aAAa,IAAI,aAAa,EAC9B,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,yBAAyB,IAAI,yBAAyB,EACtD,+CAA+C,IAAI,+CAA+C,EAClG,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/hris/individuals.d.ts

@@ -5,73 +5,90 @@ import { ResponsesPage } from "../../pagination.js";
 export declare class Individuals extends APIResource {
     /**
      * Read individual data, excluding income and employment data
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const individualResponse of client.hris.individuals.retrieveMany()) {
+     *   // ...
+     * }
+     * ```
      */
     retrieveMany(body?: IndividualRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<IndividualResponsesPage, IndividualResponse>;
     retrieveMany(options?: Core.RequestOptions): Core.PagePromise<IndividualResponsesPage, IndividualResponse>;
 }
 export declare class IndividualResponsesPage extends ResponsesPage<IndividualResponse> {
 }
-export interface Individual {
-    /**
-     * A stable Finch `id` (UUID v4) for an individual in the company.
-     */
-    id?: string;
-    dob?: string | null;
-    emails?: Array<Individual.Email> | 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;
-    /**
-     * 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 legal last name of the individual.
-     */
-    last_name?: string | null;
-    /**
-     * The legal middle name of the individual.
-     */
-    middle_name?: string | null;
-    phone_numbers?: Array<Individual.PhoneNumber | null> | null;
-    /**
-     * The preferred name of the individual.
-     */
-    preferred_name?: string | null;
-    residence?: HRISAPI.Location | null;
-    /**
-     * 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.
-     * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
-     */
-    ssn?: string | null;
-}
+export type Individual = Individual.UnionMember0 | Individual.BatchError;
 export declare namespace Individual {
-    interface Email {
-        data?: string;
-        type?: 'work' | 'personal' | null;
+    interface UnionMember0 {
+        /**
+         * A stable Finch `id` (UUID v4) for an individual in the company.
+         */
+        id: string;
+        dob: 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 legal last name of the individual.
+         */
+        last_name: string | null;
+        /**
+         * The legal middle name of the individual.
+         */
+        middle_name: string | null;
+        phone_numbers: Array<UnionMember0.PhoneNumber | null> | null;
+        /**
+         * The preferred name of the individual.
+         */
+        preferred_name: string | null;
+        residence: HRISAPI.Location | null;
+        emails?: Array<UnionMember0.Email> | 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;
+        /**
+         * 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.
+         * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
+         */
+        ssn?: string | null;
+    }
+    namespace UnionMember0 {
+        interface PhoneNumber {
+            data: string | null;
+            type: 'work' | 'personal' | null;
+        }
+        interface Email {
+            data: string;
+            type: 'work' | 'personal' | null;
+        }
     }
-    interface PhoneNumber {
-        data?: string | null;
-        type?: 'work' | 'personal' | null;
+    interface BatchError {
+        code: number;
+        message: string;
+        name: string;
+        finch_code?: string;
     }
 }
 export interface IndividualResponse {
-    body?: Individual;
-    code?: number;
-    individual_id?: string;
+    body: Individual;
+    code: number;
+    individual_id: string;
 }
 export interface IndividualRetrieveManyParams {
     options?: IndividualRetrieveManyParams.Options | null;

package/resources/hris/individuals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,YAAY,CACV,IAAI,CAAC,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,YAAY,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;CAc3G;AAED,qBAAa,uBAAwB,SAAQ,aAAa,CAAC,kBAAkB,CAAC;CAAG;AAEjF,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EACN,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEpC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,KAAK;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;KACnC;IAED,UAAiB,WAAW;QAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;KACnC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACxD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,OAAO;QACtB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
+{"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAAI,CAAC,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAChE,YAAY,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;CAc3G;AAED,qBAAa,uBAAwB,SAAQ,aAAa,CAAC,kBAAkB,CAAC;CAAG;AAEjF,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC;AAEzE,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,SAAS,EACL,OAAO,GACP,OAAO,GACP,2BAA2B,GAC3B,qCAAqC,GACrC,kCAAkC,GAClC,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,IAAI,CAAC;QAET;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;QAElE;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAE7D;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B,SAAS,EAAE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC,MAAM,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAE1C;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;;;WAKG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,WAAW;YAC1B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;SAClC;QAED,UAAiB,KAAK;YACpB,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;SAClC;KACF;IAED,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,CAAC;QAEb,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,CAAC;QAEb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,UAAU,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC;CACxD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,OAAO;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,OAAO;QACtB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,uBAAuB,IAAI,uBAAuB,EAClD,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}

package/resources/hris/individuals.js.map

@@ -1 +1 @@
-{"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAS1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAtBD,kCAsBC;AAED,MAAa,uBAAwB,SAAQ,0BAAiC;CAAG;AAAjF,0DAAiF;AA6GjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}
+{"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAG9C,oDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAiB1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA9BD,kCA8BC;AAED,MAAa,uBAAwB,SAAQ,0BAAiC;CAAG;AAAjF,0DAAiF;AA2HjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}

package/resources/hris/individuals.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"individuals.mjs","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAS1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,aAAiC;CAAG;AA6GjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}
+{"version":3,"file":"individuals.mjs","sourceRoot":"","sources":["../../src/resources/hris/individuals.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAGpB,EAAE,aAAa,EAAE;AAExB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAiB1C,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,EAAE,uBAAuB,EAAE;YAC9E,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAED,MAAM,OAAO,uBAAwB,SAAQ,aAAiC;CAAG;AA2HjF,WAAW,CAAC,uBAAuB,GAAG,uBAAuB,CAAC"}

package/resources/hris/pay-statements.d.ts

@@ -10,6 +10,22 @@ export declare class PayStatements extends APIResource {
      *
      * Deduction and contribution types are supported by the payroll systems that
      * supports Benefits.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
+     *   {
+     *     requests: [
+     *       {
+     *         payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       },
+     *     ],
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     retrieveMany(body: PayStatementRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<PayStatementResponsesPage, PayStatementResponse>;
 }

package/resources/hris/pay-statements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAOrE;AAED,qBAAa,yBAA0B,SAAQ,aAAa,CAAC,oBAAoB,CAAC;CAAG;AAErF,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;KACV;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}
+{"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../src/resources/hris/pay-statements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,OAAO,MAAM,QAAQ,CAAC;AAClC,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,CACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,yBAAyB,EAAE,oBAAoB,CAAC;CAOrE;AAED,qBAAa,yBAA0B,SAAQ,aAAa,CAAC,oBAAoB,CAAC;CAAG;AAErF,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhF,SAAS,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;KACV;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,iBAAiB;QAChC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,iBAAiB,CAAC;QACjC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,oBAAoB,CAAC,UAAU,GAAG,IAAI,CAAC;QAEpD;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;IAED,UAAiB,GAAG;QAClB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,GAAG,CAAC;QACnB,UAAiB,UAAU;YACzB,QAAQ,CAAC,EAAE,UAAU,CAAC,QAAQ,CAAC;SAChC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,QAAQ;gBACvB;;;;mBAIG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;aACpC;SACF;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,yBAAyB,IAAI,yBAAyB,EACtD,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/hris/pay-statements.js

@@ -10,6 +10,22 @@ class PayStatements extends resource_1.APIResource {
      *
      * Deduction and contribution types are supported by the payroll systems that
      * supports Benefits.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
+     *   {
+     *     requests: [
+     *       {
+     *         payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *       },
+     *     ],
+     *   },
+     * )) {
+     *   // ...
+     * }
+     * ```
      */
     retrieveMany(body, options) {
         return this._client.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {