@tryfinch/finch-api 5.1.0 → 5.3.0

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

@@ -1,180 +1,162 @@
 import * as Core from '@tryfinch/finch-api/core';
 import { APIResource } from '@tryfinch/finch-api/resource';
 import * as Benefits from '@tryfinch/finch-api/resources/hris/benefits/index';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { SinglePage } from '@tryfinch/finch-api/pagination';
 export declare class Individuals extends APIResource {
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Enroll an individual into a benefit. If the employee is already enrolled, the
-   * enrollment amounts will be adjusted.
-   *
-   * <!-- theme: warning -->
-   *
-   * > Making changes to an individual's benefits may have tax consequences based on
-   * > IRS regulations. Please consult a tax expert to ensure all changes being made
-   * > to the system are compliant with local, state, and federal law.
-   */
-  enrollMany(
-    benefitId: string,
-    body: IndividualEnrollManyParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<EnrolledIndividualsSinglePage, EnrolledIndividual>;
-  /**
-   * **Availability: Automated Benefits providers only**
-   *
-   * Lists individuals currently enrolled in a given benefit.
-   */
-  enrolledIds(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<IndividualEnrolledIDsResponse>;
-  /**
-   * **Availability: Automated Benefits providers only**
-   *
-   * Get enrolled benefit information for the given individuals.
-   */
-  retrieveManyBenefits(
-    benefitId: string,
-    query?: IndividualRetrieveManyBenefitsParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
-  retrieveManyBenefits(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Unenroll individuals from a benefit
-   */
-  unenrollMany(
-    benefitId: string,
-    body?: IndividualUnenrollManyParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
-  unenrollMany(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Enroll an individual into a benefit. If the employee is already enrolled, the
+     * enrollment amounts will be adjusted.
+     *
+     * <!-- theme: warning -->
+     *
+     * > Making changes to an individual's benefits may have tax consequences based on
+     * > IRS regulations. Please consult a tax expert to ensure all changes being made
+     * > to the system are compliant with local, state, and federal law.
+     */
+    enrollMany(benefitId: string, body: IndividualEnrollManyParams, options?: Core.RequestOptions): Core.PagePromise<EnrolledIndividualsSinglePage, EnrolledIndividual>;
+    /**
+     * **Availability: Automated Benefits providers only**
+     *
+     * Lists individuals currently enrolled in a given benefit.
+     */
+    enrolledIds(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<IndividualEnrolledIDsResponse>;
+    /**
+     * **Availability: Automated Benefits providers only**
+     *
+     * Get enrolled benefit information for the given individuals.
+     */
+    retrieveManyBenefits(benefitId: string, query?: IndividualRetrieveManyBenefitsParams, options?: Core.RequestOptions): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
+    retrieveManyBenefits(benefitId: string, options?: Core.RequestOptions): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Unenroll individuals from a benefit
+     */
+    unenrollMany(benefitId: string, body?: IndividualUnenrollManyParams, options?: Core.RequestOptions): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
+    unenrollMany(benefitId: string, options?: Core.RequestOptions): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
+}
+export declare class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {
 }
-export declare class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {}
 type _EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
-export declare class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
+export declare class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {
+}
 type _IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
-export declare class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {}
+export declare class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {
+}
 type _UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
 export interface EnrolledIndividual {
-  body?: EnrolledIndividual.Body;
-  /**
-   * HTTP status code. Either 201 or 200
-   */
-  code?: 200 | 201 | 404 | 403;
-  individual_id?: string;
-}
-export declare namespace EnrolledIndividual {
-  interface Body {
-    /**
-     * A descriptive identifier for the response
-     */
-    finch_code?: string | null;
-    /**
-     * Short description in English that provides more information about the response.
-     */
-    message?: string | null;
+    body?: EnrolledIndividual.Body;
     /**
-     * Identifier indicating whether the benefit was newly enrolled or updated.
+     * HTTP status code. Either 201 or 200
      */
-    name?: string | null;
-  }
+    code?: 200 | 201 | 404 | 403;
+    individual_id?: string;
+}
+export declare namespace EnrolledIndividual {
+    interface Body {
+        /**
+         * A descriptive identifier for the response
+         */
+        finch_code?: string | null;
+        /**
+         * Short description in English that provides more information about the response.
+         */
+        message?: string | null;
+        /**
+         * Identifier indicating whether the benefit was newly enrolled or updated.
+         */
+        name?: string | null;
+    }
 }
 export interface IndividualBenefit {
-  body?: IndividualBenefit.Body;
-  code?: number;
-  individual_id?: string;
+    body?: IndividualBenefit.Body;
+    code?: number;
+    individual_id?: string;
 }
 export declare namespace IndividualBenefit {
-  interface Body {
-    /**
-     * If the benefit supports annual maximum, the amount in cents for this individual.
-     */
-    annual_maximum?: number | null;
-    /**
-     * If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
-     * for this individual.
-     */
-    catch_up?: boolean | null;
-    company_contribution?: Benefits.BenfitContribution | null;
-    employee_deduction?: Benefits.BenfitContribution | null;
-    /**
-     * Type for HSA contribution limit if the benefit is a HSA.
-     */
-    hsa_contribution_limit?: 'individual' | 'family' | null;
-  }
+    interface Body {
+        /**
+         * If the benefit supports annual maximum, the amount in cents for this individual.
+         */
+        annual_maximum?: number | null;
+        /**
+         * If the benefit supports catch up (401k, 403b, etc.), whether catch up is enabled
+         * for this individual.
+         */
+        catch_up?: boolean | null;
+        company_contribution?: Benefits.BenfitContribution | null;
+        employee_deduction?: Benefits.BenfitContribution | null;
+        /**
+         * Type for HSA contribution limit if the benefit is a HSA.
+         */
+        hsa_contribution_limit?: 'individual' | 'family' | null;
+    }
 }
 export interface UnenrolledIndividual {
-  body?: UnenrolledIndividual.Body;
-  /**
-   * HTTP status code
-   */
-  code?: number;
-  individual_id?: string;
-}
-export declare namespace UnenrolledIndividual {
-  interface Body {
-    /**
-     * A descriptive identifier for the response.
-     */
-    finch_code?: string | null;
-    /**
-     * Short description in English that provides more information about the response.
-     */
-    message?: string | null;
+    body?: UnenrolledIndividual.Body;
     /**
-     * Identifier indicating whether the benefit was newly enrolled or updated.
+     * HTTP status code
      */
-    name?: string | null;
-  }
+    code?: number;
+    individual_id?: string;
+}
+export declare namespace UnenrolledIndividual {
+    interface Body {
+        /**
+         * A descriptive identifier for the response.
+         */
+        finch_code?: string | null;
+        /**
+         * Short description in English that provides more information about the response.
+         */
+        message?: string | null;
+        /**
+         * Identifier indicating whether the benefit was newly enrolled or updated.
+         */
+        name?: string | null;
+    }
 }
 export interface IndividualEnrolledIDsResponse {
-  benefit_id: string;
-  individual_ids: Array<string>;
+    benefit_id: string;
+    individual_ids: Array<string>;
 }
 export type IndividualEnrollManyParams = Array<IndividualEnrollManyParams.Individual>;
 export declare namespace IndividualEnrollManyParams {
-  interface Individual {
-    configuration?: unknown;
-    /**
-     * Finch id (uuidv4) for the individual to enroll
-     */
-    individual_id?: string;
-  }
+    interface Individual {
+        configuration?: unknown;
+        /**
+         * Finch id (uuidv4) for the individual to enroll
+         */
+        individual_id?: string;
+    }
 }
 export interface IndividualRetrieveManyBenefitsParams {
-  /**
-   * comma-delimited list of stable Finch uuids for each individual. If empty,
-   * defaults to all individuals
-   */
-  individual_ids?: string;
+    /**
+     * comma-delimited list of stable Finch uuids for each individual. If empty,
+     * defaults to all individuals
+     */
+    individual_ids?: string;
 }
 export interface IndividualUnenrollManyParams {
-  /**
-   * Array of individual_ids to unenroll.
-   */
-  individual_ids?: Array<string>;
+    /**
+     * Array of individual_ids to unenroll.
+     */
+    individual_ids?: Array<string>;
 }
 export declare namespace Individuals {
-  export import EnrolledIndividual = API.EnrolledIndividual;
-  export import IndividualBenefit = API.IndividualBenefit;
-  export import UnenrolledIndividual = API.UnenrolledIndividual;
-  export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
-  type EnrolledIndividualsSinglePage = _EnrolledIndividualsSinglePage;
-  type IndividualBenefitsSinglePage = _IndividualBenefitsSinglePage;
-  type UnenrolledIndividualsSinglePage = _UnenrolledIndividualsSinglePage;
-  export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
-  export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
-  export import IndividualUnenrollManyParams = API.IndividualUnenrollManyParams;
+    export import EnrolledIndividual = API.EnrolledIndividual;
+    export import IndividualBenefit = API.IndividualBenefit;
+    export import UnenrolledIndividual = API.UnenrolledIndividual;
+    export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
+    type EnrolledIndividualsSinglePage = _EnrolledIndividualsSinglePage;
+    type IndividualBenefitsSinglePage = _IndividualBenefitsSinglePage;
+    type UnenrolledIndividualsSinglePage = _UnenrolledIndividualsSinglePage;
+    export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
+    export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
+    export import IndividualUnenrollManyParams = API.IndividualUnenrollManyParams;
 }
 export {};
-//# sourceMappingURL=individuals.d.ts.map
+//# sourceMappingURL=individuals.d.ts.map

package/resources/hris/benefits/individuals.js

@@ -1,68 +1,68 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.UnenrolledIndividualsSinglePage =
-  exports.IndividualBenefitsSinglePage =
-  exports.EnrolledIndividualsSinglePage =
-  exports.Individuals =
-    void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
-const core_1 = require('@tryfinch/finch-api/core');
-const pagination_1 = require('@tryfinch/finch-api/pagination');
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnenrolledIndividualsSinglePage = exports.IndividualBenefitsSinglePage = exports.EnrolledIndividualsSinglePage = exports.Individuals = void 0;
+const resource_1 = require("@tryfinch/finch-api/resource");
+const core_1 = require("@tryfinch/finch-api/core");
+const pagination_1 = require("@tryfinch/finch-api/pagination");
 class Individuals extends resource_1.APIResource {
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Enroll an individual into a benefit. If the employee is already enrolled, the
-   * enrollment amounts will be adjusted.
-   *
-   * <!-- theme: warning -->
-   *
-   * > Making changes to an individual's benefits may have tax consequences based on
-   * > IRS regulations. Please consult a tax expert to ensure all changes being made
-   * > to the system are compliant with local, state, and federal law.
-   */
-  enrollMany(benefitId, body, options) {
-    return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, EnrolledIndividualsSinglePage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
-  /**
-   * **Availability: Automated Benefits providers only**
-   *
-   * Lists individuals currently enrolled in a given benefit.
-   */
-  enrolledIds(benefitId, options) {
-    return this.get(`/employer/benefits/${benefitId}/enrolled`, options);
-  }
-  retrieveManyBenefits(benefitId, query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.retrieveManyBenefits(benefitId, {}, query);
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Enroll an individual into a benefit. If the employee is already enrolled, the
+     * enrollment amounts will be adjusted.
+     *
+     * <!-- theme: warning -->
+     *
+     * > Making changes to an individual's benefits may have tax consequences based on
+     * > IRS regulations. Please consult a tax expert to ensure all changes being made
+     * > to the system are compliant with local, state, and federal law.
+     */
+    enrollMany(benefitId, body, options) {
+        return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, EnrolledIndividualsSinglePage, {
+            body,
+            method: 'post',
+            ...options,
+        });
     }
-    return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, IndividualBenefitsSinglePage, {
-      query,
-      ...options,
-    });
-  }
-  unenrollMany(benefitId, body = {}, options) {
-    if ((0, core_1.isRequestOptions)(body)) {
-      return this.unenrollMany(benefitId, {}, body);
+    /**
+     * **Availability: Automated Benefits providers only**
+     *
+     * Lists individuals currently enrolled in a given benefit.
+     */
+    enrolledIds(benefitId, options) {
+        return this.get(`/employer/benefits/${benefitId}/enrolled`, options);
+    }
+    retrieveManyBenefits(benefitId, query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.retrieveManyBenefits(benefitId, {}, query);
+        }
+        return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, IndividualBenefitsSinglePage, {
+            query,
+            ...options,
+        });
+    }
+    unenrollMany(benefitId, body = {}, options) {
+        if ((0, core_1.isRequestOptions)(body)) {
+            return this.unenrollMany(benefitId, {}, body);
+        }
+        return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, UnenrolledIndividualsSinglePage, {
+            body,
+            method: 'delete',
+            ...options,
+        });
     }
-    return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, UnenrolledIndividualsSinglePage, {
-      body,
-      method: 'delete',
-      ...options,
-    });
-  }
 }
 exports.Individuals = Individuals;
-class EnrolledIndividualsSinglePage extends pagination_1.SinglePage {}
+class EnrolledIndividualsSinglePage extends pagination_1.SinglePage {
+}
 exports.EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
-class IndividualBenefitsSinglePage extends pagination_1.SinglePage {}
+class IndividualBenefitsSinglePage extends pagination_1.SinglePage {
+}
 exports.IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
-class UnenrolledIndividualsSinglePage extends pagination_1.SinglePage {}
+class UnenrolledIndividualsSinglePage extends pagination_1.SinglePage {
+}
 exports.UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
-(function (Individuals) {})((Individuals = exports.Individuals || (exports.Individuals = {})));
-//# sourceMappingURL=individuals.js.map
+(function (Individuals) {
+})(Individuals = exports.Individuals || (exports.Individuals = {}));
+//# sourceMappingURL=individuals.js.map

package/resources/hris/benefits/individuals.mjs

@@ -3,55 +3,59 @@ import { APIResource } from '@tryfinch/finch-api/resource';
 import { isRequestOptions } from '@tryfinch/finch-api/core';
 import { SinglePage } from '@tryfinch/finch-api/pagination';
 export class Individuals extends APIResource {
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Enroll an individual into a benefit. If the employee is already enrolled, the
-   * enrollment amounts will be adjusted.
-   *
-   * <!-- theme: warning -->
-   *
-   * > Making changes to an individual's benefits may have tax consequences based on
-   * > IRS regulations. Please consult a tax expert to ensure all changes being made
-   * > to the system are compliant with local, state, and federal law.
-   */
-  enrollMany(benefitId, body, options) {
-    return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, EnrolledIndividualsSinglePage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
-  /**
-   * **Availability: Automated Benefits providers only**
-   *
-   * Lists individuals currently enrolled in a given benefit.
-   */
-  enrolledIds(benefitId, options) {
-    return this.get(`/employer/benefits/${benefitId}/enrolled`, options);
-  }
-  retrieveManyBenefits(benefitId, query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.retrieveManyBenefits(benefitId, {}, query);
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Enroll an individual into a benefit. If the employee is already enrolled, the
+     * enrollment amounts will be adjusted.
+     *
+     * <!-- theme: warning -->
+     *
+     * > Making changes to an individual's benefits may have tax consequences based on
+     * > IRS regulations. Please consult a tax expert to ensure all changes being made
+     * > to the system are compliant with local, state, and federal law.
+     */
+    enrollMany(benefitId, body, options) {
+        return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, EnrolledIndividualsSinglePage, {
+            body,
+            method: 'post',
+            ...options,
+        });
     }
-    return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, IndividualBenefitsSinglePage, {
-      query,
-      ...options,
-    });
-  }
-  unenrollMany(benefitId, body = {}, options) {
-    if (isRequestOptions(body)) {
-      return this.unenrollMany(benefitId, {}, body);
+    /**
+     * **Availability: Automated Benefits providers only**
+     *
+     * Lists individuals currently enrolled in a given benefit.
+     */
+    enrolledIds(benefitId, options) {
+        return this.get(`/employer/benefits/${benefitId}/enrolled`, options);
     }
-    return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, UnenrolledIndividualsSinglePage, {
-      body,
-      method: 'delete',
-      ...options,
-    });
-  }
+    retrieveManyBenefits(benefitId, query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.retrieveManyBenefits(benefitId, {}, query);
+        }
+        return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, IndividualBenefitsSinglePage, {
+            query,
+            ...options,
+        });
+    }
+    unenrollMany(benefitId, body = {}, options) {
+        if (isRequestOptions(body)) {
+            return this.unenrollMany(benefitId, {}, body);
+        }
+        return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, UnenrolledIndividualsSinglePage, {
+            body,
+            method: 'delete',
+            ...options,
+        });
+    }
+}
+export class EnrolledIndividualsSinglePage extends SinglePage {
+}
+export class IndividualBenefitsSinglePage extends SinglePage {
+}
+export class UnenrolledIndividualsSinglePage extends SinglePage {
 }
-export class EnrolledIndividualsSinglePage extends SinglePage {}
-export class IndividualBenefitsSinglePage extends SinglePage {}
-export class UnenrolledIndividualsSinglePage extends SinglePage {}
-(function (Individuals) {})(Individuals || (Individuals = {}));
-//# sourceMappingURL=individuals.mjs.map
+(function (Individuals) {
+})(Individuals || (Individuals = {}));
+//# sourceMappingURL=individuals.mjs.map