@tryfinch/finch-api 6.30.0 → 7.0.0

package/resources/hris/benefits/benefits.mjs

@@ -1,19 +1,27 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../../resource.mjs";
-import { isRequestOptions } from "../../../core.mjs";
+import { APIResource } from "../../../core/resource.mjs";
 import * as IndividualsAPI from "./individuals.mjs";
-import { IndividualBenefitsSinglePage, Individuals, } from "./individuals.mjs";
-import { SinglePage } from "../../../pagination.mjs";
+import { Individuals, } from "./individuals.mjs";
+import { SinglePage } from "../../../core/pagination.mjs";
+import { path } from "../../../internal/utils/path.mjs";
 export class Benefits extends APIResource {
     constructor() {
         super(...arguments);
         this.individuals = new IndividualsAPI.Individuals(this._client);
     }
-    create(body = {}, options) {
-        if (isRequestOptions(body)) {
-            return this.create({}, body);
-        }
-        return this._client.post('/employer/benefits', { body, ...options });
+    /**
+     * Creates a new company-wide deduction or contribution. Please use the
+     * `/providers` endpoint to view available types for each provider.
+     *
+     * @example
+     * ```ts
+     * const createCompanyBenefitsResponse =
+     *   await client.hris.benefits.create();
+     * ```
+     */
+    create(params = {}, options) {
+        const { entity_ids, ...body } = params ?? {};
+        return this._client.post('/employer/benefits', { query: { entity_ids }, body, ...options });
     }
     /**
      * Lists deductions and contributions information for a given item
@@ -25,14 +33,25 @@ export class Benefits extends APIResource {
      * );
      * ```
      */
-    retrieve(benefitId, options) {
-        return this._client.get(`/employer/benefits/${benefitId}`, options);
+    retrieve(benefitID, query = {}, options) {
+        return this._client.get(path `/employer/benefits/${benefitID}`, { query, ...options });
     }
-    update(benefitId, body = {}, options) {
-        if (isRequestOptions(body)) {
-            return this.update(benefitId, {}, body);
-        }
-        return this._client.post(`/employer/benefits/${benefitId}`, { body, ...options });
+    /**
+     * Updates an existing company-wide deduction or contribution
+     *
+     * @example
+     * ```ts
+     * const updateCompanyBenefitResponse =
+     *   await client.hris.benefits.update('benefit_id');
+     * ```
+     */
+    update(benefitID, params = {}, options) {
+        const { entity_ids, ...body } = params ?? {};
+        return this._client.post(path `/employer/benefits/${benefitID}`, {
+            query: { entity_ids },
+            body,
+            ...options,
+        });
     }
     /**
      * List all company-wide deductions and contributions.
@@ -45,8 +64,8 @@ export class Benefits extends APIResource {
      * }
      * ```
      */
-    list(options) {
-        return this._client.getAPIList('/employer/benefits', CompanyBenefitsSinglePage, options);
+    list(query = {}, options) {
+        return this._client.getAPIList('/employer/benefits', (SinglePage), { query, ...options });
     }
     /**
      * Get deductions metadata
@@ -54,21 +73,17 @@ export class Benefits extends APIResource {
      * @example
      * ```ts
      * // Automatically fetches more pages as needed.
-     * for await (const benefitListSupportedBenefitsResponse of client.hris.benefits.listSupportedBenefits()) {
+     * for await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {
      *   // ...
      * }
      * ```
      */
-    listSupportedBenefits(options) {
-        return this._client.getAPIList('/employer/benefits/meta', BenefitListSupportedBenefitsResponsesSinglePage, options);
+    listSupportedBenefits(query = {}, options) {
+        return this._client.getAPIList('/employer/benefits/meta', (SinglePage), {
+            query,
+            ...options,
+        });
     }
 }
-export class CompanyBenefitsSinglePage extends SinglePage {
-}
-export class BenefitListSupportedBenefitsResponsesSinglePage extends SinglePage {
-}
-Benefits.CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
-Benefits.BenefitListSupportedBenefitsResponsesSinglePage = BenefitListSupportedBenefitsResponsesSinglePage;
 Benefits.Individuals = Individuals;
-Benefits.IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
 //# sourceMappingURL=benefits.mjs.map

package/resources/hris/benefits/benefits.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"benefits.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,KAAK,cAAc;OACnB,EAGL,4BAA4B,EAK5B,WAAW,GAEZ;OACM,EAAE,UAAU,EAAE;AAErB,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsGzF,CAAC;IArFC,MAAM,CACJ,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAiBD,MAAM,CACJ,SAAiB,EACjB,OAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,yBAAyB,EACzB,+CAA+C,EAC/C,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,UAA0B;CAAG;AAE5E,MAAM,OAAO,+CAAgD,SAAQ,UAAgD;CAAG;AAgUxH,QAAQ,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;AAC/D,QAAQ,CAAC,+CAA+C,GAAG,+CAA+C,CAAC;AAC3G,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;AACnC,QAAQ,CAAC,4BAA4B,GAAG,4BAA4B,CAAC"}
+{"version":3,"file":"benefits.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,cAAc;OACnB,EASL,WAAW,GAEZ;OAEM,EAAe,UAAU,EAAE;OAE3B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkGzF,CAAC;IAhGC;;;;;;;;;OASG;IACH,MAAM,CACJ,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CACN,SAAiB,EACjB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,SAAiB,EACjB,SAAiD,EAAE,EACnD,OAAwB;QAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,sBAAsB,SAAS,EAAE,EAAE;YAC9D,KAAK,EAAE,EAAE,UAAU,EAAE;YACrB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAA,UAA0B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,UAA4B,CAAA,EAAE;YACtF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA6TD,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC"}

package/resources/hris/benefits/index.d.mts

@@ -0,0 +1,3 @@
+export { Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenfitContribution, type BenefitCreateParams, type BenefitRetrieveParams, type BenefitUpdateParams, type BenefitListParams, type BenefitListSupportedBenefitsParams, type CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage, } from "./benefits.mjs";
+export { Individuals, type EnrolledIndividualBenefitResponse, type IndividualBenefit, type UnenrolledIndividualBenefitResponse, type IndividualEnrolledIDsResponse, type IndividualEnrollManyParams, type IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams, type IndividualUnenrollManyParams, type IndividualBenefitsSinglePage, } from "./individuals.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/hris/benefits/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,kCAAkC,EACvC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,GACjC;OACM,EACL,WAAW,EACX,KAAK,iCAAiC,EACtC,KAAK,iBAAiB,EACtB,KAAK,mCAAmC,EACxC,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,GAClC"}

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

@@ -1,3 +1,3 @@
-export { CompanyBenefitsSinglePage, BenefitListSupportedBenefitsResponsesSinglePage, Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenefitListSupportedBenefitsResponse, type BenfitContribution, type BenefitCreateParams, type BenefitUpdateParams, } from "./benefits.js";
-export { IndividualBenefitsSinglePage, Individuals, type EnrolledIndividualBenefitResponse, type IndividualBenefit, type UnenrolledIndividualBenefitResponse, type IndividualEnrolledIDsResponse, type IndividualEnrollManyParams, type IndividualRetrieveManyBenefitsParams, type IndividualUnenrollManyParams, } from "./individuals.js";
+export { Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenfitContribution, type BenefitCreateParams, type BenefitRetrieveParams, type BenefitUpdateParams, type BenefitListParams, type BenefitListSupportedBenefitsParams, type CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage, } from "./benefits.js";
+export { Individuals, type EnrolledIndividualBenefitResponse, type IndividualBenefit, type UnenrolledIndividualBenefitResponse, type IndividualEnrolledIDsResponse, type IndividualEnrollManyParams, type IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams, type IndividualUnenrollManyParams, type IndividualBenefitsSinglePage, } from "./individuals.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,yBAAyB,EACzB,+CAA+C,EAC/C,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,oCAAoC,EACzC,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,4BAA4B,EAC5B,WAAW,EACX,KAAK,iCAAiC,EACtC,KAAK,iBAAiB,EACtB,KAAK,mCAAmC,EACxC,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,GAClC,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":"OAEO,EACL,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,kCAAkC,EACvC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,GACjC;OACM,EACL,WAAW,EACX,KAAK,iCAAiC,EACtC,KAAK,iBAAiB,EACtB,KAAK,mCAAmC,EACxC,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,EACjC,KAAK,4BAA4B,GAClC"}

package/resources/hris/benefits/index.js

@@ -1,12 +1,9 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Individuals = exports.IndividualBenefitsSinglePage = exports.Benefits = exports.BenefitListSupportedBenefitsResponsesSinglePage = exports.CompanyBenefitsSinglePage = void 0;
+exports.Individuals = exports.Benefits = void 0;
 var benefits_1 = require("./benefits.js");
-Object.defineProperty(exports, "CompanyBenefitsSinglePage", { enumerable: true, get: function () { return benefits_1.CompanyBenefitsSinglePage; } });
-Object.defineProperty(exports, "BenefitListSupportedBenefitsResponsesSinglePage", { enumerable: true, get: function () { return benefits_1.BenefitListSupportedBenefitsResponsesSinglePage; } });
 Object.defineProperty(exports, "Benefits", { enumerable: true, get: function () { return benefits_1.Benefits; } });
 var individuals_1 = require("./individuals.js");
-Object.defineProperty(exports, "IndividualBenefitsSinglePage", { enumerable: true, get: function () { return individuals_1.IndividualBenefitsSinglePage; } });
 Object.defineProperty(exports, "Individuals", { enumerable: true, get: function () { return individuals_1.Individuals; } });
 //# sourceMappingURL=index.js.map

package/resources/hris/benefits/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0CAkBoB;AAjBlB,qHAAA,yBAAyB,OAAA;AACzB,2IAAA,+CAA+C,OAAA;AAC/C,oGAAA,QAAQ,OAAA;AAgBV,gDAUuB;AATrB,2HAAA,4BAA4B,OAAA;AAC5B,0GAAA,WAAW,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,0CAoBoB;AAnBlB,oGAAA,QAAQ,OAAA;AAoBV,gDAWuB;AAVrB,0GAAA,WAAW,OAAA"}

package/resources/hris/benefits/index.mjs

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-export { CompanyBenefitsSinglePage, BenefitListSupportedBenefitsResponsesSinglePage, Benefits, } from "./benefits.mjs";
-export { IndividualBenefitsSinglePage, Individuals, } from "./individuals.mjs";
+export { Benefits, } from "./benefits.mjs";
+export { Individuals, } from "./individuals.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/hris/benefits/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,yBAAyB,EACzB,+CAA+C,EAC/C,QAAQ,GAeT;OACM,EACL,4BAA4B,EAC5B,WAAW,GAQZ"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/hris/benefits/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,QAAQ,GAmBT;OACM,EACL,WAAW,GAUZ"}

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

@@ -0,0 +1,288 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { PagePromise, SinglePage } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Individuals extends APIResource {
+    /**
+     * Enroll an individual into a deduction or contribution. This is an overwrite
+     * operation. If the employee is already enrolled, the enrollment amounts will be
+     * adjusted. Making the same request multiple times will not create new
+     * enrollments, but will continue to set the state of the existing enrollment.
+     *
+     * @example
+     * ```ts
+     * const enrolledIndividualBenefitResponse =
+     *   await client.hris.benefits.individuals.enrollMany(
+     *     'benefit_id',
+     *   );
+     * ```
+     */
+    enrollMany(benefitID: string, params?: IndividualEnrollManyParams | null | undefined, options?: RequestOptions): APIPromise<EnrolledIndividualBenefitResponse>;
+    /**
+     * Lists individuals currently enrolled in a given deduction.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.hris.benefits.individuals.enrolledIDs(
+     *     'benefit_id',
+     *   );
+     * ```
+     */
+    enrolledIDs(benefitID: string, query?: IndividualEnrolledIDsParams | null | undefined, options?: RequestOptions): APIPromise<IndividualEnrolledIDsResponse>;
+    /**
+     * Get enrollment information for the given individuals.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(
+     *   'benefit_id',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    retrieveManyBenefits(benefitID: string, query?: IndividualRetrieveManyBenefitsParams | null | undefined, options?: RequestOptions): PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
+    /**
+     * Unenroll individuals from a deduction or contribution
+     *
+     * @example
+     * ```ts
+     * const unenrolledIndividualBenefitResponse =
+     *   await client.hris.benefits.individuals.unenrollMany(
+     *     'benefit_id',
+     *   );
+     * ```
+     */
+    unenrollMany(benefitID: string, params?: IndividualUnenrollManyParams | null | undefined, options?: RequestOptions): APIPromise<UnenrolledIndividualBenefitResponse>;
+}
+export type IndividualBenefitsSinglePage = SinglePage<IndividualBenefit>;
+export interface EnrolledIndividualBenefitResponse {
+    job_id: string;
+}
+export interface IndividualBenefit {
+    body: IndividualBenefit.UnionMember0 | IndividualBenefit.BatchError;
+    code: number;
+    individual_id: string;
+}
+export declare namespace IndividualBenefit {
+    interface UnionMember0 {
+        /**
+         * 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 configuration. Supports fixed amounts (in cents),
+         * percentage-based contributions (in basis points where 100 = 1%), or tiered
+         * matching structures.
+         */
+        company_contribution: UnionMember0.UnionMember0 | UnionMember0.UnionMember1 | UnionMember0.UnionMember2 | null;
+        /**
+         * Employee deduction configuration. Supports both fixed amounts (in cents) and
+         * percentage-based contributions (in basis points where 100 = 1%).
+         */
+        employee_deduction: UnionMember0.UnionMember0 | UnionMember0.UnionMember1 | null;
+        /**
+         * Type for HSA contribution limit if the benefit is a HSA.
+         */
+        hsa_contribution_limit?: 'individual' | 'family' | null;
+    }
+    namespace UnionMember0 {
+        interface UnionMember0 {
+            /**
+             * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
+             * where 100 = 1%). Not used for type=tiered.
+             */
+            amount: number;
+            /**
+             * Contribution type. Supported values: "fixed" (amount in cents), "percent"
+             * (amount in basis points), or "tiered" (multi-tier matching).
+             */
+            type: 'fixed';
+        }
+        interface UnionMember1 {
+            /**
+             * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
+             * where 100 = 1%). Not used for type=tiered.
+             */
+            amount: number;
+            /**
+             * Contribution type. Supported values: "fixed" (amount in cents), "percent"
+             * (amount in basis points), or "tiered" (multi-tier matching).
+             */
+            type: 'percent';
+        }
+        interface UnionMember2 {
+            /**
+             * Array of tier objects defining employer match tiers based on employee
+             * contribution thresholds. Required when type=tiered.
+             */
+            tiers: Array<UnionMember2.Tier>;
+            /**
+             * Contribution type. Supported values: "fixed" (amount in cents), "percent"
+             * (amount in basis points), or "tiered" (multi-tier matching).
+             */
+            type: 'tiered';
+        }
+        namespace UnionMember2 {
+            interface Tier {
+                match: number;
+                threshold: number;
+            }
+        }
+        interface UnionMember0 {
+            /**
+             * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
+             * where 100 = 1%).
+             */
+            amount: number;
+            /**
+             * Contribution type. Supported values: "fixed" (amount in cents) or "percent"
+             * (amount in basis points).
+             */
+            type: 'fixed';
+        }
+        interface UnionMember1 {
+            /**
+             * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
+             * where 100 = 1%).
+             */
+            amount: number;
+            /**
+             * Contribution type. Supported values: "fixed" (amount in cents) or "percent"
+             * (amount in basis points).
+             */
+            type: 'percent';
+        }
+    }
+    interface BatchError {
+        code: number;
+        message: string;
+        name: string;
+        finch_code?: string;
+    }
+}
+export interface UnenrolledIndividualBenefitResponse {
+    job_id: string;
+}
+export interface IndividualEnrolledIDsResponse {
+    /**
+     * The id of the benefit.
+     */
+    benefit_id: string;
+    individual_ids: Array<string>;
+}
+export interface IndividualEnrollManyParams {
+    /**
+     * Query param: The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+    /**
+     * Body param: Array of the individual_id to enroll and a configuration object.
+     */
+    individuals?: Array<IndividualEnrollManyParams.Individual>;
+}
+export declare namespace IndividualEnrollManyParams {
+    interface Individual {
+        configuration?: Individual.Configuration;
+        /**
+         * Finch id (uuidv4) for the individual to enroll
+         */
+        individual_id?: string;
+    }
+    namespace Individual {
+        interface Configuration {
+            /**
+             * For HSA benefits only - whether the contribution limit is for an individual or
+             * family
+             */
+            annual_contribution_limit?: 'individual' | 'family';
+            /**
+             * Maximum annual amount in cents
+             */
+            annual_maximum?: number | null;
+            /**
+             * For retirement benefits only - whether catch up contributions are enabled
+             */
+            catch_up?: boolean;
+            company_contribution?: Configuration.CompanyContribution;
+            /**
+             * The date the enrollment will take effect
+             */
+            effective_date?: string;
+            employee_deduction?: Configuration.EmployeeDeduction;
+        }
+        namespace Configuration {
+            interface CompanyContribution {
+                /**
+                 * Amount in cents for fixed type or basis points (1/100th of a percent) for
+                 * percent type
+                 */
+                amount?: number;
+                /**
+                 * Array of tier objects for tiered contribution matching (required when type is
+                 * tiered)
+                 */
+                tiers?: Array<CompanyContribution.Tier>;
+                type?: 'fixed' | 'percent' | 'tiered';
+            }
+            namespace CompanyContribution {
+                interface Tier {
+                    /**
+                     * The employer match percentage in basis points (0-10000 = 0-100%)
+                     */
+                    match: number;
+                    /**
+                     * The employee contribution threshold in basis points (0-10000 = 0-100%)
+                     */
+                    threshold: number;
+                }
+            }
+            interface EmployeeDeduction {
+                /**
+                 * Amount in cents for fixed type or basis points (1/100th of a percent) for
+                 * percent type
+                 */
+                amount?: number;
+                type?: 'fixed' | 'percent';
+            }
+        }
+    }
+}
+export interface IndividualEnrolledIDsParams {
+    /**
+     * The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+}
+export interface IndividualRetrieveManyBenefitsParams {
+    /**
+     * The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+    /**
+     * comma-delimited list of stable Finch uuids for each individual. If empty,
+     * defaults to all individuals
+     */
+    individual_ids?: string;
+}
+export interface IndividualUnenrollManyParams {
+    /**
+     * Query param: The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+    /**
+     * Body param: Array of individual_ids to unenroll.
+     */
+    individual_ids?: Array<string>;
+}
+export declare namespace Individuals {
+    export { type EnrolledIndividualBenefitResponse as EnrolledIndividualBenefitResponse, type IndividualBenefit as IndividualBenefit, type UnenrolledIndividualBenefitResponse as UnenrolledIndividualBenefitResponse, type IndividualEnrolledIDsResponse as IndividualEnrolledIDsResponse, type IndividualBenefitsSinglePage as IndividualBenefitsSinglePage, type IndividualEnrollManyParams as IndividualEnrollManyParams, type IndividualEnrolledIDsParams as IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams, type IndividualUnenrollManyParams as IndividualUnenrollManyParams, };
+}
+//# sourceMappingURL=individuals.d.mts.map

package/resources/hris/benefits/individuals.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"individuals.d.mts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/individuals.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,UAAU,EAAE;OAC3B,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAqB,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAShD;;;;;;;;;;OAUG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAI5C;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAClB,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,oCAAoC,GAAG,IAAI,GAAG,SAAc,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;IAQ/D;;;;;;;;;;OAUG;IACH,YAAY,CACV,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;CAQnD;AAED,MAAM,MAAM,4BAA4B,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAEzE,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,iBAAiB,CAAC,YAAY,GAAG,iBAAiB,CAAC,UAAU,CAAC;IAEpE,IAAI,EAAE,MAAM,CAAC;IAEb,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,YAAY;QAC3B;;WAEG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;;;WAIG;QACH,oBAAoB,EAChB,YAAY,CAAC,YAAY,GACzB,YAAY,CAAC,YAAY,GACzB,YAAY,CAAC,YAAY,GACzB,IAAI,CAAC;QAET;;;WAGG;QACH,kBAAkB,EAAE,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC;QAEjF;;WAEG;QACH,sBAAsB,CAAC,EAAE,YAAY,GAAG,QAAQ,GAAG,IAAI,CAAC;KACzD;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,YAAY;YAC3B;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,IAAI,EAAE,OAAO,CAAC;SACf;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,IAAI,EAAE,SAAS,CAAC;SACjB;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAEhC;;;eAGG;YACH,IAAI,EAAE,QAAQ,CAAC;SAChB;QAED,UAAiB,YAAY,CAAC;YAC5B,UAAiB,IAAI;gBACnB,KAAK,EAAE,MAAM,CAAC;gBAEd,SAAS,EAAE,MAAM,CAAC;aACnB;SACF;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,IAAI,EAAE,OAAO,CAAC;SACf;QAED,UAAiB,YAAY;YAC3B;;;eAGG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;;eAGG;YACH,IAAI,EAAE,SAAS,CAAC;SACjB;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,mCAAmC;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC;CAC5D;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,UAAiB,UAAU;QACzB,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC;QAEzC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,UAAU,CAAC;QAC1B,UAAiB,aAAa;YAC5B;;;eAGG;YACH,yBAAyB,CAAC,EAAE,YAAY,GAAG,QAAQ,CAAC;YAEpD;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE/B;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAC;YAEnB,oBAAoB,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC;YAEzD;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB,kBAAkB,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;SACtD;QAED,UAAiB,aAAa,CAAC;YAC7B,UAAiB,mBAAmB;gBAClC;;;mBAGG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;;mBAGG;gBACH,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;gBAExC,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;aACvC;YAED,UAAiB,mBAAmB,CAAC;gBACnC,UAAiB,IAAI;oBACnB;;uBAEG;oBACH,KAAK,EAAE,MAAM,CAAC;oBAEd;;uBAEG;oBACH,SAAS,EAAE,MAAM,CAAC;iBACnB;aACF;YAED,UAAiB,iBAAiB;gBAChC;;;mBAGG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;aAC5B;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,oCAAoC;IACnD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}