@tryfinch/finch-api 9.9.0 → 9.10.0

package/src/resources/account.ts

@@ -8,19 +8,59 @@ import { RequestOptions } from '../internal/request-options';
 export class Account extends APIResource {
   /**
    * Disconnect one or more `access_token`s from your application.
+   *
+   * @example
+   * ```ts
+   * const disconnectResponse =
+   *   await client.account.disconnect();
+   * ```
    */
   disconnect(options?: RequestOptions): APIPromise<DisconnectResponse> {
     return this._client.post('/disconnect', { ...options, __security: { bearerAuth: true } });
   }
 
+  /**
+   * Disconnect entity(s) from a connection without affecting other entities
+   * associated with the same connection.
+   *
+   * @example
+   * ```ts
+   * const disconnectEntityResponse =
+   *   await client.account.disconnectEntity({
+   *     entity_ids: [
+   *       '3c90c3cc-0d44-4b50-8888-8dd25736052a',
+   *       '5e6f7a8b-9c10-4d11-a12b-c13d14e15f16',
+   *     ],
+   *   });
+   * ```
+   */
+  disconnectEntity(
+    body: AccountDisconnectEntityParams,
+    options?: RequestOptions,
+  ): APIPromise<DisconnectEntityResponse> {
+    return this._client.post('/disconnect-entity', { body, ...options, __security: { bearerAuth: true } });
+  }
+
   /**
    * Read account information associated with an `access_token`
+   *
+   * @example
+   * ```ts
+   * const introspection = await client.account.introspect();
+   * ```
    */
   introspect(options?: RequestOptions): APIPromise<Introspection> {
     return this._client.get('/introspect', { ...options, __security: { bearerAuth: true } });
   }
 }
 
+export interface DisconnectEntityResponse {
+  /**
+   * If the request is successful, Finch will return "success" (HTTP 200 status).
+   */
+  status: string;
+}
+
 export interface DisconnectResponse {
   /**
    * If the request is successful, Finch will return "success" (HTTP 200 status).
@@ -195,6 +235,18 @@ export namespace Introspection {
   }
 }
 
+export interface AccountDisconnectEntityParams {
+  /**
+   * Array of entity UUIDs to disconnect. At least one entity ID must be provided.
+   */
+  entity_ids: Array<string>;
+}
+
 export declare namespace Account {
-  export { type DisconnectResponse as DisconnectResponse, type Introspection as Introspection };
+  export {
+    type DisconnectEntityResponse as DisconnectEntityResponse,
+    type DisconnectResponse as DisconnectResponse,
+    type Introspection as Introspection,
+    type AccountDisconnectEntityParams as AccountDisconnectEntityParams,
+  };
 }

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

@@ -134,6 +134,29 @@ export class Benefits extends APIResource {
       __security: { bearerAuth: true },
     });
   }
