@tryfinch/finch-api 6.31.0 → 8.0.0

package/src/resources/providers.ts

@@ -1,41 +1,45 @@
 // 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 BenefitsAPI from "./hris/benefits/benefits.js";
-import { SinglePage } from "../pagination.js";
+import { APIResource } from '../core/resource';
+import { PagePromise, SinglePage } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
 
 export class Providers extends APIResource {
   /**
    * Return details on all available payroll and HR systems.
    */
-  list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage, Provider> {
-    return this._client.getAPIList('/providers', ProvidersSinglePage, options);
+  list(options?: RequestOptions): PagePromise<ProviderListResponsesSinglePage, ProviderListResponse> {
+    return this._client.getAPIList('/providers', SinglePage<ProviderListResponse>, options);
   }
 }
 
-export class ProvidersSinglePage extends SinglePage<Provider> {}
+export type ProviderListResponsesSinglePage = SinglePage<ProviderListResponse>;
 
 export interface Provider {
   /**
    * The id of the payroll provider used in Connect.
    */
-  id?: string;
+  id: string;
 
   /**
-   * The list of authentication methods supported by the provider.
+   * The display name of the payroll provider.
    */
-  authentication_methods?: Array<Provider.AuthenticationMethod>;
+  display_name: string;
 
   /**
-   * `true` if the integration is in a beta state, `false` otherwise
+   * The list of Finch products supported on this payroll provider.
    */
-  beta?: boolean;
+  products: Array<string>;
 
   /**
-   * The display name of the payroll provider.
+   * The authentication methods supported by the provider.
    */
-  display_name?: string;
+  authentication_methods?: Array<Provider.AuthenticationMethod>;
+
+  /**
+   * `true` if the integration is in a beta state, `false` otherwise
+   */
+  beta?: boolean;
 
   /**
    * The url to the official icon of the payroll provider.
@@ -48,9 +52,9 @@ export interface Provider {
   logo?: string;
 
   /**
-   * [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.
+   * @deprecated [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;
 
@@ -63,414 +67,104 @@ export interface Provider {
    * The hex code for the primary color of the payroll provider.
    */
   primary_color?: string;
-
-  /**
-   * The list of Finch products supported on this payroll 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
+     * The type of authentication method
      */
-    benefits_support?: BenefitsAPI.BenefitsSupport | null;
+    type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api';
 
     /**
-     * The supported data fields returned by our HR and payroll endpoints
+     * The supported benefit types and their configurations
      */
-    supported_fields?: AuthenticationMethod.SupportedFields | null;
+    benefits_support?: { [key: string]: unknown };
 
     /**
-     * The type of authentication method.
+     * The supported fields for each Finch product
      */
-    type?: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth';
+    supported_fields?: { [key: string]: unknown };
   }
+}
 
-  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_group?: SupportedFields.PayGroup;
-
-      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;
-
-        employment_status?: boolean;
-
-        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 PayGroup {
-        id?: boolean;
-
-        individual_ids?: boolean;
-
-        name?: boolean;
-
-        pay_frequencies?: 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_contributions?: PayStatements.EmployerContributions;
-
-          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 EmployerContributions {
-            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;
+export interface ProviderListResponse {
+  /**
+   * The id of the payroll provider used in Connect.
+   */
+  id: string;
 
-        debit_date?: boolean;
+  /**
+   * The display name of the payroll provider.
+   */
+  display_name: string;
 
-        employee_taxes?: boolean;
+  /**
+   * The list of Finch products supported on this payroll provider.
+   */
+  products: Array<string>;
 
-        employer_taxes?: boolean;
+  /**
+   * The authentication methods supported by the provider.
+   */
+  authentication_methods?: Array<ProviderListResponse.AuthenticationMethod>;
 
-        gross_pay?: boolean;
+  /**
+   * `true` if the integration is in a beta state, `false` otherwise
+   */
+  beta?: boolean;
 
-        individual_ids?: boolean;
+  /**
+   * The url to the official icon of the payroll provider.
+   */
+  icon?: string;
 
-        net_pay?: boolean;
+  /**
+   * The url to the official logo of the payroll provider.
+   */
+  logo?: string;
 
-        pay_date?: boolean;
+  /**
+   * @deprecated [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;
 
-        pay_frequencies?: boolean;
+  /**
+   * whether MFA is required for the provider.
+   */
+  mfa_required?: boolean;
 
-        pay_group_ids?: boolean;
+  /**
+   * The hex code for the primary color of the payroll provider.
+   */
+  primary_color?: string;
+}
 
-        pay_period?: Payment.PayPeriod;
-      }
+export namespace ProviderListResponse {
+  export interface AuthenticationMethod {
+    /**
+     * The type of authentication method
+     */
+    type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api';
 
-      export namespace Payment {
-        export interface PayPeriod {
-          end_date?: boolean;
+    /**
+     * The supported benefit types and their configurations
+     */
+    benefits_support?: { [key: string]: unknown };
 
-          start_date?: boolean;
-        }
-      }
-    }
+    /**
+     * The supported fields for each Finch product
+     */
+    supported_fields?: { [key: string]: unknown };
   }
 }
 
-Providers.ProvidersSinglePage = ProvidersSinglePage;
-
 export declare namespace Providers {
-  export { type Provider as Provider, ProvidersSinglePage as ProvidersSinglePage };
+  export {
+    type Provider as Provider,
+    type ProviderListResponse as ProviderListResponse,
+    type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage,
+  };
 }