@tryfinch/finch-api 6.30.0 → 7.0.0

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

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import { isRequestOptions } from "../../../core.js";
-import * as Core from "../../../core.js";
-import * as BenefitsAPI from "./benefits.js";
-import { SinglePage } from "../../../pagination.js";
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { PagePromise, SinglePage } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 export class Individuals extends APIResource {
   /**
@@ -18,28 +18,20 @@ export class Individuals extends APIResource {
    * const enrolledIndividualBenefitResponse =
    *   await client.hris.benefits.individuals.enrollMany(
    *     'benefit_id',
-   *     [{}],
    *   );
    * ```
    */
   enrollMany(
-    benefitId: string,
-    body?: IndividualEnrollManyParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EnrolledIndividualBenefitResponse>;
-  enrollMany(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EnrolledIndividualBenefitResponse>;
-  enrollMany(
-    benefitId: string,
-    body?: IndividualEnrollManyParams | Core.RequestOptions,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EnrolledIndividualBenefitResponse> {
-    if (isRequestOptions(body)) {
-      return this.enrollMany(benefitId, undefined, body);
-    }
-    return this._client.post(`/employer/benefits/${benefitId}/individuals`, { body, ...options });
+    benefitID: string,
+    params: IndividualEnrollManyParams | null | undefined = undefined,
+    options?: RequestOptions,
+  ): APIPromise<EnrolledIndividualBenefitResponse> {
+    const { entity_ids, individuals } = params ?? {};
+    return this._client.post(path`/employer/benefits/${benefitID}/individuals`, {
+      query: { entity_ids },
+      body: individuals,
+      ...options,
+    });
   }
 
   /**
@@ -48,16 +40,17 @@ export class Individuals extends APIResource {
    * @example
    * ```ts
    * const response =
-   *   await client.hris.benefits.individuals.enrolledIds(
+   *   await client.hris.benefits.individuals.enrolledIDs(
    *     'benefit_id',
    *   );
    * ```
    */
-  enrolledIds(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<IndividualEnrolledIDsResponse> {
-    return this._client.get(`/employer/benefits/${benefitId}/enrolled`, options);
+  enrolledIDs(
+    benefitID: string,
+    query: IndividualEnrolledIDsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<IndividualEnrolledIDsResponse> {
+    return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, { query, ...options });
   }
 
   /**
@@ -74,25 +67,13 @@ export class Individuals extends APIResource {
    * ```
    */
   retrieveManyBenefits(
-    benefitId: string,
-    query?: IndividualRetrieveManyBenefitsParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
-  retrieveManyBenefits(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
-  retrieveManyBenefits(
-    benefitId: string,
-    query: IndividualRetrieveManyBenefitsParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit> {
-    if (isRequestOptions(query)) {
-      return this.retrieveManyBenefits(benefitId, {}, query);
-    }
+    benefitID: string,
+    query: IndividualRetrieveManyBenefitsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<IndividualBenefitsSinglePage, IndividualBenefit> {
     return this._client.getAPIList(
-      `/employer/benefits/${benefitId}/individuals`,
-      IndividualBenefitsSinglePage,
+      path`/employer/benefits/${benefitID}/individuals`,
+      SinglePage<IndividualBenefit>,
       { query, ...options },
     );
   }
@@ -109,62 +90,158 @@ export class Individuals extends APIResource {
    * ```
    */
   unenrollMany(
-    benefitId: string,
-    body?: IndividualUnenrollManyParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<UnenrolledIndividualBenefitResponse>;
-  unenrollMany(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<UnenrolledIndividualBenefitResponse>;
-  unenrollMany(
-    benefitId: string,
-    body: IndividualUnenrollManyParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<UnenrolledIndividualBenefitResponse> {
-    if (isRequestOptions(body)) {
-      return this.unenrollMany(benefitId, {}, body);
-    }
-    return this._client.delete(`/employer/benefits/${benefitId}/individuals`, { body, ...options });
+    benefitID: string,
+    params: IndividualUnenrollManyParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<UnenrolledIndividualBenefitResponse> {
+    const { entity_ids, ...body } = params ?? {};
+    return this._client.delete(path`/employer/benefits/${benefitID}/individuals`, {
+      query: { entity_ids },
+      body,
+      ...options,
+    });
   }
 }
 
-export class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
+export type IndividualBenefitsSinglePage = SinglePage<IndividualBenefit>;
 
 export interface EnrolledIndividualBenefitResponse {
   job_id: string;
 }
 
 export interface IndividualBenefit {
-  body?: IndividualBenefit.Body;
+  body: IndividualBenefit.UnionMember0 | IndividualBenefit.BatchError;
 
-  code?: number;
+  code: number;
 
-  individual_id?: string;
+  individual_id: string;
 }
 
 export namespace IndividualBenefit {
-  export interface Body {
+  export interface UnionMember0 {
     /**
      * If the benefit supports annual maximum, the amount in cents for this individual.
      */
-    annual_maximum?: number | null;
+    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;
+    catch_up: boolean | null;
 
-    company_contribution?: BenefitsAPI.BenefitContribution | 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?: BenefitsAPI.BenefitContribution | 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;
   }
+
+  export namespace UnionMember0 {
+    export 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';
+    }
+
+    export 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';
+    }
+
+    export 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';
+    }
+
+    export namespace UnionMember2 {
+      export interface Tier {
+        match: number;
+
+        threshold: number;
+      }
+    }
+
+    export 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';
+    }
+
+    export 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';
+    }
+  }
+
+  export interface BatchError {
+    code: number;
+
+    message: string;
+
+    name: string;
+
+    finch_code?: string;
+  }
 }
 
 export interface UnenrolledIndividualBenefitResponse {
@@ -180,7 +257,17 @@ export interface IndividualEnrolledIDsResponse {
   individual_ids: Array<string>;
 }
 
-export type IndividualEnrollManyParams = Array<IndividualEnrollManyParams.Individual>;
+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 namespace IndividualEnrollManyParams {
   export interface Individual {
@@ -228,7 +315,27 @@ export namespace IndividualEnrollManyParams {
          */
         amount?: number;
 
-        type?: 'fixed' | 'percent';
+        /**
+         * Array of tier objects for tiered contribution matching (required when type is
+         * tiered)
+         */
+        tiers?: Array<CompanyContribution.Tier>;
+
+        type?: 'fixed' | 'percent' | 'tiered';
+      }
+
+      export namespace CompanyContribution {
+        export 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;
+        }
       }
 
       export interface EmployeeDeduction {
@@ -244,7 +351,19 @@ export namespace IndividualEnrollManyParams {
   }
 }
 
+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
@@ -254,21 +373,25 @@ export interface IndividualRetrieveManyBenefitsParams {
 
 export interface IndividualUnenrollManyParams {
   /**
-   * Array of individual_ids to unenroll.
+   * 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>;
 }
 
-Individuals.IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
-
 export declare namespace Individuals {
   export {
     type EnrolledIndividualBenefitResponse as EnrolledIndividualBenefitResponse,
     type IndividualBenefit as IndividualBenefit,
     type UnenrolledIndividualBenefitResponse as UnenrolledIndividualBenefitResponse,
     type IndividualEnrolledIDsResponse as IndividualEnrolledIDsResponse,
-    IndividualBenefitsSinglePage as IndividualBenefitsSinglePage,
+    type IndividualBenefitsSinglePage as IndividualBenefitsSinglePage,
     type IndividualEnrollManyParams as IndividualEnrollManyParams,
+    type IndividualEnrolledIDsParams as IndividualEnrolledIDsParams,
     type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams,
     type IndividualUnenrollManyParams as IndividualUnenrollManyParams,
   };

package/src/resources/hris/benefits.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./benefits/index.js";
+export * from './benefits/index';

package/src/resources/hris/company/company.ts

@@ -1,15 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../resource.js";
-import * as Core from "../../../core.js";
-import * as HRISAPI from "../hris.js";
-import * as PayStatementItemAPI from "./pay-statement-item/pay-statement-item.js";
+import { APIResource } from '../../../core/resource';
+import * as HRISAPI from '../hris';
+import * as PayStatementItemAPI from './pay-statement-item/pay-statement-item';
 import {
   PayStatementItem,
   PayStatementItemListParams,
   PayStatementItemListResponse,
   PayStatementItemListResponsesPage,
-} from "./pay-statement-item/pay-statement-item.js";
+} from './pay-statement-item/pay-statement-item';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
 
 export class CompanyResource extends APIResource {
   payStatementItem: PayStatementItemAPI.PayStatementItem = new PayStatementItemAPI.PayStatementItem(
@@ -24,8 +25,11 @@ export class CompanyResource extends APIResource {
    * const company = await client.hris.company.retrieve();
    * ```
    */
-  retrieve(options?: Core.RequestOptions): Core.APIPromise<Company> {
-    return this._client.get('/employer/company', options);
+  retrieve(
+    query: CompanyRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Company> {
+    return this._client.get('/employer/company', { query, ...options });
   }
 }
 
@@ -151,16 +155,22 @@ export namespace Company {
   }
 }
 
+export interface CompanyRetrieveParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+}
+
 CompanyResource.PayStatementItem = PayStatementItem;
-CompanyResource.PayStatementItemListResponsesPage = PayStatementItemListResponsesPage;
 
 export declare namespace CompanyResource {
-  export { type Company as Company };
+  export { type Company as Company, type CompanyRetrieveParams as CompanyRetrieveParams };
 
   export {
     PayStatementItem as PayStatementItem,
     type PayStatementItemListResponse as PayStatementItemListResponse,
-    PayStatementItemListResponsesPage as PayStatementItemListResponsesPage,
+    type PayStatementItemListResponsesPage as PayStatementItemListResponsesPage,
     type PayStatementItemListParams as PayStatementItemListParams,
   };
 }

package/src/resources/hris/company/index.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { CompanyResource, type Company } from "./company.js";
+export { CompanyResource, type Company, type CompanyRetrieveParams } from './company';
 export {
-  PayStatementItemListResponsesPage,
   PayStatementItem,
   type PayStatementItemListResponse,
   type PayStatementItemListParams,
-} from "./pay-statement-item/index.js";
+  type PayStatementItemListResponsesPage,
+} from './pay-statement-item/index';

package/src/resources/hris/company/pay-statement-item/index.ts

@@ -1,13 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  PayStatementItemListResponsesPage,
   PayStatementItem,
   type PayStatementItemListResponse,
   type PayStatementItemListParams,
-} from "./pay-statement-item.js";
+  type PayStatementItemListResponsesPage,
+} from './pay-statement-item';
 export {
-  RuleListResponsesPage,
   Rules,
   type RuleCreateResponse,
   type RuleUpdateResponse,
@@ -15,4 +14,7 @@ export {
   type RuleDeleteResponse,
   type RuleCreateParams,
   type RuleUpdateParams,
-} from "./rules.js";
+  type RuleListParams,
+  type RuleDeleteParams,
+  type RuleListResponsesPage,
+} from './rules';

package/src/resources/hris/company/pay-statement-item/pay-statement-item.ts

@@ -1,20 +1,21 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../../../resource.js";
-import { isRequestOptions } from "../../../../core.js";
-import * as Core from "../../../../core.js";
-import * as RulesAPI from "./rules.js";
+import { APIResource } from '../../../../core/resource';
+import * as RulesAPI from './rules';
 import {
   RuleCreateParams,
   RuleCreateResponse,
+  RuleDeleteParams,
   RuleDeleteResponse,
+  RuleListParams,
   RuleListResponse,
   RuleListResponsesPage,
   RuleUpdateParams,
   RuleUpdateResponse,
   Rules,
-} from "./rules.js";
-import { ResponsesPage } from "../../../../pagination.js";
+} from './rules';
+import { PagePromise, ResponsesPage } from '../../../../core/pagination';
+import { RequestOptions } from '../../../../internal/request-options';
 
 export class PayStatementItem extends APIResource {
   rules: RulesAPI.Rules = new RulesAPI.Rules(this._client);
@@ -33,43 +34,34 @@ export class PayStatementItem extends APIResource {
    * ```
    */
   list(
-    query?: PayStatementItemListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse>;
-  list(
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse>;
-  list(
-    query: PayStatementItemListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/employer/pay-statement-item', PayStatementItemListResponsesPage, {
-      query,
-      ...options,
-    });
+    query: PayStatementItemListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PayStatementItemListResponsesPage, PayStatementItemListResponse> {
+    return this._client.getAPIList(
+      '/employer/pay-statement-item',
+      ResponsesPage<PayStatementItemListResponse>,
+      { query, ...options },
+    );
   }
 }
 
-export class PayStatementItemListResponsesPage extends ResponsesPage<PayStatementItemListResponse> {}
+export type PayStatementItemListResponsesPage = ResponsesPage<PayStatementItemListResponse>;
 
 export interface PayStatementItemListResponse {
   /**
    * The attributes of the pay statement item.
    */
-  attributes?: PayStatementItemListResponse.Attributes;
+  attributes: PayStatementItemListResponse.Attributes;
 
   /**
    * The category of the pay statement item.
    */
-  category?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions';
+  category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions';
 
   /**
    * The name of the pay statement item.
    */
-  name?: string;
+  name: string;
 }
 
 export namespace PayStatementItemListResponse {
@@ -78,16 +70,16 @@ export namespace PayStatementItemListResponse {
    */
   export interface Attributes {
     /**
-     * `true` if the amount is paid by the employers. This field is only available for
-     * taxes.
+     * The metadata of the pay statement item derived by the rules engine if available.
+     * Each attribute will be a key-value pair defined by a rule.
      */
-    employer?: boolean | null;
+    metadata: { [key: string]: unknown } | null;
 
     /**
-     * The metadata of the pay statement item derived by the rules engine if available.
-     * Each attribute will be a key-value pair defined by a rule.
+     * `true` if the amount is paid by the employers. This field is only available for
+     * taxes.
      */
-    metadata?: Record<string, unknown> | null;
+    employer?: boolean | null;
 
     /**
      * `true` if the pay statement item is pre-tax. This field is only available for
@@ -115,6 +107,11 @@ export interface PayStatementItemListParams {
    */
   end_date?: string;
 
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+
   /**
    * Case-insensitive partial match search by pay statement item name.
    */
@@ -132,14 +129,12 @@ export interface PayStatementItemListParams {
   type?: string;
 }
 
-PayStatementItem.PayStatementItemListResponsesPage = PayStatementItemListResponsesPage;
 PayStatementItem.Rules = Rules;
-PayStatementItem.RuleListResponsesPage = RuleListResponsesPage;
 
 export declare namespace PayStatementItem {
   export {
     type PayStatementItemListResponse as PayStatementItemListResponse,
-    PayStatementItemListResponsesPage as PayStatementItemListResponsesPage,
+    type PayStatementItemListResponsesPage as PayStatementItemListResponsesPage,
     type PayStatementItemListParams as PayStatementItemListParams,
   };
 
@@ -149,8 +144,10 @@ export declare namespace PayStatementItem {
     type RuleUpdateResponse as RuleUpdateResponse,
     type RuleListResponse as RuleListResponse,
     type RuleDeleteResponse as RuleDeleteResponse,
-    RuleListResponsesPage as RuleListResponsesPage,
+    type RuleListResponsesPage as RuleListResponsesPage,
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,
+    type RuleListParams as RuleListParams,
+    type RuleDeleteParams as RuleDeleteParams,
   };
 }