@tryfinch/finch-api 6.27.0 → 6.29.0

package/src/resources/hris/individuals.ts

@@ -1,14 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as HRISAPI from './hris';
-import { ResponsesPage } from '../../pagination';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "./hris.js";
+import { ResponsesPage } from "../../pagination.js";
 
 export class Individuals extends APIResource {
   /**
    * Read individual data, excluding income and employment data
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const individualResponse of client.hris.individuals.retrieveMany()) {
+   *   // ...
+   * }
+   * ```
    */
   retrieveMany(
     body?: IndividualRetrieveManyParams,
@@ -32,95 +40,109 @@ export class Individuals extends APIResource {
 
 export class IndividualResponsesPage extends ResponsesPage<IndividualResponse> {}
 
-export interface Individual {
-  /**
-   * A stable Finch `id` (UUID v4) for an individual in the company.
-   */
-  id?: string;
-
-  dob?: string | null;
+export type Individual = Individual.UnionMember0 | Individual.BatchError;
 
-  emails?: Array<Individual.Email> | 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;
-
-  /**
-   * 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 legal last name of the individual.
-   */
-  last_name?: string | null;
-
-  /**
-   * The legal middle name of the individual.
-   */
-  middle_name?: string | null;
+export namespace Individual {
+  export interface UnionMember0 {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id: string;
+
+    dob: 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 legal last name of the individual.
+     */
+    last_name: string | null;
+
+    /**
+     * The legal middle name of the individual.
+     */
+    middle_name: string | null;
+
+    phone_numbers: Array<UnionMember0.PhoneNumber | null> | null;
+
+    /**
+     * The preferred name of the individual.
+     */
+    preferred_name: string | null;
+
+    residence: HRISAPI.Location | null;
+
+    emails?: Array<UnionMember0.Email> | 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;
+
+    /**
+     * 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.
+     * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
+     */
+    ssn?: string | null;
+  }
 
-  phone_numbers?: Array<Individual.PhoneNumber | null> | null;
+  export namespace UnionMember0 {
+    export interface PhoneNumber {
+      data: string | null;
 
-  /**
-   * The preferred name of the individual.
-   */
-  preferred_name?: string | null;
+      type: 'work' | 'personal' | null;
+    }
 
-  residence?: HRISAPI.Location | null;
+    export interface Email {
+      data: 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.
-   * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
-   */
-  ssn?: string | null;
-}
+      type: 'work' | 'personal' | null;
+    }
+  }
 
-export namespace Individual {
-  export interface Email {
-    data?: string;
+  export interface BatchError {
+    code: number;
 
-    type?: 'work' | 'personal' | null;
-  }
+    message: string;
 
-  export interface PhoneNumber {
-    data?: string | null;
+    name: string;
 
-    type?: 'work' | 'personal' | null;
+    finch_code?: string;
   }
 }
 
 export interface IndividualResponse {
-  body?: Individual;
+  body: Individual;
 
-  code?: number;
+  code: number;
 
-  individual_id?: string;
+  individual_id: string;
 }
 
 export interface IndividualRetrieveManyParams {

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

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as Shared from '../shared';
-import * as HRISAPI from './hris';
-import * as BenefitsAPI from './benefits/benefits';
-import { ResponsesPage } from '../../pagination';
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as Shared from "../shared.js";
+import * as HRISAPI from "./hris.js";
+import * as BenefitsAPI from "./benefits/benefits.js";
+import { ResponsesPage } from "../../pagination.js";
 
 export class PayStatements extends APIResource {
   /**
@@ -13,6 +13,22 @@ export class PayStatements extends APIResource {
    *
    * Deduction and contribution types are supported by the payroll systems that
    * supports Benefits.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const payStatementResponse of client.hris.payStatements.retrieveMany(
+   *   {
+   *     requests: [
+   *       {
+   *         payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *       },
+   *     ],
+   *   },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   retrieveMany(
     body: PayStatementRetrieveManyParams,
@@ -53,7 +69,7 @@ export interface PayStatement {
   /**
    * The payment method.
    */
-  payment_method?: 'check' | 'direct_deposit' | null;
+  payment_method?: 'check' | 'direct_deposit' | 'other' | null;
 
   /**
    * The array of taxes objects associated with this pay statement.

package/src/resources/hris/payments.ts

@@ -1,13 +1,24 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as HRISAPI from './hris';
-import { SinglePage } from '../../pagination';
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "./hris.js";
+import { SinglePage } from "../../pagination.js";
 
 export class Payments extends APIResource {
   /**
    * Read payroll and contractor related payments by the company.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const payment of client.hris.payments.list({
+   *   end_date: '2021-01-01',
+   *   start_date: '2021-01-01',
+   * })) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: PaymentListParams,

package/src/resources/hris.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './hris/index';
+export * from "./hris/index.js";

package/src/resources/index.ts

@@ -1,19 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './shared';
-export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens';
-export { Account, type DisconnectResponse, type Introspection } from './account';
-export { Connect } from './connect/connect';
-export { HRIS, type Income, type Location, type Money } from './hris/hris';
-export { Jobs } from './jobs/jobs';
-export { Payroll } from './payroll/payroll';
-export { ProvidersSinglePage, Providers, type Provider } from './providers';
+export * from "./shared.js";
+export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from "./access-tokens.js";
+export { Account, type DisconnectResponse, type Introspection } from "./account.js";
+export { Connect } from "./connect/connect.js";
+export { HRIS, type Income, type Location, type Money } from "./hris/hris.js";
+export { Jobs } from "./jobs/jobs.js";
+export { Payroll } from "./payroll/payroll.js";
+export { ProvidersSinglePage, Providers, type Provider } from "./providers.js";
 export {
   RequestForwarding,
   type RequestForwardingForwardResponse,
   type RequestForwardingForwardParams,
-} from './request-forwarding';
-export { Sandbox } from './sandbox/sandbox';
+} from "./request-forwarding.js";
+export { Sandbox } from "./sandbox/sandbox.js";
 export {
   Webhooks,
   type AccountUpdateEvent,
@@ -26,4 +26,4 @@ export {
   type PayStatementEvent,
   type PaymentEvent,
   type WebhookEvent,
-} from './webhooks';
+} from "./webhooks.js";

package/src/resources/jobs/automated.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
 
 export class Automated extends APIResource {
   /**

package/src/resources/jobs/index.ts

@@ -7,6 +7,6 @@ export {
   type AutomatedListResponse,
   type AutomatedCreateParams,
   type AutomatedListParams,
-} from './automated';
-export { Jobs } from './jobs';
-export { Manual, type ManualAsyncJob } from './manual';
+} from "./automated.js";
+export { Jobs } from "./jobs.js";
+export { Manual, type ManualAsyncJob } from "./manual.js";

package/src/resources/jobs/jobs.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as AutomatedAPI from './automated';
+import { APIResource } from "../../resource.js";
+import * as AutomatedAPI from "./automated.js";
 import {
   Automated,
   AutomatedAsyncJob,
@@ -9,9 +9,9 @@ import {
   AutomatedCreateResponse,
   AutomatedListParams,
   AutomatedListResponse,
-} from './automated';
-import * as ManualAPI from './manual';
-import { Manual, ManualAsyncJob } from './manual';
+} from "./automated.js";
+import * as ManualAPI from "./manual.js";
+import { Manual, ManualAsyncJob } from "./manual.js";
 
 export class Jobs extends APIResource {
   automated: AutomatedAPI.Automated = new AutomatedAPI.Automated(this._client);

package/src/resources/jobs/manual.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
 
 export class Manual extends APIResource {
   /**

package/src/resources/jobs.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './jobs/index';
+export * from "./jobs/index.js";

package/src/resources/payroll/index.ts

@@ -6,5 +6,5 @@ export {
   type PayGroupRetrieveResponse,
   type PayGroupListResponse,
   type PayGroupListParams,
-} from './pay-groups';
-export { Payroll } from './payroll';
+} from "./pay-groups.js";
+export { Payroll } from "./payroll.js";

package/src/resources/payroll/pay-groups.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import { SinglePage } from '../../pagination';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import { SinglePage } from "../../pagination.js";
 
 export class PayGroups extends APIResource {
   /**

package/src/resources/payroll/payroll.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as PayGroupsAPI from './pay-groups';
+import { APIResource } from "../../resource.js";
+import * as PayGroupsAPI from "./pay-groups.js";
 import {
   PayGroupListParams,
   PayGroupListResponse,
   PayGroupListResponsesSinglePage,
   PayGroupRetrieveResponse,
   PayGroups,
-} from './pay-groups';
+} from "./pay-groups.js";
 
 export class Payroll extends APIResource {
   payGroups: PayGroupsAPI.PayGroups = new PayGroupsAPI.PayGroups(this._client);

package/src/resources/payroll.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './payroll/index';
+export * from "./payroll/index.js";

package/src/resources/providers.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
-import * as BenefitsAPI from './hris/benefits/benefits';
-import { SinglePage } from '../pagination';
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+import * as BenefitsAPI from "./hris/benefits/benefits.js";
+import { SinglePage } from "../pagination.js";
 
 export class Providers extends APIResource {
   /**

package/src/resources/request-forwarding.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
 
 export class RequestForwarding extends APIResource {
   /**
@@ -9,6 +9,16 @@ export class RequestForwarding extends APIResource {
    * 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.
+   *
+   * @example
+   * ```ts
+   * const response = await client.requestForwarding.forward({
+   *   method: 'POST',
+   *   route: '/people/search',
+   *   headers: { 'content-type': 'application/json' },
+   *   params: { showInactive: true, humanReadable: true },
+   * });
+   * ```
    */
   forward(
     body: RequestForwardingForwardParams,

package/src/resources/sandbox/company.ts

@@ -1,12 +1,35 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as HRISAPI from '../hris/hris';
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "../hris/hris.js";
 
 export class Company extends APIResource {
   /**
    * Update a sandbox company's data
+   *
+   * @example
+   * ```ts
+   * const company = await client.sandbox.company.update({
+   *   accounts: [{}],
+   *   departments: [{}],
+   *   ein: 'ein',
+   *   entity: {},
+   *   legal_name: 'legal_name',
+   *   locations: [
+   *     {
+   *       city: 'city',
+   *       country: 'country',
+   *       line1: 'line1',
+   *       line2: 'line2',
+   *       postal_code: 'postal_code',
+   *       state: 'state',
+   *     },
+   *   ],
+   *   primary_email: 'dev@stainless.com',
+   *   primary_phone_number: 'primary_phone_number',
+   * });
+   * ```
    */
   update(body: CompanyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<CompanyUpdateResponse> {
     return this._client.put('/sandbox/company', { body, ...options });

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

@@ -1,13 +1,22 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import { isRequestOptions } from '../../../core';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
+import { APIResource } from "../../../resource.js";
+import { isRequestOptions } from "../../../core.js";
+import * as Core from "../../../core.js";
+import * as Shared from "../../shared.js";
 
 export class Accounts extends APIResource {
   /**
    * Create a new account for an existing connection (company/provider pair)
+   *
+   * @example
+   * ```ts
+   * const account =
+   *   await client.sandbox.connections.accounts.create({
+   *     company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     provider_id: 'provider_id',
+   *   });
+   * ```
    */
   create(body: AccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<AccountCreateResponse> {
     return this._client.post('/sandbox/connections/accounts', { body, ...options });
@@ -16,6 +25,14 @@ export class Accounts extends APIResource {
   /**
    * Update an existing sandbox account. Change the connection status to understand
    * how the Finch API responds.
+   *
+   * @example
+   * ```ts
+   * const account =
+   *   await client.sandbox.connections.accounts.update({
+   *     connection_status: 'reauth',
+   *   });
+   * ```
    */
   update(body?: AccountUpdateParams, options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;
   update(options?: Core.RequestOptions): Core.APIPromise<AccountUpdateResponse>;

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

@@ -1,21 +1,28 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import * as Core from '../../../core';
-import * as AccountsAPI from './accounts';
+import { APIResource } from "../../../resource.js";
+import * as Core from "../../../core.js";
+import * as AccountsAPI from "./accounts.js";
 import {
   AccountCreateParams,
   AccountCreateResponse,
   AccountUpdateParams,
   AccountUpdateResponse,
   Accounts,
-} from './accounts';
+} from "./accounts.js";
 
 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
+   *
+   * @example
+   * ```ts
+   * const connection = await client.sandbox.connections.create({
+   *   provider_id: 'provider_id',
+   * });
+   * ```
    */
   create(
     body: ConnectionCreateParams,

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

@@ -6,5 +6,5 @@ export {
   type AccountUpdateResponse,
   type AccountCreateParams,
   type AccountUpdateParams,
-} from './accounts';
-export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections';
+} from "./accounts.js";
+export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from "./connections.js";

package/src/resources/sandbox/connections.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from './connections/index';
+export * from "./connections/index.js";

package/src/resources/sandbox/directory.ts

@@ -1,13 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as HRISAPI from '../hris/hris';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "../hris/hris.js";
 
 export class Directory extends APIResource {
   /**
    * Add new individuals to a sandbox company
+   *
+   * @example
+   * ```ts
+   * const directories = await client.sandbox.directory.create([
+   *   {},
+   * ]);
+   * ```
    */
   create(
     body?: DirectoryCreateParams,