@tryfinch/finch-api 5.9.1 → 5.11.0

package/src/resources/hris/employments.ts

@@ -18,7 +18,7 @@ export class Employments extends APIResource {
     body: EmploymentRetrieveManyParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<EmploymentDataResponsesPage, EmploymentDataResponse> {
-    return this.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
+    return this._client.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
       body,
       method: 'post',
       ...options,
@@ -39,6 +39,12 @@ export interface EmploymentData {
    */
   class_code?: string | null;
 
+  /**
+   * Custom fields for the individual. These are fields which are defined by the
+   * employer in the system.
+   */
+  custom_fields?: Array<EmploymentData.CustomField> | null;
+
   /**
    * The department object.
    */
@@ -122,6 +128,12 @@ export interface EmploymentData {
 }
 
 export namespace EmploymentData {
+  export interface CustomField {
+    name?: string;
+
+    value?: unknown;
+  }
+
   /**
    * The department object.
    */

package/src/resources/hris/hris.ts

@@ -11,13 +11,13 @@ import * as PaymentsAPI from "./payments";
 import * as BenefitsAPI from "./benefits/benefits";
 
 export class HRIS extends APIResource {
-  company: CompanyAPI.CompanyResource = new CompanyAPI.CompanyResource(this.client);
-  directory: DirectoryAPI.Directory = new DirectoryAPI.Directory(this.client);
-  individuals: IndividualsAPI.Individuals = new IndividualsAPI.Individuals(this.client);
-  employments: EmploymentsAPI.Employments = new EmploymentsAPI.Employments(this.client);
-  payments: PaymentsAPI.Payments = new PaymentsAPI.Payments(this.client);
-  payStatements: PayStatementsAPI.PayStatements = new PayStatementsAPI.PayStatements(this.client);
-  benefits: BenefitsAPI.Benefits = new BenefitsAPI.Benefits(this.client);
+  company: CompanyAPI.CompanyResource = new CompanyAPI.CompanyResource(this._client);
+  directory: DirectoryAPI.Directory = new DirectoryAPI.Directory(this._client);
+  individuals: IndividualsAPI.Individuals = new IndividualsAPI.Individuals(this._client);
+  employments: EmploymentsAPI.Employments = new EmploymentsAPI.Employments(this._client);
+  payments: PaymentsAPI.Payments = new PaymentsAPI.Payments(this._client);
+  payStatements: PayStatementsAPI.PayStatements = new PayStatementsAPI.PayStatements(this._client);
+  benefits: BenefitsAPI.Benefits = new BenefitsAPI.Benefits(this._client);
 }
 
 /**
@@ -148,14 +148,17 @@ export namespace HRIS {
   export import PayStatementRetrieveManyParams = PayStatementsAPI.PayStatementRetrieveManyParams;
   export import Benefits = BenefitsAPI.Benefits;
   export import BenefitContribution = BenefitsAPI.BenefitContribution;
+  export import BenefitFeaturesAndOperations = BenefitsAPI.BenefitFeaturesAndOperations;
   export import BenefitFrequency = BenefitsAPI.BenefitFrequency;
   export import BenefitType = BenefitsAPI.BenefitType;
+  export import BenefitsSupport = BenefitsAPI.BenefitsSupport;
   /**
    * @deprecated use `BenefitContribution` instead
    */
   export import BenfitContribution = BenefitsAPI.BenfitContribution;
   export import CompanyBenefit = BenefitsAPI.CompanyBenefit;
   export import CreateCompanyBenefitsResponse = BenefitsAPI.CreateCompanyBenefitsResponse;
+  export import SupportPerBenefitType = BenefitsAPI.SupportPerBenefitType;
   export import SupportedBenefit = BenefitsAPI.SupportedBenefit;
   export import UpdateCompanyBenefitResponse = BenefitsAPI.UpdateCompanyBenefitResponse;
   export import CompanyBenefitsSinglePage = BenefitsAPI.CompanyBenefitsSinglePage;

package/src/resources/hris/index.ts

@@ -2,11 +2,14 @@
 
 export {
   BenefitContribution,
+  BenefitFeaturesAndOperations,
   BenefitFrequency,
   BenefitType,
+  BenefitsSupport,
   BenfitContribution,
   CompanyBenefit,
   CreateCompanyBenefitsResponse,
+  SupportPerBenefitType,
   SupportedBenefit,
   UpdateCompanyBenefitResponse,
   BenefitCreateParams,

package/src/resources/hris/individuals.ts

@@ -23,7 +23,7 @@ export class Individuals extends APIResource {
     if (isRequestOptions(body)) {
       return this.retrieveMany({}, body);
     }
-    return this.getAPIList('/employer/individual', IndividualResponsesPage, {
+    return this._client.getAPIList('/employer/individual', IndividualResponsesPage, {
       body,
       method: 'post',
       ...options,
@@ -43,6 +43,26 @@ export interface Individual {
 
   emails?: Array<Individual.Email> | null;
 
+  /**
+   * Note: This property is only available if enabled for your account. Please reach
+   * out to your Finch representative if you would like access.
+   */
+  encrypted_ssn?: string | null;
+
+  /**
+   * The EEOC-defined ethnicity of the individual.
+   */
+  ethnicity?:
+    | 'asian'
+    | 'white'
+    | 'black_or_african_american'
+    | 'native_hawaiian_or_pacific_islander'
+    | 'american_indian_or_alaska_native'
+    | 'hispanic_or_latino'
+    | 'two_or_more_races'
+    | 'decline_to_specify'
+    | null;
+
   /**
    * The legal first name of the individual.
    */

package/src/resources/hris/pay-statements.ts

@@ -18,7 +18,7 @@ export class PayStatements extends APIResource {
     body: PayStatementRetrieveManyParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<PayStatementResponsesPage, PayStatementResponse> {
-    return this.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {
+    return this._client.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {
       body,
       method: 'post',
       ...options,

package/src/resources/hris/payments.ts

@@ -14,7 +14,7 @@ export class Payments extends APIResource {
     query: PaymentListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<PaymentsSinglePage, Payment> {
-    return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
+    return this._client.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
   }
 }
 

package/src/resources/index.ts

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
 
+export * from './shared';
 export { DisconnectResponse, Introspection, Account } from './account';
 export { Income, Location, Money, Paging, HRIS } from './hris/hris';
 export { Provider, ProvidersSinglePage, Providers } from './providers';

package/src/resources/providers.ts

@@ -3,6 +3,7 @@
 import * as Core from "../core";
 import { APIResource } from "../resource";
 import * as ProvidersAPI from "./providers";
+import * as BenefitsAPI from "./hris/benefits/benefits";
 import { SinglePage } from "../pagination";
 
 export class Providers extends APIResource {
@@ -10,7 +11,7 @@ export class Providers extends APIResource {
    * Return details on all available payroll and HR systems.
    */
   list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage, Provider> {
-    return this.getAPIList('/providers', ProvidersSinglePage, options);
+    return this._client.getAPIList('/providers', ProvidersSinglePage, options);
   }
 }
 
@@ -22,6 +23,11 @@ export interface Provider {
    */
   id?: string;
 
+  /**
+   * The list of authentication methods supported by the provider.
+   */
+  authentication_methods?: Array<Provider.AuthenticationMethod>;
+
   /**
    * The display name of the payroll provider.
    */
@@ -38,8 +44,9 @@ export interface Provider {
   logo?: string;
 
   /**
-   * Whether the Finch integration with this provider uses the Assisted Connect Flow
-   * by default.
+   * [DEPRECATED] Whether the Finch integration with this provider uses the Assisted
+   * Connect Flow by default. This field is now deprecated. Please check for a `type`
+   * of `assisted` in the `authentication_methods` field instead.
    */
   manual?: boolean;
 
@@ -59,6 +66,387 @@ export interface Provider {
   products?: Array<string>;
 }
 
+export namespace Provider {
+  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 namespace Providers {
   export import Provider = ProvidersAPI.Provider;
   export import ProvidersSinglePage = ProvidersAPI.ProvidersSinglePage;

package/src/resources/request-forwarding.ts

@@ -6,13 +6,16 @@ import * as RequestForwardingAPI from "./request-forwarding";
 
 export class RequestForwarding extends APIResource {
   /**
-   * The Forward API allows you to make direct requests to an employment system.
+   * The Forward API allows you to make direct requests to an employment system. If
+   * Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
+   * Forward allows you to push or pull data models directly against an integration’s
+   * API.
    */
   forward(
     body: RequestForwardingForwardParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<RequestForwardingForwardResponse> {
-    return this.post('/forward', { body, ...options });
+    return this._client.post('/forward', { body, ...options });
   }
 }
 
@@ -64,7 +67,7 @@ export namespace RequestForwardingForwardResponse {
 
     /**
      * The HTTP method that was specified for the forwarded request. Valid values
-     * include: `GET`, `POST`, `PUT` , `DELETE`, and `PATCH`.
+     * include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.
      */
     method: string;
 
@@ -83,8 +86,8 @@ export namespace RequestForwardingForwardResponse {
 
 export interface RequestForwardingForwardParams {
   /**
-   * The HTTP method for the forwarded request. Valid values include: `GET`, `POST`,
-   * `PUT`, `DELETE`, and `PATCH`.
+   * The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
+   * , `PUT` , `DELETE` , and `PATCH`.
    */
   method: string;
 

package/src/resources/shared.ts

@@ -0,0 +1,62 @@
+// File generated from our OpenAPI spec by Stainless.
+
+/**
+ * - `supported`: This operation is supported by both the provider and Finch <br>
+ * - `not_supported_by_finch`: This operation is not supported by Finch but
+ *   supported by the provider <br>
+ * - `not_supported_by_provider`: This operation is not supported by the provider,
+ *   so Finch cannot support <br>
+ * - `client_access_only`: This behavior is supported by the provider, but only
+ *   available to the client and not to Finch
+ */
+export type OperationSupport =
+  | 'supported'
+  | 'not_supported_by_finch'
+  | 'not_supported_by_provider'
+  | 'client_access_only';
+
+export interface OperationSupportMatrix {
+  /**
+   * - `supported`: This operation is supported by both the provider and Finch <br>
+   * - `not_supported_by_finch`: This operation is not supported by Finch but
+   *   supported by the provider <br>
+   * - `not_supported_by_provider`: This operation is not supported by the provider,
+   *   so Finch cannot support <br>
+   * - `client_access_only`: This behavior is supported by the provider, but only
+   *   available to the client and not to Finch
+   */
+  create?: OperationSupport;
+
+  /**
+   * - `supported`: This operation is supported by both the provider and Finch <br>
+   * - `not_supported_by_finch`: This operation is not supported by Finch but
+   *   supported by the provider <br>
+   * - `not_supported_by_provider`: This operation is not supported by the provider,
+   *   so Finch cannot support <br>
+   * - `client_access_only`: This behavior is supported by the provider, but only
+   *   available to the client and not to Finch
+   */
+  delete?: OperationSupport;
+
+  /**
+   * - `supported`: This operation is supported by both the provider and Finch <br>
+   * - `not_supported_by_finch`: This operation is not supported by Finch but
+   *   supported by the provider <br>
+   * - `not_supported_by_provider`: This operation is not supported by the provider,
+   *   so Finch cannot support <br>
+   * - `client_access_only`: This behavior is supported by the provider, but only
+   *   available to the client and not to Finch
+   */
+  read?: OperationSupport;
+
+  /**
+   * - `supported`: This operation is supported by both the provider and Finch <br>
+   * - `not_supported_by_finch`: This operation is not supported by Finch but
+   *   supported by the provider <br>
+   * - `not_supported_by_provider`: This operation is not supported by the provider,
+   *   so Finch cannot support <br>
+   * - `client_access_only`: This behavior is supported by the provider, but only
+   *   available to the client and not to Finch
+   */
+  update?: OperationSupport;
+}

package/src/resources/webhooks.ts

@@ -11,7 +11,7 @@ export class Webhooks extends APIResource {
   unwrap(
     payload: string,
     headers: HeadersLike,
-    secret: string | undefined | null = this.client.webhookSecret,
+    secret: string | undefined | null = this._client.webhookSecret,
   ): Object {
     this.verifySignature(payload, headers, secret);
     return JSON.parse(payload);
@@ -86,7 +86,7 @@ export class Webhooks extends APIResource {
   verifySignature(
     body: string,
     headers: HeadersLike,
-    secret: string | undefined | null = this.client.webhookSecret,
+    secret: string | undefined | null = this._client.webhookSecret,
   ): void {
     const parsedSecret = this.parseSecret(secret);
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.9.1'; // x-release-please-version
+export const VERSION = '5.11.0'; // x-release-please-version