@tryfinch/finch-api 5.14.3 → 5.16.0

package/src/resources/sandbox/company.ts

@@ -0,0 +1,252 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as CompanyAPI from "./company";
+import * as HRISAPI from "../hris/hris";
+
+export class Company extends APIResource {
+  /**
+   * Update a sandbox company's data
+   */
+  update(body: CompanyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CompanyUpdateResponse> {
+    return this._client.put('/sandbox/company', { body, ...options });
+  }
+}
+
+export interface CompanyUpdateResponse {
+  /**
+   * An array of bank account objects associated with the payroll/HRIS system.
+   */
+  accounts: Array<CompanyUpdateResponse.Account> | null;
+
+  /**
+   * The array of company departments.
+   */
+  departments: Array<CompanyUpdateResponse.Department | null> | null;
+
+  /**
+   * The employer identification number.
+   */
+  ein: string | null;
+
+  /**
+   * The entity type object.
+   */
+  entity: CompanyUpdateResponse.Entity | null;
+
+  /**
+   * The legal name of the company.
+   */
+  legal_name: string | null;
+
+  locations: Array<HRISAPI.Location | null> | null;
+
+  /**
+   * The email of the main administrator on the account.
+   */
+  primary_email: string | null;
+
+  /**
+   * The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
+   */
+  primary_phone_number: string | null;
+}
+
+export namespace CompanyUpdateResponse {
+  export interface Account {
+    /**
+     * The name of the bank associated in the payroll/HRIS system.
+     */
+    account_name?: string | null;
+
+    /**
+     * 10-12 digit number to specify the bank account
+     */
+    account_number?: string | null;
+
+    /**
+     * The type of bank account.
+     */
+    account_type?: 'checking' | 'savings' | null;
+
+    /**
+     * Name of the banking institution.
+     */
+    institution_name?: string | null;
+
+    /**
+     * A nine-digit code that's based on the U.S. Bank location where your account was
+     * opened.
+     */
+    routing_number?: string | null;
+  }
+
+  export interface Department {
+    /**
+     * The department name.
+     */
+    name?: string | null;
+
+    /**
+     * The parent department, if present.
+     */
+    parent?: Department.Parent | null;
+  }
+
+  export namespace Department {
+    /**
+     * The parent department, if present.
+     */
+    export interface Parent {
+      /**
+       * The parent department's name.
+       */
+      name?: string | null;
+    }
+  }
+
+  /**
+   * The entity type object.
+   */
+  export interface Entity {
+    /**
+     * The tax payer subtype of the company.
+     */
+    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
+
+    /**
+     * The tax payer type of the company.
+     */
+    type?:
+      | 'llc'
+      | 'lp'
+      | 'corporation'
+      | 'sole_proprietor'
+      | 'non_profit'
+      | 'partnership'
+      | 'cooperative'
+      | null;
+  }
+}
+
+export interface CompanyUpdateParams {
+  /**
+   * An array of bank account objects associated with the payroll/HRIS system.
+   */
+  accounts: Array<CompanyUpdateParams.Account> | null;
+
+  /**
+   * The array of company departments.
+   */
+  departments: Array<CompanyUpdateParams.Department | null> | null;
+
+  /**
+   * The employer identification number.
+   */
+  ein: string | null;
+
+  /**
+   * The entity type object.
+   */
+  entity: CompanyUpdateParams.Entity | null;
+
+  /**
+   * The legal name of the company.
+   */
+  legal_name: string | null;
+
+  locations: Array<HRISAPI.Location | null> | null;
+
+  /**
+   * The email of the main administrator on the account.
+   */
+  primary_email: string | null;
+
+  /**
+   * The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
+   */
+  primary_phone_number: string | null;
+}
+
+export namespace CompanyUpdateParams {
+  export interface Account {
+    /**
+     * The name of the bank associated in the payroll/HRIS system.
+     */
+    account_name?: string | null;
+
+    /**
+     * 10-12 digit number to specify the bank account
+     */
+    account_number?: string | null;
+
+    /**
+     * The type of bank account.
+     */
+    account_type?: 'checking' | 'savings' | null;
+
+    /**
+     * Name of the banking institution.
+     */
+    institution_name?: string | null;
+
+    /**
+     * A nine-digit code that's based on the U.S. Bank location where your account was
+     * opened.
+     */
+    routing_number?: string | null;
+  }
+
+  export interface Department {
+    /**
+     * The department name.
+     */
+    name?: string | null;
+
+    /**
+     * The parent department, if present.
+     */
+    parent?: Department.Parent | null;
+  }
+
+  export namespace Department {
+    /**
+     * The parent department, if present.
+     */
+    export interface Parent {
+      /**
+       * The parent department's name.
+       */
+      name?: string | null;
+    }
+  }
+
+  /**
+   * The entity type object.
+   */
+  export interface Entity {
+    /**
+     * The tax payer subtype of the company.
+     */
+    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
+
+    /**
+     * The tax payer type of the company.
+     */
+    type?:
+      | 'llc'
+      | 'lp'
+      | 'corporation'
+      | 'sole_proprietor'
+      | 'non_profit'
+      | 'partnership'
+      | 'cooperative'
+      | null;
+  }
+}
+
+export namespace Company {
+  export import CompanyUpdateResponse = CompanyAPI.CompanyUpdateResponse;
+  export import CompanyUpdateParams = CompanyAPI.CompanyUpdateParams;
+}

package/src/resources/sandbox/connections/accounts.ts

@@ -0,0 +1,83 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import { isRequestOptions } from "../../../core";
+import * as AccountsAPI from "./accounts";
+import * as Shared from "../../shared";
+
+export class Accounts extends APIResource {
+  /**
+   * Create a new account for an existing connection (company/provider pair)
+   */
+  create(body: AccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<AccountCreateResponse> {
+    return this._client.post('/sandbox/connections/accounts', { body, ...options });
+  }
+
+  /**
+   * Update an existing sandbox account. Change the connection status to understand
+   * how the Finch API responds.
+   */
+  update(body?: AccountUpdateParams, options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;
+  update(options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;
+  update(
+    body: AccountUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AccountUpdateResponse> {
+    if (isRequestOptions(body)) {
+      return this.update({}, body);
+    }
+    return this._client.put('/sandbox/connections/accounts', { body, ...options });
+  }
+}
+
+export interface AccountCreateResponse {
+  access_token: string;
+
+  account_id: string;
+
+  authentication_type: 'credentials' | 'api_token' | 'oauth' | 'assisted';
+
+  company_id: string;
+
+  products: Array<string>;
+
+  provider_id: string;
+}
+
+export interface AccountUpdateResponse {
+  account_id: string;
+
+  authentication_type: 'credentials' | 'api_token' | 'oauth' | 'assisted';
+
+  company_id: string;
+
+  products: Array<string>;
+
+  provider_id: string;
+}
+
+export interface AccountCreateParams {
+  company_id: string;
+
+  provider_id: string;
+
+  authentication_type?: 'credentials' | 'api_token' | 'oauth' | 'assisted';
+
+  /**
+   * Optional, defaults to Organization products (`company`, `directory`,
+   * `employment`, `individual`)
+   */
+  products?: Array<string>;
+}
+
+export interface AccountUpdateParams {
+  connection_status?: Shared.ConnectionStatusType;
+}
+
+export namespace Accounts {
+  export import AccountCreateResponse = AccountsAPI.AccountCreateResponse;
+  export import AccountUpdateResponse = AccountsAPI.AccountUpdateResponse;
+  export import AccountCreateParams = AccountsAPI.AccountCreateParams;
+  export import AccountUpdateParams = AccountsAPI.AccountUpdateParams;
+}

package/src/resources/sandbox/connections/connections.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import * as ConnectionsAPI from "./connections";
+import * as AccountsAPI from "./accounts";
+
+export class Connections extends APIResource {
+  accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
+
+  /**
+   * Create a new connection (new company/provider pair) with a new account
+   */
+  create(
+    body: ConnectionCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ConnectionCreateResponse> {
+    return this._client.post('/sandbox/connections', { body, ...options });
+  }
+}
+
+export interface ConnectionCreateResponse {
+  access_token: string;
+
+  account_id: string;
+
+  authentication_type: 'credentials' | 'api_token' | 'oauth' | 'assisted';
+
+  company_id: string;
+
+  products: Array<string>;
+
+  provider_id: string;
+}
+
+export interface ConnectionCreateParams {
+  provider_id: string;
+
+  authentication_type?: 'credentials' | 'api_token' | 'oauth' | 'assisted';
+
+  /**
+   * Optional: the size of the employer to be created with this connection. Defaults
+   * to 20
+   */
+  employer_size?: number;
+
+  products?: Array<string>;
+}
+
+export namespace Connections {
+  export import ConnectionCreateResponse = ConnectionsAPI.ConnectionCreateResponse;
+  export import ConnectionCreateParams = ConnectionsAPI.ConnectionCreateParams;
+  export import Accounts = AccountsAPI.Accounts;
+  export import AccountCreateResponse = AccountsAPI.AccountCreateResponse;
+  export import AccountUpdateResponse = AccountsAPI.AccountUpdateResponse;
+  export import AccountCreateParams = AccountsAPI.AccountCreateParams;
+  export import AccountUpdateParams = AccountsAPI.AccountUpdateParams;
+}

package/src/resources/sandbox/connections/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export {
+  AccountCreateResponse,
+  AccountUpdateResponse,
+  AccountCreateParams,
+  AccountUpdateParams,
+  Accounts,
+} from './accounts';
+export { ConnectionCreateResponse, ConnectionCreateParams, Connections } from './connections';

package/src/resources/sandbox/directory.ts

@@ -0,0 +1,210 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as DirectoryAPI from "./directory";
+import * as HRISAPI from "../hris/hris";
+
+export class Directory extends APIResource {
+  /**
+   * Add new individuals to a sandbox company
+   */
+  create(
+    body: DirectoryCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DirectoryCreateResponse> {
+    return this._client.post('/sandbox/directory', { body, ...options });
+  }
+}
+
+/**
+ * The individuals which were created
+ */
+export type DirectoryCreateResponse = Array<unknown>;
+
+export type DirectoryCreateParams = Array<DirectoryCreateParams.Body>;
+
+export namespace DirectoryCreateParams {
+  export interface Body {
+    /**
+     * Worker's compensation classification code for this employee
+     */
+    class_code?: string | null;
+
+    /**
+     * Custom fields for the individual. These are fields which are defined by the
+     * employer in the system. Custom fields are not currently supported for assisted
+     * connections.
+     */
+    custom_fields?: Array<Body.CustomField>;
+
+    /**
+     * The department object.
+     */
+    department?: Body.Department | null;
+
+    dob?: string | null;
+
+    emails?: Array<Body.Email> | null;
+
+    /**
+     * The employment object.
+     */
+    employment?: Body.Employment | null;
+
+    /**
+     * Social Security Number of the individual in **encrypted** format. This field is
+     * only available with the `ssn` scope enabled and the
+     * `options: { include: ['ssn'] }` param set in the body.
+     */
+    encrypted_ssn?: string | null;
+
+    end_date?: 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.
+     */
+    first_name?: string | null;
+
+    /**
+     * The gender of the individual.
+     */
+    gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
+
+    /**
+     * The employee's income as reported by the provider. This may not always be
+     * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+     * depending on what information the provider returns.
+     */
+    income?: HRISAPI.Income | null;
+
+    /**
+     * The array of income history.
+     */
+    income_history?: Array<HRISAPI.Income | null> | null;
+
+    /**
+     * `true` if the individual an an active employee or contractor at the company.
+     */
+    is_active?: boolean | null;
+
+    /**
+     * The legal last name of the individual.
+     */
+    last_name?: string | null;
+
+    location?: HRISAPI.Location | null;
+
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    manager?: Body.Manager | null;
+
+    /**
+     * The legal middle name of the individual.
+     */
+    middle_name?: string | null;
+
+    phone_numbers?: Array<Body.PhoneNumber | null> | null;
+
+    /**
+     * The preferred name of the individual.
+     */
+    preferred_name?: string | null;
+
+    residence?: HRISAPI.Location | null;
+
+    /**
+     * The source system's unique employment identifier for this individual
+     */
+    source_id?: string;
+
+    /**
+     * Social Security Number of the individual. This field is only available with the
+     * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+     * body.
+     */
+    ssn?: string | null;
+
+    start_date?: string | null;
+
+    /**
+     * The current title of the individual.
+     */
+    title?: string | null;
+  }
+
+  export namespace Body {
+    export interface CustomField {
+      name?: string | null;
+
+      value?: unknown;
+    }
+
+    /**
+     * The department object.
+     */
+    export interface Department {
+      /**
+       * The name of the department associated with the individual.
+       */
+      name?: string | null;
+    }
+
+    export interface Email {
+      data?: string;
+
+      type?: 'work' | 'personal';
+    }
+
+    /**
+     * The employment object.
+     */
+    export interface Employment {
+      /**
+       * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+       */
+      subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+
+      /**
+       * The main employment type of the individual.
+       */
+      type?: 'employee' | 'contractor' | null;
+    }
+
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    export interface Manager {
+      /**
+       * A stable Finch `id` (UUID v4) for an individual in the company.
+       */
+      id?: string;
+    }
+
+    export interface PhoneNumber {
+      data?: string;
+
+      type?: 'work' | 'personal';
+    }
+  }
+}
+
+export namespace Directory {
+  export import DirectoryCreateResponse = DirectoryAPI.DirectoryCreateResponse;
+  export import DirectoryCreateParams = DirectoryAPI.DirectoryCreateParams;
+}