@tryfinch/finch-api 5.16.0 → 5.17.0

package/src/resources/webhooks.ts

@@ -3,6 +3,9 @@
 import { APIResource } from "../resource";
 import { createHmac } from 'crypto';
 import { getRequiredHeader, HeadersLike } from "../core";
+import * as WebhooksAPI from "./webhooks";
+import * as Shared from "./shared";
+import * as BenefitsAPI from "./hris/benefits/benefits";
 
 export class Webhooks extends APIResource {
   /**
@@ -12,9 +15,9 @@ export class Webhooks extends APIResource {
     payload: string,
     headers: HeadersLike,
     secret: string | undefined | null = this._client.webhookSecret,
-  ): Object {
+  ): WebhookEvent {
     this.verifySignature(payload, headers, secret);
-    return JSON.parse(payload);
+    return JSON.parse(payload) as WebhookEvent;
   }
 
   private parseSecret(secret: string | null | undefined): Uint8Array {
@@ -138,3 +141,550 @@ export class Webhooks extends APIResource {
     throw new Error('None of the given webhook signatures match the expected signature');
   }
 }
+
+export interface AccountUpdateEvent extends BaseWebhookEvent {
+  data?: AccountUpdateEvent.Data;
+
+  event_type?: 'account.updated';
+}
+
+export namespace AccountUpdateEvent {
+  export interface Data {
+    authentication_method: Data.AuthenticationMethod;
+
+    status: Shared.ConnectionStatusType;
+  }
+
+  export namespace Data {
+    export interface AuthenticationMethod {
+      /**
+       * Each benefit type and their supported features. If the benefit type is not
+       * supported, the property will be null
+       */
+      benefits_support?: BenefitsAPI.BenefitsSupport | null;
+
+      /**
+       * The supported data fields returned by our HR and payroll endpoints
+       */
+      supported_fields?: AuthenticationMethod.SupportedFields | null;
+
+      /**
+       * The type of authentication method.
+       */
+      type?: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth';
+    }
+
+    export namespace AuthenticationMethod {
+      /**
+       * The supported data fields returned by our HR and payroll endpoints
+       */
+      export interface SupportedFields {
+        company?: SupportedFields.Company;
+
+        directory?: SupportedFields.Directory;
+
+        employment?: SupportedFields.Employment;
+
+        individual?: SupportedFields.Individual;
+
+        pay_statement?: SupportedFields.PayStatement;
+
+        payment?: SupportedFields.Payment;
+      }
+
+      export namespace SupportedFields {
+        export interface Company {
+          id?: boolean;
+
+          accounts?: Company.Accounts;
+
+          departments?: Company.Departments;
+
+          ein?: boolean;
+
+          entity?: Company.Entity;
+
+          legal_name?: boolean;
+
+          locations?: Company.Locations;
+
+          primary_email?: boolean;
+
+          primary_phone_number?: boolean;
+        }
+
+        export namespace Company {
+          export interface Accounts {
+            account_name?: boolean;
+
+            account_number?: boolean;
+
+            account_type?: boolean;
+
+            institution_name?: boolean;
+
+            routing_number?: boolean;
+          }
+
+          export interface Departments {
+            name?: boolean;
+
+            parent?: Departments.Parent;
+          }
+
+          export namespace Departments {
+            export interface Parent {
+              name?: boolean;
+            }
+          }
+
+          export interface Entity {
+            subtype?: boolean;
+
+            type?: boolean;
+          }
+
+          export interface Locations {
+            city?: boolean;
+
+            country?: boolean;
+
+            line1?: boolean;
+
+            line2?: boolean;
+
+            postal_code?: boolean;
+
+            state?: boolean;
+          }
+        }
+
+        export interface Directory {
+          individuals?: Directory.Individuals;
+
+          paging?: Directory.Paging;
+        }
+
+        export namespace Directory {
+          export interface Individuals {
+            id?: boolean;
+
+            department?: boolean;
+
+            first_name?: boolean;
+
+            is_active?: boolean;
+
+            last_name?: boolean;
+
+            manager?: Individuals.Manager;
+
+            middle_name?: boolean;
+          }
+
+          export namespace Individuals {
+            export interface Manager {
+              id?: boolean;
+            }
+          }
+
+          export interface Paging {
+            count?: boolean;
+
+            offset?: boolean;
+          }
+        }
+
+        export interface Employment {
+          id?: boolean;
+
+          class_code?: boolean;
+
+          custom_fields?: boolean;
+
+          department?: Employment.Department;
+
+          employment?: Employment.Employment;
+
+          end_date?: boolean;
+
+          first_name?: boolean;
+
+          income?: Employment.Income;
+
+          income_history?: boolean;
+
+          is_active?: boolean;
+
+          last_name?: boolean;
+
+          location?: Employment.Location;
+
+          manager?: Employment.Manager;
+
+          middle_name?: boolean;
+
+          start_date?: boolean;
+
+          title?: boolean;
+        }
+
+        export namespace Employment {
+          export interface Department {
+            name?: boolean;
+          }
+
+          export interface Employment {
+            subtype?: boolean;
+
+            type?: boolean;
+          }
+
+          export interface Income {
+            amount?: boolean;
+
+            currency?: boolean;
+
+            unit?: boolean;
+          }
+
+          export interface Location {
+            city?: boolean;
+
+            country?: boolean;
+
+            line1?: boolean;
+
+            line2?: boolean;
+
+            postal_code?: boolean;
+
+            state?: boolean;
+          }
+
+          export interface Manager {
+            id?: boolean;
+          }
+        }
+
+        export interface Individual {
+          id?: boolean;
+
+          dob?: boolean;
+
+          emails?: Individual.Emails;
+
+          encrypted_ssn?: boolean;
+
+          ethnicity?: boolean;
+
+          first_name?: boolean;
+
+          gender?: boolean;
+
+          last_name?: boolean;
+
+          middle_name?: boolean;
+
+          phone_numbers?: Individual.PhoneNumbers;
+
+          preferred_name?: boolean;
+
+          residence?: Individual.Residence;
+
+          ssn?: boolean;
+        }
+
+        export namespace Individual {
+          export interface Emails {
+            data?: boolean;
+
+            type?: boolean;
+          }
+
+          export interface PhoneNumbers {
+            data?: boolean;
+
+            type?: boolean;
+          }
+
+          export interface Residence {
+            city?: boolean;
+
+            country?: boolean;
+
+            line1?: boolean;
+
+            line2?: boolean;
+
+            postal_code?: boolean;
+
+            state?: boolean;
+          }
+        }
+
+        export interface PayStatement {
+          paging?: PayStatement.Paging;
+
+          pay_statements?: PayStatement.PayStatements;
+        }
+
+        export namespace PayStatement {
+          export interface Paging {
+            count: boolean;
+
+            offset: boolean;
+          }
+
+          export interface PayStatements {
+            earnings?: PayStatements.Earnings;
+
+            employee_deductions?: PayStatements.EmployeeDeductions;
+
+            employer_deductions?: PayStatements.EmployerDeductions;
+
+            gross_pay?: boolean;
+
+            individual_id?: boolean;
+
+            net_pay?: boolean;
+
+            payment_method?: boolean;
+
+            taxes?: PayStatements.Taxes;
+
+            total_hours?: boolean;
+
+            type?: boolean;
+          }
+
+          export namespace PayStatements {
+            export interface Earnings {
+              amount?: boolean;
+
+              currency?: boolean;
+
+              name?: boolean;
+
+              type?: boolean;
+            }
+
+            export interface EmployeeDeductions {
+              amount?: boolean;
+
+              currency?: boolean;
+
+              name?: boolean;
+
+              pre_tax?: boolean;
+
+              type?: boolean;
+            }
+
+            export interface EmployerDeductions {
+              amount?: boolean;
+
+              currency?: boolean;
+
+              name?: boolean;
+            }
+
+            export interface Taxes {
+              amount?: boolean;
+
+              currency?: boolean;
+
+              employer?: boolean;
+
+              name?: boolean;
+
+              type?: boolean;
+            }
+          }
+        }
+
+        export interface Payment {
+          id?: boolean;
+
+          company_debit?: boolean;
+
+          debit_date?: boolean;
+
+          employee_taxes?: boolean;
+
+          employer_taxes?: boolean;
+
+          gross_pay?: boolean;
+
+          individual_ids?: boolean;
+
+          net_pay?: boolean;
+
+          pay_date?: boolean;
+
+          pay_period?: Payment.PayPeriod;
+        }
+
+        export namespace Payment {
+          export interface PayPeriod {
+            end_date?: boolean;
+
+            start_date?: boolean;
+          }
+        }
+      }
+    }
+  }
+}
+
+export interface BaseWebhookEvent {
+  /**
+   * Unique Finch id of the employer account that was used to make this connection.
+   */
+  account_id: string;
+
+  /**
+   * Unique Finch id of the company for which data has been updated.
+   */
+  company_id: string;
+}
+
+export interface CompanyEvent extends BaseWebhookEvent {
+  data?: Record<string, unknown> | null;
+
+  event_type?: 'company.updated';
+}
+
+export interface DirectoryEvent extends BaseWebhookEvent {
+  data?: DirectoryEvent.Data;
+
+  event_type?: 'directory.created' | 'directory.updated' | 'directory.deleted';
+}
+
+export namespace DirectoryEvent {
+  export interface Data {
+    /**
+     * The ID of the individual related to the event.
+     */
+    individual_id?: string;
+  }
+}
+
+export interface EmploymentEvent extends BaseWebhookEvent {
+  data?: EmploymentEvent.Data;
+
+  event_type?: 'employment.created' | 'employment.updated' | 'employment.deleted';
+}
+
+export namespace EmploymentEvent {
+  export interface Data {
+    /**
+     * The ID of the individual related to the event.
+     */
+    individual_id?: string;
+  }
+}
+
+export interface IndividualEvent extends BaseWebhookEvent {
+  data?: IndividualEvent.Data;
+
+  event_type?: 'individual.created' | 'individual.updated' | 'individual.deleted';
+}
+
+export namespace IndividualEvent {
+  export interface Data {
+    /**
+     * The ID of the individual related to the event.
+     */
+    individual_id?: string;
+  }
+}
+
+export interface JobCompletionEvent extends BaseWebhookEvent {
+  data?: JobCompletionEvent.Data;
+
+  event_type?:
+    | 'job.benefit_create.updated'
+    | 'job.benefit_enroll.updated'
+    | 'job.benefit_register.updated'
+    | 'job.benefit_unenroll.updated'
+    | 'job.benefit_update.updated'
+    | 'job.data_sync_all.updated';
+}
+
+export namespace JobCompletionEvent {
+  export interface Data {
+    /**
+     * The id of the job which has completed.
+     */
+    job_id: string;
+
+    /**
+     * The url to query the result of the job.
+     */
+    job_url: string;
+  }
+}
+
+export interface PayStatementEvent extends BaseWebhookEvent {
+  data?: PayStatementEvent.Data;
+
+  event_type?: 'pay_statement.created' | 'pay_statement.updated' | 'pay_statement.deleted';
+}
+
+export namespace PayStatementEvent {
+  export interface Data {
+    /**
+     * The ID of the individual associated with the pay statement.
+     */
+    individual_id?: string;
+
+    /**
+     * The ID of the payment associated with the pay statement.
+     */
+    payment_id?: string;
+  }
+}
+
+export interface PaymentEvent extends BaseWebhookEvent {
+  data?: PaymentEvent.Data;
+
+  event_type?: 'payment.created' | 'payment.updated' | 'payment.deleted';
+}
+
+export namespace PaymentEvent {
+  export interface Data {
+    /**
+     * The date of the payment.
+     */
+    pay_date: string;
+
+    /**
+     * The ID of the payment.
+     */
+    payment_id: string;
+  }
+}
+
+export type WebhookEvent =
+  | AccountUpdateEvent
+  | JobCompletionEvent
+  | CompanyEvent
+  | DirectoryEvent
+  | EmploymentEvent
+  | IndividualEvent
+  | PaymentEvent
+  | PayStatementEvent;
+
+export namespace Webhooks {
+  export import AccountUpdateEvent = WebhooksAPI.AccountUpdateEvent;
+  export import BaseWebhookEvent = WebhooksAPI.BaseWebhookEvent;
+  export import CompanyEvent = WebhooksAPI.CompanyEvent;
+  export import DirectoryEvent = WebhooksAPI.DirectoryEvent;
+  export import EmploymentEvent = WebhooksAPI.EmploymentEvent;
+  export import IndividualEvent = WebhooksAPI.IndividualEvent;
+  export import JobCompletionEvent = WebhooksAPI.JobCompletionEvent;
+  export import PayStatementEvent = WebhooksAPI.PayStatementEvent;
+  export import PaymentEvent = WebhooksAPI.PaymentEvent;
+  export import WebhookEvent = WebhooksAPI.WebhookEvent;
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.16.0'; // x-release-please-version
+export const VERSION = '5.17.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.16.0";
+export declare const VERSION = "5.17.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 = '5.16.0'; // x-release-please-version
+exports.VERSION = '5.17.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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