@tryfinch/finch-api 6.31.0 → 7.0.0

package/resources/connect/sessions.d.ts

@@ -1,14 +1,15 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class Sessions extends APIResource {
     /**
      * Create a new connect session for an employer
      */
-    new(body: SessionNewParams, options?: Core.RequestOptions): Core.APIPromise<SessionNewResponse>;
+    new(body: SessionNewParams, options?: RequestOptions): APIPromise<SessionNewResponse>;
     /**
      * Create a new Connect session for reauthenticating an existing connection
      */
-    reauthenticate(body: SessionReauthenticateParams, options?: Core.RequestOptions): Core.APIPromise<SessionReauthenticateResponse>;
+    reauthenticate(body: SessionReauthenticateParams, options?: RequestOptions): APIPromise<SessionReauthenticateResponse>;
 }
 export interface SessionNewResponse {
     /**
@@ -31,24 +32,57 @@ export interface SessionReauthenticateResponse {
     session_id: string;
 }
 export interface SessionNewParams {
+    /**
+     * Unique identifier for the customer
+     */
     customer_id: string;
+    /**
+     * Name of the customer
+     */
     customer_name: string;
-    products: Array<'company' | 'directory' | 'individual' | 'employment' | 'payment' | 'pay_statement' | 'benefits' | 'ssn' | 'deduction' | 'documents'>;
+    /**
+     * The Finch products to request access to
+     */
+    products: Array<'benefits' | 'company' | 'deduction' | 'directory' | 'documents' | 'employment' | 'individual' | 'payment' | 'pay_statement' | 'ssn'>;
+    /**
+     * Email address of the customer
+     */
     customer_email?: string | null;
+    /**
+     * Integration configuration for the connect session
+     */
     integration?: SessionNewParams.Integration | null;
+    /**
+     * Enable manual authentication mode
+     */
     manual?: boolean | null;
     /**
-     * The number of minutes until the session expires (defaults to 43,200, which is 30
-     * days)
+     * The number of minutes until the session expires (defaults to 129,600, which is
+     * 90 days)
      */
     minutes_to_expire?: number | null;
+    /**
+     * The URI to redirect to after the Connect flow is completed
+     */
     redirect_uri?: string | null;
+    /**
+     * Sandbox mode for testing
+     */
     sandbox?: 'finch' | 'provider' | null;
 }
 export declare namespace SessionNewParams {
+    /**
+     * Integration configuration for the connect session
+     */
     interface Integration {
+        /**
+         * The provider to integrate with
+         */
+        provider: string;
+        /**
+         * The authentication method to use
+         */
         auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token' | null;
-        provider?: string | null;
     }
 }
 export interface SessionReauthenticateParams {
@@ -60,11 +94,11 @@ export interface SessionReauthenticateParams {
      * The number of minutes until the session expires (defaults to 43,200, which is 30
      * days)
      */
-    minutes_to_expire?: number | null;
+    minutes_to_expire?: number;
     /**
      * The products to request access to (optional for reauthentication)
      */
-    products?: Array<'company' | 'directory' | 'individual' | 'employment' | 'payment' | 'pay_statement' | 'benefits' | 'ssn' | 'deduction' | 'documents'> | null;
+    products?: Array<'benefits' | 'company' | 'deduction' | 'directory' | 'documents' | 'employment' | 'individual' | 'payment' | 'pay_statement' | 'ssn'> | null;
     /**
      * The URI to redirect to after the Connect flow is completed
      */

package/resources/connect/sessions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../src/resources/connect/sessions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAI/F;;OAEG;IACH,cAAc,CACZ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC;CAGlD;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,KAAK,CACX,SAAS,GACT,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,eAAe,GACf,UAAU,GACV,KAAK,GACL,WAAW,GACX,WAAW,CACd,CAAC;IAEF,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,WAAW,CAAC,EAAE,gBAAgB,CAAC,WAAW,GAAG,IAAI,CAAC;IAElD,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,WAAW;QAC1B,WAAW,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC;QAEvE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CACZ,SAAS,GACT,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,eAAe,GACf,UAAU,GACV,KAAK,GACL,WAAW,GACX,WAAW,CACd,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
+{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../src/resources/connect/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAIrF;;OAEG;IACH,cAAc,CACZ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAG7C;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,KAAK,CACX,UAAU,GACV,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,eAAe,GACf,KAAK,CACR,CAAC;IAEF;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC,WAAW,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC;KACxE;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CACZ,UAAU,GACV,SAAS,GACT,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,eAAe,GACf,KAAK,CACR,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/connect/sessions.js

@@ -2,7 +2,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sessions = void 0;
-const resource_1 = require("../../resource.js");
+const resource_1 = require("../../core/resource.js");
 class Sessions extends resource_1.APIResource {
     /**
      * Create a new connect session for an employer

package/resources/connect/sessions.js.map

@@ -1 +1 @@
-{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../src/resources/connect/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,GAAG,CAAC,IAAsB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AAjBD,4BAiBC"}
+{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../src/resources/connect/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,GAAG,CAAC,IAAsB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AAjBD,4BAiBC"}

package/resources/connect/sessions.mjs

@@ -1,5 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { APIResource } from "../../resource.mjs";
+import { APIResource } from "../../core/resource.mjs";
 export class Sessions extends APIResource {
     /**
      * Create a new connect session for an employer

package/resources/connect/sessions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../src/resources/connect/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,GAAG,CAAC,IAAsB,EAAE,OAA6B;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,IAAiC,EACjC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}
+{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../src/resources/connect/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,GAAG,CAAC,IAAsB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,cAAc,CACZ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}

package/resources/connect.d.mts

@@ -0,0 +1,2 @@
+export * from "./connect/index.mjs";
+//# sourceMappingURL=connect.d.mts.map

package/resources/connect.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connect.d.mts","sourceRoot":"","sources":["../src/resources/connect.ts"],"names":[],"mappings":""}

package/resources/connect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../src/resources/connect.ts"],"names":[],"mappings":"AAEA,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"connect.d.ts","sourceRoot":"","sources":["../src/resources/connect.ts"],"names":[],"mappings":""}

package/resources/connect.js

@@ -1,19 +1,6 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./connect/index.js"), exports);
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./connect/index.js"), exports);
 //# sourceMappingURL=connect.js.map

package/resources/connect.js.map

@@ -1 +1 @@
-{"version":3,"file":"connect.js","sourceRoot":"","sources":["../src/resources/connect.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;AAEtF,qDAAgC"}
+{"version":3,"file":"connect.js","sourceRoot":"","sources":["../src/resources/connect.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6DAAgC"}

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

@@ -0,0 +1,298 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as Shared from "../../shared.mjs";
+import * as IndividualsAPI from "./individuals.mjs";
+import { EnrolledIndividualBenefitResponse, IndividualBenefit, IndividualBenefitsSinglePage, IndividualEnrollManyParams, IndividualEnrolledIDsParams, IndividualEnrolledIDsResponse, IndividualRetrieveManyBenefitsParams, IndividualUnenrollManyParams, Individuals, UnenrolledIndividualBenefitResponse } from "./individuals.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 Benefits extends APIResource {
+    individuals: IndividualsAPI.Individuals;
+    /**
+     * 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?: BenefitCreateParams | null | undefined, options?: RequestOptions): APIPromise<CreateCompanyBenefitsResponse>;
+    /**
+     * Lists deductions and contributions information for a given item
+     *
+     * @example
+     * ```ts
+     * const companyBenefit = await client.hris.benefits.retrieve(
+     *   'benefit_id',
+     * );
+     * ```
+     */
+    retrieve(benefitID: string, query?: BenefitRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CompanyBenefit>;
+    /**
+     * Updates an existing company-wide deduction or contribution
+     *
+     * @example
+     * ```ts
+     * const updateCompanyBenefitResponse =
+     *   await client.hris.benefits.update('benefit_id');
+     * ```
+     */
+    update(benefitID: string, params?: BenefitUpdateParams | null | undefined, options?: RequestOptions): APIPromise<UpdateCompanyBenefitResponse>;
+    /**
+     * List all company-wide deductions and contributions.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const companyBenefit of client.hris.benefits.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: BenefitListParams | null | undefined, options?: RequestOptions): PagePromise<CompanyBenefitsSinglePage, CompanyBenefit>;
+    /**
+     * Get deductions metadata
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {
+     *   // ...
+     * }
+     * ```
+     */
+    listSupportedBenefits(query?: BenefitListSupportedBenefitsParams | null | undefined, options?: RequestOptions): PagePromise<SupportedBenefitsSinglePage, SupportedBenefit>;
+}
+export type CompanyBenefitsSinglePage = SinglePage<CompanyBenefit>;
+export type SupportedBenefitsSinglePage = SinglePage<SupportedBenefit>;
+export type BenefitContribution = BenefitContribution.UnionMember0 | BenefitContribution.UnionMember1 | BenefitContribution.UnionMember2;
+export declare namespace BenefitContribution {
+    interface UnionMember0 {
+        /**
+         * Contribution amount in cents.
+         */
+        amount: number;
+        /**
+         * Fixed contribution type.
+         */
+        type: 'fixed';
+    }
+    interface UnionMember1 {
+        /**
+         * Contribution amount in basis points (1/100th of a percent).
+         */
+        amount: number;
+        /**
+         * Percentage contribution type.
+         */
+        type: 'percent';
+    }
+    interface UnionMember2 {
+        /**
+         * Array of tier objects defining employer match tiers based on employee
+         * contribution thresholds.
+         */
+        tiers: Array<UnionMember2.Tier>;
+        /**
+         * Tiered contribution type (only valid for company_contribution).
+         */
+        type: 'tiered';
+    }
+    namespace UnionMember2 {
+        interface Tier {
+            match: number;
+            threshold: number;
+        }
+    }
+}
+export interface BenefitFeaturesAndOperations {
+    supported_features?: SupportedBenefit;
+    supported_operations?: SupportPerBenefitType;
+}
+/**
+ * The frequency of the benefit deduction/contribution.
+ */
+export type BenefitFrequency = 'every_paycheck' | 'monthly' | 'one_time' | null;
+/**
+ * Type of benefit.
+ */
+export type BenefitType = '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira' | null;
+/**
+ * Each benefit type and their supported features. If the benefit type is not
+ * supported, the property will be null
+ */
+export interface BenefitsSupport {
+    commuter?: BenefitFeaturesAndOperations | null;
+    custom_post_tax?: BenefitFeaturesAndOperations | null;
+    custom_pre_tax?: BenefitFeaturesAndOperations | null;
+    fsa_dependent_care?: BenefitFeaturesAndOperations | null;
+    fsa_medical?: BenefitFeaturesAndOperations | null;
+    hsa_post?: BenefitFeaturesAndOperations | null;
+    hsa_pre?: BenefitFeaturesAndOperations | null;
+    s125_dental?: BenefitFeaturesAndOperations | null;
+    s125_medical?: BenefitFeaturesAndOperations | null;
+    s125_vision?: BenefitFeaturesAndOperations | null;
+    simple?: BenefitFeaturesAndOperations | null;
+    simple_ira?: BenefitFeaturesAndOperations | null;
+    [k: string]: BenefitFeaturesAndOperations | null | undefined;
+}
+export interface CompanyBenefit {
+    /**
+     * The id of the benefit.
+     */
+    benefit_id: string;
+    description: string | null;
+    /**
+     * The frequency of the benefit deduction/contribution.
+     */
+    frequency: BenefitFrequency | null;
+    /**
+     * Type of benefit.
+     */
+    type: BenefitType | null;
+    /**
+     * The company match for this benefit.
+     */
+    company_contribution?: CompanyBenefit.CompanyContribution | null;
+}
+export declare namespace CompanyBenefit {
+    /**
+     * The company match for this benefit.
+     */
+    interface CompanyContribution {
+        tiers: Array<CompanyContribution.Tier>;
+        type: 'match';
+    }
+    namespace CompanyContribution {
+        interface Tier {
+            match: number;
+            threshold: number;
+        }
+    }
+}
+export interface CreateCompanyBenefitsResponse {
+    /**
+     * The id of the benefit.
+     */
+    benefit_id: string;
+    job_id: string;
+}
+export interface SupportPerBenefitType {
+    company_benefits?: Shared.OperationSupportMatrix;
+    individual_benefits?: Shared.OperationSupportMatrix;
+}
+export interface SupportedBenefit {
+    /**
+     * Whether the provider supports an annual maximum for this benefit.
+     */
+    annual_maximum: boolean | null;
+    /**
+     * Supported contribution types. An empty array indicates contributions are not
+     * supported.
+     */
+    company_contribution: Array<'fixed' | 'percent' | 'tiered' | null> | null;
+    description: string | null;
+    /**
+     * Supported deduction types. An empty array indicates deductions are not
+     * supported.
+     */
+    employee_deduction: Array<'fixed' | 'percent' | null> | null;
+    /**
+     * The list of frequencies supported by the provider for this benefit
+     */
+    frequencies: Array<BenefitFrequency | null>;
+    /**
+     * Whether the provider supports catch up for this benefit. This field will only be
+     * true for retirement benefits.
+     */
+    catch_up?: boolean | null;
+    /**
+     * Whether the provider supports HSA contribution limits. Empty if this feature is
+     * not supported for the benefit. This array only has values for HSA benefits.
+     */
+    hsa_contribution_limit?: Array<'family' | 'individual' | null> | null;
+}
+export interface UpdateCompanyBenefitResponse {
+    /**
+     * The id of the benefit.
+     */
+    benefit_id: string;
+    job_id: string;
+}
+/**
+ * @deprecated use `BenefitContribution` instead
+ */
+export type BenfitContribution = BenefitContribution | null;
+export interface BenefitCreateParams {
+    /**
+     * Query param: The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+    /**
+     * Body param: The company match for this benefit.
+     */
+    company_contribution?: BenefitCreateParams.CompanyContribution | null;
+    /**
+     * Body param: Name of the benefit as it appears in the provider and pay
+     * statements. Recommend limiting this to <30 characters due to limitations in
+     * specific providers (e.g. Justworks).
+     */
+    description?: string;
+    /**
+     * Body param: The frequency of the benefit deduction/contribution.
+     */
+    frequency?: BenefitFrequency | null;
+    /**
+     * Body param: Type of benefit.
+     */
+    type?: BenefitType | null;
+}
+export declare namespace BenefitCreateParams {
+    /**
+     * The company match for this benefit.
+     */
+    interface CompanyContribution {
+        tiers: Array<CompanyContribution.Tier>;
+        type: 'match';
+    }
+    namespace CompanyContribution {
+        interface Tier {
+            match: number;
+            threshold: number;
+        }
+    }
+}
+export interface BenefitRetrieveParams {
+    /**
+     * The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+}
+export interface BenefitUpdateParams {
+    /**
+     * Query param: The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+    /**
+     * Body param: Updated name or description.
+     */
+    description?: string;
+}
+export interface BenefitListParams {
+    /**
+     * The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+}
+export interface BenefitListSupportedBenefitsParams {
+    /**
+     * The entity IDs to specify which entities' data to access.
+     */
+    entity_ids?: Array<string>;
+}
+export declare namespace Benefits {
+    export { type BenefitContribution as BenefitContribution, type BenefitFeaturesAndOperations as BenefitFeaturesAndOperations, type BenefitFrequency as BenefitFrequency, type BenefitType as BenefitType, type BenefitsSupport as BenefitsSupport, type CompanyBenefit as CompanyBenefit, type CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse, type SupportPerBenefitType as SupportPerBenefitType, type SupportedBenefit as SupportedBenefit, type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse, type BenfitContribution as BenfitContribution, type CompanyBenefitsSinglePage as CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage as SupportedBenefitsSinglePage, type BenefitCreateParams as BenefitCreateParams, type BenefitRetrieveParams as BenefitRetrieveParams, type BenefitUpdateParams as BenefitUpdateParams, type BenefitListParams as BenefitListParams, type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams, };
+    export { Individuals as Individuals, 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=benefits.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"benefits.d.mts","sourceRoot":"","sources":["../../../src/resources/hris/benefits/benefits.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,cAAc;OACnB,EACL,iCAAiC,EACjC,iBAAiB,EACjB,4BAA4B,EAC5B,0BAA0B,EAC1B,2BAA2B,EAC3B,6BAA6B,EAC7B,oCAAoC,EACpC,4BAA4B,EAC5B,WAAW,EACX,mCAAmC,EACpC;OACM,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,UAAU,EAAE;OAC3B,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF;;;;;;;;;OASG;IACH,MAAM,CACJ,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;IAK5C;;;;;;;;;OASG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;OAQG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAS3C;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,cAAc,CAAC;IAIzD;;;;;;;;;;OAUG;IACH,qBAAqB,CACnB,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2BAA2B,EAAE,gBAAgB,CAAC;CAM9D;AAED,MAAM,MAAM,yBAAyB,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;AAEnE,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEvE,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,YAAY,GAChC,mBAAmB,CAAC,YAAY,GAChC,mBAAmB,CAAC,YAAY,CAAC;AAErC,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,OAAO,CAAC;KACf;IAED,UAAiB,YAAY;QAC3B;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,SAAS,CAAC;KACjB;IAED,UAAiB,YAAY;QAC3B;;;WAGG;QACH,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEhC;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;KAChB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C,kBAAkB,CAAC,EAAE,gBAAgB,CAAC;IAEtC,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,KAAK,GACL,MAAM,GACN,WAAW,GACX,WAAW,GACX,MAAM,GACN,WAAW,GACX,UAAU,GACV,UAAU,GACV,iBAAiB,GACjB,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,UAAU,GACV,SAAS,GACT,aAAa,GACb,cAAc,GACd,aAAa,GACb,QAAQ,GACR,YAAY,GACZ,IAAI,CAAC;AAET;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE/C,eAAe,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEtD,cAAc,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAErD,kBAAkB,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEzD,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAElD,QAAQ,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE/C,OAAO,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE9C,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAElD,YAAY,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEnD,WAAW,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAElD,MAAM,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAE7C,UAAU,CAAC,EAAE,4BAA4B,GAAG,IAAI,CAAC;IAEjD,CAAC,CAAC,EAAE,MAAM,GAAG,4BAA4B,GAAG,IAAI,GAAG,SAAS,CAAC;CAC9D;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,oBAAoB,CAAC,EAAE,cAAc,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAClE;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,mBAAmB;QAClC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAEvC,IAAI,EAAE,OAAO,CAAC;KACf;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;IAEjD,mBAAmB,CAAC,EAAE,MAAM,CAAC,sBAAsB,CAAC;CACrD;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,OAAO,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,oBAAoB,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE1E,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,kBAAkB,EAAE,KAAK,CAAC,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAC;IAE5C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACvE;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG,IAAI,CAAC;AAE5D,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,mBAAmB,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAEtE;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,mBAAmB;QAClC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAEvC,IAAI,EAAE,OAAO,CAAC;KACf;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,IAAI;YACnB,KAAK,EAAE,MAAM,CAAC;YAEd,SAAS,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,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,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,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"}