@tryfinch/finch-api 6.31.0 → 7.0.0

package/src/resources/access-tokens.ts

@@ -1,25 +1,15 @@
 // 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 type { RequestOptions } from '../internal/request-options';
+import type { APIPromise } from '../core/api-promise';
+import { APIResource } from '../core/resource';
 
 export class AccessTokens extends APIResource {
   /**
    * Exchange the authorization code for an access token
-   *
-   * @example
-   * ```ts
-   * const createAccessTokenResponse =
-   *   await client.accessTokens.create({
-   *     code: '<your_authorization_code>',
-   *   });
-   * ```
-   */
-  create(
-    body: AccessTokenCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CreateAccessTokenResponse> {
-    const clientID = body.client_id || this._client.clientId;
+   */
+  create(body: AccessTokenCreateParams, options?: RequestOptions): APIPromise<CreateAccessTokenResponse> {
+    const clientID = body.client_id || this._client.clientID;
     if (!clientID)
       throw new Error(
         'client_id must be provided as an argument or with the FINCH_CLIENT_ID environment variable',
@@ -48,29 +38,17 @@ export class AccessTokens extends APIResource {
 
 export interface CreateAccessTokenResponse {
   /**
-   * The access token for the connection.
+   * The access token for the connection
    */
   access_token: string;
 
-  /**
-   * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
-   * of this account ID.
-   */
-  account_id: string;
-
   /**
    * The type of application associated with a token.
    */
-  client_type: 'production' | 'development' | 'sandbox';
-
-  /**
-   * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
-   * of this company ID.
-   */
-  company_id: string;
+  client_type: 'development' | 'production' | 'sandbox';
 
   /**
-   * The Finch UUID of the connection associated with the `access_token`.
+   * The Finch UUID of the connection associated with the `access_token`
    */
   connection_id: string;
 
@@ -80,37 +58,66 @@ export interface CreateAccessTokenResponse {
    * - `provider` - connection to an external provider
    * - `finch` - finch-generated data.
    */
-  connection_type: 'provider' | 'finch';
+  connection_type: 'finch' | 'provider';
 
   /**
-   * An array of the authorized products associated with the `access_token`.
+   * An array of entity IDs that can be accessed with this access token
+   */
+  entity_ids: Array<string>;
+
+  /**
+   * An array of the authorized products associated with the `access_token`
    */
   products: Array<string>;
 
   /**
-   * The ID of the provider associated with the `access_token`.
+   * The ID of the provider associated with the `access_token`
    */
   provider_id: string;
 
   /**
-   * The ID of your customer you provided to Finch when a connect session was created
-   * for this connection.
+   * The RFC 8693 token type (Finch uses `bearer` tokens)
    */
-  customer_id?: string | null;
+  token_type: string;
 
   /**
-   * The RFC 8693 token type (Finch uses `bearer` tokens)
+   * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
+   * of this account ID
    */
-  token_type?: string;
+  account_id?: string;
+
+  /**
+   * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
+   * of this company ID
+   */
+  company_id?: string;
+
+  /**
+   * The ID of your customer you provided to Finch when a connect session was created
+   * for this connection
+   */
+  customer_id?: string | null;
 }
 
 export interface AccessTokenCreateParams {
+  /**
+   * The authorization code received from the authorization server
+   */
   code: string;
 
+  /**
+   * The client ID for your application
+   */
   client_id?: string;
 
+  /**
+   * The client secret for your application
+   */
   client_secret?: string;
 
+  /**
+   * The redirect URI used in the authorization request (optional)
+   */
   redirect_uri?: string;
 }
 

package/src/resources/account.ts

@@ -1,64 +1,51 @@
 // 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 Shared from "./shared.js";
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
 
 export class Account extends APIResource {
   /**
    * Disconnect one or more `access_token`s from your application.
    */
-  disconnect(options?: Core.RequestOptions): Core.APIPromise<DisconnectResponse> {
+  disconnect(options?: RequestOptions): APIPromise<DisconnectResponse> {
     return this._client.post('/disconnect', options);
   }
 
   /**
    * Read account information associated with an `access_token`
    */
-  introspect(options?: Core.RequestOptions): Core.APIPromise<Introspection> {
+  introspect(options?: RequestOptions): APIPromise<Introspection> {
     return this._client.get('/introspect', options);
   }
 }
 
 export interface DisconnectResponse {
   /**
-   * If the request is successful, Finch will return “success” (HTTP 200 status).
+   * If the request is successful, Finch will return "success" (HTTP 200 status).
    */
   status: string;
 }
 
 export interface Introspection {
   /**
-   * The Finch UUID of the token being introspected.
+   * The Finch UUID of the token being introspected
    */
   id: string;
 
   /**
-   * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
-   * connection instead of this account ID.
-   */
-  account_id: string;
-
-  authentication_methods: Array<Introspection.AuthenticationMethod>;
-
-  /**
-   * The client ID of the application associated with the `access_token`.
+   * The client ID of the application associated with the `access_token`
    */
   client_id: string;
 
   /**
    * The type of application associated with a token.
    */
-  client_type: 'production' | 'development' | 'sandbox';
-
-  /**
-   * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
-   * connection instead of this company ID.
-   */
-  company_id: string;
+  client_type: 'development' | 'production' | 'sandbox';
 
   /**
-   * The Finch UUID of the connection associated with the `access_token`.
+   * The Finch UUID of the connection associated with the `access_token`
    */
   connection_id: string;
 
@@ -70,87 +57,129 @@ export interface Introspection {
    * - `provider` - connection to an external provider
    * - `finch` - finch-generated data.
    */
-  connection_type: 'provider' | 'finch';
+  connection_type: 'finch' | 'provider';
+
+  /**
+   * An array of the authorized products associated with the `access_token`.
+   */
+  products: Array<string>;
+
+  /**
+   * The ID of the provider associated with the `access_token`.
+   */
+  provider_id: string;
+
+  /**
+   * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
+   * connection instead of this account ID
+   */
+  account_id?: string;
+
+  authentication_methods?: Array<Introspection.AuthenticationMethod>;
+
+  /**
+   * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
+   * connection instead of this company ID
+   */
+  company_id?: string;
 
   /**
    * The email of your customer you provided to Finch when a connect session was
-   * created for this connection.
+   * created for this connection
    */
-  customer_email: string | null;
+  customer_email?: string | null;
 
   /**
    * The ID of your customer you provided to Finch when a connect session was created
-   * for this connection.
+   * for this connection
    */
-  customer_id: string | null;
+  customer_id?: string | null;
 
   /**
    * The name of your customer you provided to Finch when a connect session was
-   * created for this connection.
+   * created for this connection
    */
-  customer_name: string | null;
+  customer_name?: string | null;
+
+  /**
+   * Array of detailed entity information for each connected account in multi-account
+   * mode
+   */
+  entities?: Array<Introspection.Entity>;
 
   /**
    * Whether the connection associated with the `access_token` uses the Assisted
    * Connect Flow. (`true` if using Assisted Connect, `false` if connection is
    * automated)
    */
-  manual: boolean;
+  manual?: boolean;
 
   /**
    * @deprecated [DEPRECATED] Use `provider_id` to identify the provider instead of
    * this payroll provider ID.
    */
-  payroll_provider_id: string;
-
-  /**
-   * An array of the authorized products associated with the `access_token`.
-   */
-  products: Array<string>;
-
-  /**
-   * The ID of the provider associated with the `access_token`.
-   */
-  provider_id: string;
+  payroll_provider_id?: string;
 
   /**
    * The account username used for login associated with the `access_token`.
    */
-  username: string;
+  username?: string | null;
 }
 
 export namespace Introspection {
-  export interface AuthenticationMethod {
-    connection_status?: AuthenticationMethod.ConnectionStatus;
+  export interface ConnectionStatus {
+    status: Shared.ConnectionStatusType;
 
     /**
-     * An array of the authorized products associated with the `access_token`.
+     * The datetime when the connection was last successfully synced
      */
-    products?: Array<string>;
+    last_successful_sync?: (string & {}) | string | null;
+
+    message?: string;
+  }
+
+  export interface AuthenticationMethod {
+    /**
+     * The type of authentication method
+     */
+    type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth';
+
+    connection_status?: AuthenticationMethod.ConnectionStatus;
 
     /**
-     * The type of authentication method.
+     * An array of the authorized products associated with the `access_token`
      */
-    type?: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth';
+    products?: Array<string>;
   }
 
   export namespace AuthenticationMethod {
     export interface ConnectionStatus {
-      message?: string;
+      status: Shared.ConnectionStatusType;
 
-      status?: Shared.ConnectionStatusType;
+      /**
+       * The datetime when the connection was last successfully synced
+       */
+      last_successful_sync?: (string & {}) | string | null;
+
+      message?: string;
     }
   }
 
-  export interface ConnectionStatus {
+  export interface Entity {
     /**
-     * The datetime when the connection was last successfully synced.
+     * The connection account ID for this entity
      */
-    last_successful_sync?: string;
+    id: string;
 
-    message?: string;
+    /**
+     * The name of the entity (payroll provider company name)
+     */
+    name: string | null;
 
-    status?: Shared.ConnectionStatusType;
+    /**
+     * The source ID of the entity
+     */
+    source_id: string | null;
   }
 }
 

package/src/resources/connect/connect.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as SessionsAPI from "./sessions.js";
+import { APIResource } from '../../core/resource';
+import * as SessionsAPI from './sessions';
 import {
   SessionNewParams,
   SessionNewResponse,
   SessionReauthenticateParams,
   SessionReauthenticateResponse,
   Sessions,
-} from "./sessions.js";
+} from './sessions';
 
 export class Connect extends APIResource {
   sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);

package/src/resources/connect/index.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Connect } from "./connect.js";
+export { Connect } from './connect';
 export {
   Sessions,
   type SessionNewResponse,
   type SessionReauthenticateResponse,
   type SessionNewParams,
   type SessionReauthenticateParams,
-} from "./sessions.js";
+} from './sessions';

package/src/resources/connect/sessions.ts

@@ -1,13 +1,14 @@
 // 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 { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Sessions extends APIResource {
   /**
    * Create a new connect session for an employer
    */
-  new(body: SessionNewParams, options?: Core.RequestOptions): Core.APIPromise<SessionNewResponse> {
+  new(body: SessionNewParams, options?: RequestOptions): APIPromise<SessionNewResponse> {
     return this._client.post('/connect/sessions', { body, ...options });
   }
 
@@ -16,8 +17,8 @@ export class Sessions extends APIResource {
    */
   reauthenticate(
     body: SessionReauthenticateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<SessionReauthenticateResponse> {
+    options?: RequestOptions,
+  ): APIPromise<SessionReauthenticateResponse> {
     return this._client.post('/connect/sessions/reauthenticate', { body, ...options });
   }
 }
@@ -47,45 +48,78 @@ export interface SessionReauthenticateResponse {
 }
 
 export interface SessionNewParams {
+  /**
+   * Unique identifier for the customer
+   */
   customer_id: string;
 
+  /**
+   * Name of the customer
+   */
   customer_name: string;
 
+  /**
+   * The Finch products to request access to
+   */
   products: Array<
+    | 'benefits'
     | 'company'
+    | 'deduction'
     | 'directory'
-    | 'individual'
+    | 'documents'
     | 'employment'
+    | 'individual'
     | 'payment'
     | 'pay_statement'
-    | 'benefits'
     | 'ssn'
-    | 'deduction'
-    | 'documents'
   >;
 
+  /**
+   * Email address of the customer
+   */
   customer_email?: string | null;
 
+  /**
+   * Integration configuration for the connect session
+   */
   integration?: SessionNewParams.Integration | null;
 
+  /**
+   * Enable manual authentication mode
+   */
   manual?: boolean | null;
 
   /**
-   * The number of minutes until the session expires (defaults to 43,200, which is 30
-   * days)
+   * The number of minutes until the session expires (defaults to 129,600, which is
+   * 90 days)
    */
   minutes_to_expire?: number | null;
 
+  /**
+   * The URI to redirect to after the Connect flow is completed
+   */
   redirect_uri?: string | null;
 
+  /**
+   * Sandbox mode for testing
+   */
   sandbox?: 'finch' | 'provider' | null;
 }
 
 export namespace SessionNewParams {
+  /**
+   * Integration configuration for the connect session
+   */
   export interface Integration {
+    /**
+     * The provider to integrate with
+     */
+    provider: string;
+
+    /**
+     * The authentication method to use
+     */
     auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token' | null;
-
-    provider?: string | null;
   }
 }
 
@@ -99,22 +133,22 @@ export interface SessionReauthenticateParams {
    * The number of minutes until the session expires (defaults to 43,200, which is 30
    * days)
    */
-  minutes_to_expire?: number | null;
+  minutes_to_expire?: number;
 
   /**
    * The products to request access to (optional for reauthentication)
    */
   products?: Array<
+    | 'benefits'
     | 'company'
+    | 'deduction'
     | 'directory'
-    | 'individual'
+    | 'documents'
     | 'employment'
+    | 'individual'
     | 'payment'
     | 'pay_statement'
-    | 'benefits'
     | 'ssn'
-    | 'deduction'
-    | 'documents'
   > | null;
 
   /**

package/src/resources/connect.ts

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