@tryfinch/finch-api 6.22.3 → 6.24.0

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

@@ -7,8 +7,7 @@ import * as BenefitsAPI from './benefits';
 import * as Shared from '../../shared';
 import * as IndividualsAPI from './individuals';
 import {
-  EnrolledIndividual,
-  EnrolledIndividualsSinglePage,
+  EnrolledIndividualBenefitResponse,
   IndividualBenefit,
   IndividualBenefitsSinglePage,
   IndividualEnrollManyParams,
@@ -16,8 +15,7 @@ import {
   IndividualRetrieveManyBenefitsParams,
   IndividualUnenrollManyParams,
   Individuals,
-  UnenrolledIndividual,
-  UnenrolledIndividualsSinglePage,
+  UnenrolledIndividualBenefitResponse,
 } from './individuals';
 import { SinglePage } from '../../../pagination';
 
@@ -82,14 +80,18 @@ export class Benefits extends APIResource {
    */
   listSupportedBenefits(
     options?: Core.RequestOptions,
-  ): Core.PagePromise<SupportedBenefitsSinglePage, SupportedBenefit> {
-    return this._client.getAPIList('/employer/benefits/meta', SupportedBenefitsSinglePage, options);
+  ): Core.PagePromise<BenefitListSupportedBenefitsResponsesSinglePage, BenefitListSupportedBenefitsResponse> {
+    return this._client.getAPIList(
+      '/employer/benefits/meta',
+      BenefitListSupportedBenefitsResponsesSinglePage,
+      options,
+    );
   }
 }
 
 export class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {}
 
-export class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {}
+export class BenefitListSupportedBenefitsResponsesSinglePage extends SinglePage<BenefitListSupportedBenefitsResponse> {}
 
 export interface BenefitContribution {
   /**
@@ -235,6 +237,8 @@ export interface CreateCompanyBenefitsResponse {
    * The id of the benefit.
    */
   benefit_id: string;
+
+  job_id: string;
 }
 
 export interface SupportPerBenefitType {
@@ -279,11 +283,6 @@ export interface SupportedBenefit {
    * not supported for the benefit. This array only has values for HSA benefits.
    */
   hsa_contribution_limit?: Array<'individual' | 'family' | null> | null;
-
-  /**
-   * Type of benefit.
-   */
-  type?: BenefitType | null;
 }
 
 export interface UpdateCompanyBenefitResponse {
@@ -291,6 +290,46 @@ export interface UpdateCompanyBenefitResponse {
    * The id of the benefit.
    */
   benefit_id: string;
+
+  job_id: string;
+}
+
+export interface BenefitListSupportedBenefitsResponse {
+  /**
+   * Whether the provider supports an annual maximum for this benefit.
+   */
+  annual_maximum?: boolean | null;
+
+  /**
+   * Whether the provider supports catch up for this benefit. This field will only be
+   * true for retirement benefits.
+   */
+  catch_up?: boolean | null;
+
+  /**
+   * Supported contribution types. An empty array indicates contributions are not
+   * supported.
+   */
+  company_contribution?: Array<'fixed' | 'percent' | 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 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<'individual' | 'family' | null> | null;
 }
 
 /**
@@ -325,11 +364,9 @@ export interface BenefitUpdateParams {
 }
 
 Benefits.CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
-Benefits.SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
+Benefits.BenefitListSupportedBenefitsResponsesSinglePage = BenefitListSupportedBenefitsResponsesSinglePage;
 Benefits.Individuals = Individuals;
-Benefits.EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
 Benefits.IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
-Benefits.UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
 
 export declare namespace Benefits {
   export {
@@ -343,22 +380,21 @@ export declare namespace Benefits {
     type SupportPerBenefitType as SupportPerBenefitType,
     type SupportedBenefit as SupportedBenefit,
     type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
+    type BenefitListSupportedBenefitsResponse as BenefitListSupportedBenefitsResponse,
     type BenfitContribution as BenfitContribution,
     CompanyBenefitsSinglePage as CompanyBenefitsSinglePage,
-    SupportedBenefitsSinglePage as SupportedBenefitsSinglePage,
+    BenefitListSupportedBenefitsResponsesSinglePage as BenefitListSupportedBenefitsResponsesSinglePage,
     type BenefitCreateParams as BenefitCreateParams,
     type BenefitUpdateParams as BenefitUpdateParams,
   };
 
   export {
     Individuals as Individuals,
-    type EnrolledIndividual as EnrolledIndividual,
+    type EnrolledIndividualBenefitResponse as EnrolledIndividualBenefitResponse,
     type IndividualBenefit as IndividualBenefit,
-    type UnenrolledIndividual as UnenrolledIndividual,
+    type UnenrolledIndividualBenefitResponse as UnenrolledIndividualBenefitResponse,
     type IndividualEnrolledIDsResponse as IndividualEnrolledIDsResponse,
-    EnrolledIndividualsSinglePage as EnrolledIndividualsSinglePage,
     IndividualBenefitsSinglePage as IndividualBenefitsSinglePage,
-    UnenrolledIndividualsSinglePage as UnenrolledIndividualsSinglePage,
     type IndividualEnrollManyParams as IndividualEnrollManyParams,
     type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams,
     type IndividualUnenrollManyParams as IndividualUnenrollManyParams,

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

@@ -2,7 +2,7 @@
 
 export {
   CompanyBenefitsSinglePage,
-  SupportedBenefitsSinglePage,
+  BenefitListSupportedBenefitsResponsesSinglePage,
   Benefits,
   type BenefitContribution,
   type BenefitFeaturesAndOperations,
@@ -14,18 +14,17 @@ export {
   type SupportPerBenefitType,
   type SupportedBenefit,
   type UpdateCompanyBenefitResponse,
+  type BenefitListSupportedBenefitsResponse,
   type BenfitContribution,
   type BenefitCreateParams,
   type BenefitUpdateParams,
 } from './benefits';
 export {
-  EnrolledIndividualsSinglePage,
   IndividualBenefitsSinglePage,
-  UnenrolledIndividualsSinglePage,
   Individuals,
-  type EnrolledIndividual,
+  type EnrolledIndividualBenefitResponse,
   type IndividualBenefit,
-  type UnenrolledIndividual,
+  type UnenrolledIndividualBenefitResponse,
   type IndividualEnrolledIDsResponse,
   type IndividualEnrollManyParams,
   type IndividualRetrieveManyBenefitsParams,

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

@@ -17,24 +17,20 @@ export class Individuals extends APIResource {
     benefitId: string,
     body?: IndividualEnrollManyParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EnrolledIndividualsSinglePage, EnrolledIndividual>;
+  ): Core.APIPromise<EnrolledIndividualBenefitResponse>;
   enrollMany(
     benefitId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EnrolledIndividualsSinglePage, EnrolledIndividual>;
+  ): Core.APIPromise<EnrolledIndividualBenefitResponse>;
   enrollMany(
     benefitId: string,
     body?: IndividualEnrollManyParams | Core.RequestOptions,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EnrolledIndividualsSinglePage, EnrolledIndividual> {
+  ): Core.APIPromise<EnrolledIndividualBenefitResponse> {
     if (isRequestOptions(body)) {
       return this.enrollMany(benefitId, undefined, body);
     }
-    return this._client.getAPIList(
-      `/employer/benefits/${benefitId}/individuals`,
-      EnrolledIndividualsSinglePage,
-      { body, method: 'post', ...options },
-    );
+    return this._client.post(`/employer/benefits/${benefitId}/individuals`, { body, ...options });
   }
 
   /**
@@ -81,61 +77,27 @@ export class Individuals extends APIResource {
     benefitId: string,
     body?: IndividualUnenrollManyParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
+  ): Core.APIPromise<UnenrolledIndividualBenefitResponse>;
   unenrollMany(
     benefitId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
+  ): Core.APIPromise<UnenrolledIndividualBenefitResponse>;
   unenrollMany(
     benefitId: string,
     body: IndividualUnenrollManyParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual> {
+  ): Core.APIPromise<UnenrolledIndividualBenefitResponse> {
     if (isRequestOptions(body)) {
       return this.unenrollMany(benefitId, {}, body);
     }
-    return this._client.getAPIList(
-      `/employer/benefits/${benefitId}/individuals`,
-      UnenrolledIndividualsSinglePage,
-      { body, method: 'delete', ...options },
-    );
+    return this._client.delete(`/employer/benefits/${benefitId}/individuals`, { body, ...options });
   }
 }
 
-export class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {}
-
 export class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
 
-export class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {}
-
-export interface EnrolledIndividual {
-  body?: EnrolledIndividual.Body;
-
-  /**
-   * HTTP status code. Either 201 or 200
-   */
-  code?: 200 | 201 | 404 | 403;
-
-  individual_id?: string;
-}
-
-export namespace EnrolledIndividual {
-  export 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 EnrolledIndividualBenefitResponse {
+  job_id: string;
 }
 
 export interface IndividualBenefit {
@@ -170,34 +132,8 @@ export namespace IndividualBenefit {
   }
 }
 
-export interface UnenrolledIndividual {
-  body?: UnenrolledIndividual.Body;
-
-  /**
-   * HTTP status code
-   */
-  code?: number;
-
-  individual_id?: string;
-}
-
-export namespace UnenrolledIndividual {
-  export 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 UnenrolledIndividualBenefitResponse {
+  job_id: string;
 }
 
 export interface IndividualEnrolledIDsResponse {
@@ -288,19 +224,15 @@ export interface IndividualUnenrollManyParams {
   individual_ids?: Array<string>;
 }
 
-Individuals.EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
 Individuals.IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
-Individuals.UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
 
 export declare namespace Individuals {
   export {
-    type EnrolledIndividual as EnrolledIndividual,
+    type EnrolledIndividualBenefitResponse as EnrolledIndividualBenefitResponse,
     type IndividualBenefit as IndividualBenefit,
-    type UnenrolledIndividual as UnenrolledIndividual,
+    type UnenrolledIndividualBenefitResponse as UnenrolledIndividualBenefitResponse,
     type IndividualEnrolledIDsResponse as IndividualEnrolledIDsResponse,
-    EnrolledIndividualsSinglePage as EnrolledIndividualsSinglePage,
     IndividualBenefitsSinglePage as IndividualBenefitsSinglePage,
-    UnenrolledIndividualsSinglePage as UnenrolledIndividualsSinglePage,
     type IndividualEnrollManyParams as IndividualEnrollManyParams,
     type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams,
     type IndividualUnenrollManyParams as IndividualUnenrollManyParams,

package/src/resources/hris/hris.ts

@@ -51,6 +51,8 @@ import {
   BenefitCreateParams,
   BenefitFeaturesAndOperations,
   BenefitFrequency,
+  BenefitListSupportedBenefitsResponse,
+  BenefitListSupportedBenefitsResponsesSinglePage,
   BenefitType,
   BenefitUpdateParams,
   Benefits,
@@ -61,7 +63,6 @@ import {
   CreateCompanyBenefitsResponse,
   SupportPerBenefitType,
   SupportedBenefit,
-  SupportedBenefitsSinglePage,
   UpdateCompanyBenefitResponse,
 } from './benefits/benefits';
 import * as CompanyAPI from './company/company';
@@ -174,7 +175,7 @@ HRIS.PayStatementResponsesPage = PayStatementResponsesPage;
 HRIS.Documents = Documents;
 HRIS.Benefits = Benefits;
 HRIS.CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
-HRIS.SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
+HRIS.BenefitListSupportedBenefitsResponsesSinglePage = BenefitListSupportedBenefitsResponsesSinglePage;
 
 export declare namespace HRIS {
   export { type Income as Income, type Location as Location, type Money as Money };
@@ -242,9 +243,10 @@ export declare namespace HRIS {
     type SupportPerBenefitType as SupportPerBenefitType,
     type SupportedBenefit as SupportedBenefit,
     type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
+    type BenefitListSupportedBenefitsResponse as BenefitListSupportedBenefitsResponse,
     type BenfitContribution as BenfitContribution,
     CompanyBenefitsSinglePage as CompanyBenefitsSinglePage,
-    SupportedBenefitsSinglePage as SupportedBenefitsSinglePage,
+    BenefitListSupportedBenefitsResponsesSinglePage as BenefitListSupportedBenefitsResponsesSinglePage,
     type BenefitCreateParams as BenefitCreateParams,
     type BenefitUpdateParams as BenefitUpdateParams,
   };

package/src/resources/hris/index.ts

@@ -2,7 +2,7 @@
 
 export {
   CompanyBenefitsSinglePage,
-  SupportedBenefitsSinglePage,
+  BenefitListSupportedBenefitsResponsesSinglePage,
   Benefits,
   type BenefitContribution,
   type BenefitFeaturesAndOperations,
@@ -14,6 +14,7 @@ export {
   type SupportPerBenefitType,
   type SupportedBenefit,
   type UpdateCompanyBenefitResponse,
+  type BenefitListSupportedBenefitsResponse,
   type BenfitContribution,
   type BenefitCreateParams,
   type BenefitUpdateParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.22.3'; // x-release-please-version
+export const VERSION = '6.24.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.22.3";
+export declare const VERSION = "6.24.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.22.3'; // x-release-please-version
+exports.VERSION = '6.24.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.22.3'; // x-release-please-version
+export const VERSION = '6.24.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map