+
+  /**
+   * Register existing benefits from the customer on the provider, on Finch's end.
+   * Please use the `/provider` endpoint to view available types for each provider.
+   *
+   * @example
+   * ```ts
+   * const registerCompanyBenefitResponse =
+   *   await client.hris.benefits.register();
+   * ```
+   */
+  register(
+    params: BenefitRegisterParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RegisterCompanyBenefitResponse> {
+    const { entity_ids, ...body } = params ?? {};
+    return this._client.post('/employer/benefits/register', {
+      query: { entity_ids },
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
+  }
 }
 
 export type CompanyBenefitsSinglePage = SinglePage<CompanyBenefit>;
@@ -312,6 +335,15 @@ export interface CreateCompanyBenefitsResponse {
   job_id: string;
 }
 
+export interface RegisterCompanyBenefitResponse {
+  /**
+   * The id of the benefit.
+   */
+  benefit_id: string;
+
+  job_id: string;
+}
+
 export interface SupportPerBenefitType {
   company_benefits?: Shared.OperationSupportMatrix;
 
@@ -451,6 +483,28 @@ export interface BenefitListSupportedBenefitsParams {
   entity_ids?: Array<string>;
 }
 
+export interface BenefitRegisterParams {
+  /**
+   * Query param: The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+
+  /**
+   * Body param
+   */
+  description?: string;
+
+  /**
+   * Body param: The frequency of the benefit deduction/contribution.
+   */
+  frequency?: BenefitFrequency | null;
+
+  /**
+   * Body param: Type of benefit.
+   */
+  type?: BenefitType | null;
+}
+
 Benefits.Individuals = Individuals;
 
 export declare namespace Benefits {
@@ -462,6 +516,7 @@ export declare namespace Benefits {
     type BenefitsSupport as BenefitsSupport,
     type CompanyBenefit as CompanyBenefit,
     type CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse,
+    type RegisterCompanyBenefitResponse as RegisterCompanyBenefitResponse,
     type SupportPerBenefitType as SupportPerBenefitType,
     type SupportedBenefit as SupportedBenefit,
     type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
@@ -473,6 +528,7 @@ export declare namespace Benefits {
     type BenefitUpdateParams as BenefitUpdateParams,
     type BenefitListParams as BenefitListParams,
     type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams,
+    type BenefitRegisterParams as BenefitRegisterParams,
   };
 
   export {

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

@@ -9,6 +9,7 @@ export {
   type BenefitsSupport,
   type CompanyBenefit,
   type CreateCompanyBenefitsResponse,
+  type RegisterCompanyBenefitResponse,
   type SupportPerBenefitType,
   type SupportedBenefit,
   type UpdateCompanyBenefitResponse,
@@ -18,6 +19,7 @@ export {
   type BenefitUpdateParams,
   type BenefitListParams,
   type BenefitListSupportedBenefitsParams,
+  type BenefitRegisterParams,
   type CompanyBenefitsSinglePage,
   type SupportedBenefitsSinglePage,
 } from './benefits';

package/src/resources/hris/hris.ts

@@ -55,6 +55,7 @@ import {
   BenefitFrequency,
   BenefitListParams,
   BenefitListSupportedBenefitsParams,
+  BenefitRegisterParams,
   BenefitRetrieveParams,
   BenefitType,
   BenefitUpdateParams,
@@ -64,6 +65,7 @@ import {
   CompanyBenefit,
   CompanyBenefitsSinglePage,
   CreateCompanyBenefitsResponse,
+  RegisterCompanyBenefitResponse,
   SupportPerBenefitType,
   SupportedBenefit,
   SupportedBenefitsSinglePage,
@@ -244,6 +246,7 @@ export declare namespace HRIS {
     type BenefitsSupport as BenefitsSupport,
     type CompanyBenefit as CompanyBenefit,
     type CreateCompanyBenefitsResponse as CreateCompanyBenefitsResponse,
+    type RegisterCompanyBenefitResponse as RegisterCompanyBenefitResponse,
     type SupportPerBenefitType as SupportPerBenefitType,
     type SupportedBenefit as SupportedBenefit,
     type UpdateCompanyBenefitResponse as UpdateCompanyBenefitResponse,
@@ -255,5 +258,6 @@ export declare namespace HRIS {
     type BenefitUpdateParams as BenefitUpdateParams,
     type BenefitListParams as BenefitListParams,
     type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams,
+    type BenefitRegisterParams as BenefitRegisterParams,
   };
 }

package/src/resources/hris/index.ts

@@ -9,6 +9,7 @@ export {
   type BenefitsSupport,
   type CompanyBenefit,
   type CreateCompanyBenefitsResponse,
+  type RegisterCompanyBenefitResponse,
   type SupportPerBenefitType,
   type SupportedBenefit,
   type UpdateCompanyBenefitResponse,
@@ -18,6 +19,7 @@ export {
   type BenefitUpdateParams,
   type BenefitListParams,
   type BenefitListSupportedBenefitsParams,
+  type BenefitRegisterParams,
   type CompanyBenefitsSinglePage,
   type SupportedBenefitsSinglePage,
 } from './benefits/index';

package/src/resources/index.ts

@@ -2,7 +2,13 @@
 
 export * from './shared';
 export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens';
-export { Account, type DisconnectResponse, type Introspection } from './account';
+export {
+  Account,
+  type DisconnectEntityResponse,
+  type DisconnectResponse,
+  type Introspection,
+  type AccountDisconnectEntityParams,
+} from './account';
 export { Connect } from './connect/connect';
 export { HRIS, type Income, type Location, type Money } from './hris/hris';
 export { Jobs } from './jobs/jobs';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '9.9.0'; // x-release-please-version
+export const VERSION = '9.10.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "9.9.0";
+export declare const VERSION = "9.10.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

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

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}