@tryfinch/finch-api 5.14.3 → 5.16.0

package/resources/sandbox/sandbox.js

@@ -0,0 +1,58 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sandbox = void 0;
+const resource_1 = require("@tryfinch/finch-api/resource");
+const CompanyAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/company"));
+const DirectoryAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/directory"));
+const EmploymentAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/employment"));
+const IndividualAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/individual"));
+const PaymentAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/payment"));
+const ConnectionsAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/connections/connections"));
+const JobsAPI = __importStar(require("@tryfinch/finch-api/resources/sandbox/jobs/jobs"));
+class Sandbox extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.connections = new ConnectionsAPI.Connections(this._client);
+        this.company = new CompanyAPI.Company(this._client);
+        this.directory = new DirectoryAPI.Directory(this._client);
+        this.individual = new IndividualAPI.Individual(this._client);
+        this.employment = new EmploymentAPI.Employment(this._client);
+        this.payment = new PaymentAPI.Payment(this._client);
+        this.jobs = new JobsAPI.Jobs(this._client);
+    }
+}
+exports.Sandbox = Sandbox;
+(function (Sandbox) {
+    Sandbox.Connections = ConnectionsAPI.Connections;
+    Sandbox.Company = CompanyAPI.Company;
+    Sandbox.Directory = DirectoryAPI.Directory;
+    Sandbox.Individual = IndividualAPI.Individual;
+    Sandbox.Employment = EmploymentAPI.Employment;
+    Sandbox.Payment = PaymentAPI.Payment;
+    Sandbox.Jobs = JobsAPI.Jobs;
+})(Sandbox = exports.Sandbox || (exports.Sandbox = {}));
+//# sourceMappingURL=sandbox.js.map

package/resources/sandbox/sandbox.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandbox.js","sourceRoot":"","sources":["../../src/resources/sandbox/sandbox.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;;;;;;;;;;;;;AAErD,2DAA2D;AAC3D,0FAA4E;AAC5E,8FAAgF;AAChF,gGAAkF;AAClF,gGAAkF;AAClF,0FAA4E;AAC5E,8GAAgG;AAChG,yFAA2E;AAE3E,MAAa,OAAQ,SAAQ,sBAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AARD,0BAQC;AAED,WAAiB,OAAO;IACR,mBAAW,GAAG,cAAc,CAAC,WAAW,CAAC;IAGzC,eAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAG7B,iBAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAGnC,kBAAU,GAAG,aAAa,CAAC,UAAU,CAAC;IAGtC,kBAAU,GAAG,aAAa,CAAC,UAAU,CAAC;IAGtC,eAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAG7B,YAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AACpC,CAAC,EApBgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAoBvB"}

package/resources/sandbox/sandbox.mjs

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '@tryfinch/finch-api/resource';
+import * as CompanyAPI from '@tryfinch/finch-api/resources/sandbox/company';
+import * as DirectoryAPI from '@tryfinch/finch-api/resources/sandbox/directory';
+import * as EmploymentAPI from '@tryfinch/finch-api/resources/sandbox/employment';
+import * as IndividualAPI from '@tryfinch/finch-api/resources/sandbox/individual';
+import * as PaymentAPI from '@tryfinch/finch-api/resources/sandbox/payment';
+import * as ConnectionsAPI from '@tryfinch/finch-api/resources/sandbox/connections/connections';
+import * as JobsAPI from '@tryfinch/finch-api/resources/sandbox/jobs/jobs';
+export class Sandbox extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.connections = new ConnectionsAPI.Connections(this._client);
+        this.company = new CompanyAPI.Company(this._client);
+        this.directory = new DirectoryAPI.Directory(this._client);
+        this.individual = new IndividualAPI.Individual(this._client);
+        this.employment = new EmploymentAPI.Employment(this._client);
+        this.payment = new PaymentAPI.Payment(this._client);
+        this.jobs = new JobsAPI.Jobs(this._client);
+    }
+}
+(function (Sandbox) {
+    Sandbox.Connections = ConnectionsAPI.Connections;
+    Sandbox.Company = CompanyAPI.Company;
+    Sandbox.Directory = DirectoryAPI.Directory;
+    Sandbox.Individual = IndividualAPI.Individual;
+    Sandbox.Employment = EmploymentAPI.Employment;
+    Sandbox.Payment = PaymentAPI.Payment;
+    Sandbox.Jobs = JobsAPI.Jobs;
+})(Sandbox || (Sandbox = {}));
+//# sourceMappingURL=sandbox.mjs.map

package/resources/sandbox/sandbox.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandbox.mjs","sourceRoot":"","sources":["../../src/resources/sandbox/sandbox.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;OACnD,KAAK,UAAU,MAAM,+CAA+C;OACpE,KAAK,YAAY,MAAM,iDAAiD;OACxE,KAAK,aAAa,MAAM,kDAAkD;OAC1E,KAAK,aAAa,MAAM,kDAAkD;OAC1E,KAAK,UAAU,MAAM,+CAA+C;OACpE,KAAK,cAAc,MAAM,+DAA+D;OACxF,KAAK,OAAO,MAAM,iDAAiD;AAE1E,MAAM,OAAO,OAAQ,SAAQ,WAAW;IAAxC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7E,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,eAAU,GAA6B,IAAI,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClF,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnE,SAAI,GAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;CAAA;AAED,WAAiB,OAAO;IACR,mBAAW,GAAG,cAAc,CAAC,WAAW,CAAC;IAGzC,eAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAG7B,iBAAS,GAAG,YAAY,CAAC,SAAS,CAAC;IAGnC,kBAAU,GAAG,aAAa,CAAC,UAAU,CAAC;IAGtC,kBAAU,GAAG,aAAa,CAAC,UAAU,CAAC;IAGtC,eAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAG7B,YAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AACpC,CAAC,EApBgB,OAAO,KAAP,OAAO,QAoBvB"}

package/resources/shared.d.ts

@@ -1,3 +1,4 @@
+export type ConnectionStatusType = 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth';
 /**
  * - `supported`: This operation is supported by both the provider and Finch
  *

package/resources/shared.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,wBAAwB,GACxB,2BAA2B,GAC3B,oBAAoB,CAAC;AAEzB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,YAAY,GACZ,WAAW,GACX,wBAAwB,GACxB,mBAAmB,GACnB,QAAQ,CAAC;AAEb;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,wBAAwB,GACxB,2BAA2B,GAC3B,oBAAoB,CAAC;AAEzB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/src/_shims/index.d.ts

@@ -65,7 +65,7 @@ export type ReadableStream = SelectType<manual.ReadableStream, auto.ReadableStre
 // @ts-ignore
 export const ReadableStream: SelectType<typeof manual.ReadableStream, typeof auto.ReadableStream>;
 
-export function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+export function getMultipartRequestOptions<T = Record<string, unknown>>(
   form: FormData,
   opts: RequestOptions<T>,
 ): Promise<RequestOptions<T>>;

package/src/_shims/node-runtime.ts

@@ -43,7 +43,7 @@ async function fileFromPath(path: string, ...args: any[]): Promise<File> {
 const defaultHttpAgent: Agent = new KeepAliveAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
 const defaultHttpsAgent: Agent = new KeepAliveAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
 
-async function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+async function getMultipartRequestOptions<T = Record<string, unknown>>(
   form: fd.FormData,
   opts: RequestOptions<T>,
 ): Promise<RequestOptions<T>> {

package/src/_shims/registry.ts

@@ -13,7 +13,7 @@ export interface Shims {
   Blob: any;
   File: any;
   ReadableStream: any;
-  getMultipartRequestOptions: <T extends {} = Record<string, unknown>>(
+  getMultipartRequestOptions: <T = Record<string, unknown>>(
     form: Shims['FormData'],
     opts: RequestOptions<T>,
   ) => Promise<RequestOptions<T>>;

package/src/_shims/web-runtime.ts

@@ -84,7 +84,7 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
           }
         }
       ),
-    getMultipartRequestOptions: async <T extends {} = Record<string, unknown>>(
+    getMultipartRequestOptions: async <T = Record<string, unknown>>(
       // @ts-ignore
       form: FormData,
       opts: RequestOptions<T>,

package/src/core.ts

@@ -208,27 +208,27 @@ export abstract class APIClient {
     return `stainless-node-retry-${uuid4()}`;
   }
 
-  get<Req extends {}, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
+  get<Req, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
     return this.methodRequest('get', path, opts);
   }
 
-  post<Req extends {}, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
+  post<Req, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
     return this.methodRequest('post', path, opts);
   }
 
-  patch<Req extends {}, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
+  patch<Req, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
     return this.methodRequest('patch', path, opts);
   }
 
-  put<Req extends {}, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
+  put<Req, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
     return this.methodRequest('put', path, opts);
   }
 
-  delete<Req extends {}, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
+  delete<Req, Rsp>(path: string, opts?: PromiseOrValue<RequestOptions<Req>>): APIPromise<Rsp> {
     return this.methodRequest('delete', path, opts);
   }
 
-  private methodRequest<Req extends {}, Rsp>(
+  private methodRequest<Req, Rsp>(
     method: HTTPMethod,
     path: string,
     opts?: PromiseOrValue<RequestOptions<Req>>,
@@ -260,9 +260,7 @@ export abstract class APIClient {
     return null;
   }
 
-  buildRequest<Req extends {}>(
-    options: FinalRequestOptions<Req>,
-  ): { req: RequestInit; url: string; timeout: number } {
+  buildRequest<Req>(options: FinalRequestOptions<Req>): { req: RequestInit; url: string; timeout: number } {
     const { method, path, query, headers: headers = {} } = options;
 
     const body =
@@ -292,18 +290,7 @@ export abstract class APIClient {
       headers[this.idempotencyHeader] = options.idempotencyKey;
     }
 
-    const reqHeaders: Record<string, string> = {
-      ...(contentLength && { 'Content-Length': contentLength }),
-      ...this.defaultHeaders(options),
-      ...headers,
-    };
-    // let builtin fetch set the Content-Type for multipart bodies
-    if (isMultipartBody(options.body) && shimsKind !== 'node') {
-      delete reqHeaders['Content-Type'];
-    }
-
-    // Strip any headers being explicitly omitted with null
-    Object.keys(reqHeaders).forEach((key) => reqHeaders[key] === null && delete reqHeaders[key]);
+    const reqHeaders = this.buildHeaders({ options, headers, contentLength });
 
     const req: RequestInit = {
       method,
@@ -315,9 +302,35 @@ export abstract class APIClient {
       signal: options.signal ?? null,
     };
 
+    return { req, url, timeout };
+  }
+
+  private buildHeaders({
+    options,
+    headers,
+    contentLength,
+  }: {
+    options: FinalRequestOptions;
+    headers: Record<string, string | null | undefined>;
+    contentLength: string | null | undefined;
+  }): Record<string, string> {
+    const reqHeaders: Record<string, string> = {};
+    if (contentLength) {
+      reqHeaders['content-length'] = contentLength;
+    }
+
+    const defaultHeaders = this.defaultHeaders(options);
+    applyHeadersMut(reqHeaders, defaultHeaders);
+    applyHeadersMut(reqHeaders, headers);
+
+    // let builtin fetch set the Content-Type for multipart bodies
+    if (isMultipartBody(options.body) && shimsKind !== 'node') {
+      delete reqHeaders['content-type'];
+    }
+
     this.validateHeaders(reqHeaders, headers);
 
-    return { req, url, timeout };
+    return reqHeaders;
   }
 
   /**
@@ -349,15 +362,15 @@ export abstract class APIClient {
     return APIError.generate(status, error, message, headers);
   }
 
-  request<Req extends {}, Rsp>(
+  request<Req, Rsp>(
     options: PromiseOrValue<FinalRequestOptions<Req>>,
     remainingRetries: number | null = null,
   ): APIPromise<Rsp> {
     return new APIPromise(this.makeRequest(options, remainingRetries));
   }
 
-  private async makeRequest(
-    optionsInput: PromiseOrValue<FinalRequestOptions>,
+  private async makeRequest<Req>(
+    optionsInput: PromiseOrValue<FinalRequestOptions<Req>>,
     retriesRemaining: number | null,
   ): Promise<APIResponseProps> {
     const options = await optionsInput;
@@ -419,7 +432,7 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req extends Record<string, unknown>>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined): string {
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
@@ -593,7 +606,7 @@ export abstract class AbstractPage<Item> implements AsyncIterable<Item> {
       );
     }
     const nextOptions = { ...this.options };
-    if ('params' in nextInfo) {
+    if ('params' in nextInfo && typeof nextOptions.query === 'object') {
       nextOptions.query = { ...nextOptions.query, ...nextInfo.params };
     } else if ('url' in nextInfo) {
       const params = [...Object.entries(nextOptions.query || {}), ...nextInfo.url.searchParams.entries()];
@@ -691,7 +704,7 @@ export type Headers = Record<string, string | null | undefined>;
 export type DefaultQuery = Record<string, string | undefined>;
 export type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
-export type RequestOptions<Req extends {} = Record<string, unknown> | Readable> = {
+export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> = {
   method?: HTTPMethod;
   path?: string;
   query?: Req | undefined;
@@ -728,7 +741,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   __binaryResponse: true,
 };
 
-export const isRequestOptions = (obj: unknown): obj is RequestOptions<Record<string, unknown> | Readable> => {
+export const isRequestOptions = (obj: unknown): obj is RequestOptions => {
   return (
     typeof obj === 'object' &&
     obj !== null &&
@@ -737,7 +750,7 @@ export const isRequestOptions = (obj: unknown): obj is RequestOptions<Record<str
   );
 };
 
-export type FinalRequestOptions<Req extends {} = Record<string, unknown> | Readable> = RequestOptions<Req> & {
+export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable> = RequestOptions<Req> & {
   method: HTTPMethod;
   path: string;
 };
@@ -939,14 +952,16 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 /**
  * Read an environment variable.
  *
+ * Trims beginning and trailing whitespace.
+ *
  * Will return undefined if the environment variable doesn't exist or cannot be accessed.
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof process !== 'undefined') {
-    return process.env?.[env] ?? undefined;
+    return process.env?.[env]?.trim() ?? undefined;
   }
   if (typeof Deno !== 'undefined') {
-    return Deno.env?.get?.(env);
+    return Deno.env?.get?.(env)?.trim();
   }
   return undefined;
 };
@@ -1004,6 +1019,28 @@ export function hasOwn(obj: Object, key: string): boolean {
   return Object.prototype.hasOwnProperty.call(obj, key);
 }
 
+/**
+ * Copies headers from "newHeaders" onto "targetHeaders",
+ * using lower-case for all properties,
+ * ignoring any keys with undefined values,
+ * and deleting any keys with null values.
+ */
+function applyHeadersMut(targetHeaders: Headers, newHeaders: Headers): void {
+  for (const k in newHeaders) {
+    if (!hasOwn(newHeaders, k)) continue;
+    const lowerKey = k.toLowerCase();
+    if (!lowerKey) continue;
+
+    const val = newHeaders[k];
+
+    if (val === null) {
+      delete targetHeaders[lowerKey];
+    } else if (val !== undefined) {
+      targetHeaders[lowerKey] = val;
+    }
+  }
+}
+
 export function debug(action: string, ...args: any[]) {
   if (typeof process !== 'undefined' && process.env['DEBUG'] === 'true') {
     console.log(`Finch:DEBUG:${action}`, ...args);

package/src/index.ts

@@ -20,6 +20,16 @@ export interface ClientOptions {
    */
   clientSecret?: string | null;
 
+  /**
+   * Defaults to process.env['FINCH_SANDBOX_CLIENT_ID'].
+   */
+  sandboxClientId?: string | null;
+
+  /**
+   * Defaults to process.env['FINCH_SANDBOX_CLIENT_SECRET'].
+   */
+  sandboxClientSecret?: string | null;
+
   /**
    * Defaults to process.env['FINCH_WEBHOOK_SECRET'].
    */
@@ -87,6 +97,8 @@ export class Finch extends Core.APIClient {
   accessToken: string | null;
   clientId: string | null;
   clientSecret: string | null;
+  sandboxClientId: string | null;
+  sandboxClientSecret: string | null;
   webhookSecret: string | null;
 
   private _options: ClientOptions;
@@ -97,6 +109,8 @@ export class Finch extends Core.APIClient {
    * @param {string | null} [opts.accessToken]
    * @param {string | null} [opts.clientId=process.env['FINCH_CLIENT_ID'] ?? null]
    * @param {string | null} [opts.clientSecret=process.env['FINCH_CLIENT_SECRET'] ?? null]
+   * @param {string | null} [opts.sandboxClientId=process.env['FINCH_SANDBOX_CLIENT_ID'] ?? null]
+   * @param {string | null} [opts.sandboxClientSecret=process.env['FINCH_SANDBOX_CLIENT_SECRET'] ?? null]
    * @param {string | null} [opts.webhookSecret=process.env['FINCH_WEBHOOK_SECRET'] ?? null]
    * @param {string} [opts.baseURL=process.env['FINCH_BASE_URL'] ?? https://api.tryfinch.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
@@ -111,6 +125,8 @@ export class Finch extends Core.APIClient {
     accessToken = null,
     clientId = Core.readEnv('FINCH_CLIENT_ID') ?? null,
     clientSecret = Core.readEnv('FINCH_CLIENT_SECRET') ?? null,
+    sandboxClientId = Core.readEnv('FINCH_SANDBOX_CLIENT_ID') ?? null,
+    sandboxClientSecret = Core.readEnv('FINCH_SANDBOX_CLIENT_SECRET') ?? null,
     webhookSecret = Core.readEnv('FINCH_WEBHOOK_SECRET') ?? null,
     ...opts
   }: ClientOptions = {}) {
@@ -118,9 +134,11 @@ export class Finch extends Core.APIClient {
       accessToken,
       clientId,
       clientSecret,
+      sandboxClientId,
+      sandboxClientSecret,
       webhookSecret,
       ...opts,
-      baseURL: baseURL ?? `https://api.tryfinch.com`,
+      baseURL: baseURL || `https://api.tryfinch.com`,
     };
 
     super({
@@ -135,15 +153,19 @@ export class Finch extends Core.APIClient {
     this.accessToken = accessToken;
     this.clientId = clientId;
     this.clientSecret = clientSecret;
+    this.sandboxClientId = sandboxClientId;
+    this.sandboxClientSecret = sandboxClientSecret;
     this.webhookSecret = webhookSecret;
   }
 
+  accessTokens: API.AccessTokens = new API.AccessTokens(this);
   hris: API.HRIS = new API.HRIS(this);
   providers: API.Providers = new API.Providers(this);
   account: API.Account = new API.Account(this);
   webhooks: API.Webhooks = new API.Webhooks(this);
   requestForwarding: API.RequestForwarding = new API.RequestForwarding(this);
   jobs: API.Jobs = new API.Jobs(this);
+  sandbox: API.Sandbox = new API.Sandbox(this);
 
   /**
    * Returns an access token for the Finch API given an authorization code. An
@@ -196,6 +218,14 @@ export class Finch extends Core.APIClient {
     return url.toString();
   }
 
+  /**
+   * Returns a copy of the current Finch client with the given access token for
+   * authentication.
+   */
+  withAccessToken(accessToken: string): Finch {
+    return new Finch({ ...this._options, accessToken });
+  }
+
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
   }
@@ -209,25 +239,60 @@ export class Finch extends Core.APIClient {
   }
 
   protected override validateHeaders(headers: Core.Headers, customHeaders: Core.Headers) {
-    if (this.accessToken && headers['Authorization']) {
+    if (this.accessToken && headers['authorization']) {
+      return;
+    }
+    if (customHeaders['authorization'] === null) {
       return;
     }
-    if (customHeaders['Authorization'] === null) {
+
+    if (this.sandboxClientId && this.sandboxClientSecret && headers['authorization']) {
+      return;
+    }
+    if (customHeaders['authorization'] === null) {
       return;
     }
 
     throw new Error(
-      'Could not resolve authentication method. Expected the accessToken to be set. Or for the "Authorization" headers to be explicitly omitted',
+      'Could not resolve authentication method. Expected either accessToken, sandboxClientId or sandboxClientSecret to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted',
     );
   }
 
   protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    const bearerAuth = this.bearerAuth(opts);
+    const basicAuth = this.basicAuth(opts);
+
+    if (bearerAuth != null && !Core.isEmptyObj(bearerAuth)) {
+      return bearerAuth;
+    }
+
+    if (basicAuth != null && !Core.isEmptyObj(basicAuth)) {
+      return basicAuth;
+    }
+    return {};
+  }
+
+  protected bearerAuth(opts: Core.FinalRequestOptions): Core.Headers {
     if (this.accessToken == null) {
       return {};
     }
     return { Authorization: `Bearer ${this.accessToken}` };
   }
 
+  protected basicAuth(opts: Core.FinalRequestOptions): Core.Headers {
+    if (!this.sandboxClientId) {
+      return {};
+    }
+
+    if (!this.sandboxClientSecret) {
+      return {};
+    }
+
+    const credentials = `${this.sandboxClientId}:${this.sandboxClientSecret}`;
+    const Authorization = `Basic ${Core.toBase64(credentials)}`;
+    return { Authorization };
+  }
+
   static Finch = this;
 
   static FinchError = Errors.FinchError;
@@ -285,6 +350,10 @@ export namespace Finch {
   export import PageParams = Pagination.PageParams;
   export import PageResponse = Pagination.PageResponse;
 
+  export import AccessTokens = API.AccessTokens;
+  export import CreateAccessTokenResponse = API.CreateAccessTokenResponse;
+  export import AccessTokenCreateParams = API.AccessTokenCreateParams;
+
   export import HRIS = API.HRIS;
   export import Income = API.Income;
   export import Location = API.Location;
@@ -306,6 +375,9 @@ export namespace Finch {
 
   export import Jobs = API.Jobs;
 
+  export import Sandbox = API.Sandbox;
+
+  export import ConnectionStatusType = API.ConnectionStatusType;
   export import OperationSupport = API.OperationSupport;
   export import OperationSupportMatrix = API.OperationSupportMatrix;
   export import Paging = API.Paging;

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/resources/access-tokens.ts

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../core";
+import { APIResource } from "../resource";
+import * as AccessTokensAPI from "./access-tokens";
+
+export class AccessTokens extends APIResource {
+  /**
+   * Exchange the authorization code for an access token
+   */
+  create(
+    body: AccessTokenCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CreateAccessTokenResponse> {
+    return this._client.post('/auth/token', { body, ...options });
+  }
+}
+
+export interface CreateAccessTokenResponse {
+  access_token: string;
+}
+
+export interface AccessTokenCreateParams {
+  client_id: string;
+
+  client_secret: string;
+
+  code: string;
+
+  redirect_uri: string;
+}
+
+export namespace AccessTokens {
+  export import CreateAccessTokenResponse = AccessTokensAPI.CreateAccessTokenResponse;
+  export import AccessTokenCreateParams = AccessTokensAPI.AccessTokenCreateParams;
+}

package/src/resources/account.ts

@@ -3,6 +3,7 @@
 import * as Core from "../core";
 import { APIResource } from "../resource";
 import * as AccountAPI from "./account";
+import * as Shared from "./shared";
 
 export class Account extends APIResource {
   /**
@@ -35,6 +36,8 @@ export interface Introspection {
    */
   account_id: string;
 
+  authentication_methods: Introspection.AuthenticationMethods;
+
   /**
    * The client id of the application associated with the `access_token`.
    */
@@ -82,6 +85,22 @@ export interface Introspection {
   username: string;
 }
 
+export namespace Introspection {
+  export interface AuthenticationMethods {
+    connection_status?: AuthenticationMethods.ConnectionStatus;
+
+    type?: string;
+  }
+
+  export namespace AuthenticationMethods {
+    export interface ConnectionStatus {
+      message?: string;
+
+      status?: Shared.ConnectionStatusType;
+    }
+  }
+}
+
 export namespace Account {
   export import DisconnectResponse = AccountAPI.DisconnectResponse;
   export import Introspection = AccountAPI.Introspection;

package/src/resources/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export * from './shared';
+export { CreateAccessTokenResponse, AccessTokenCreateParams, AccessTokens } from './access-tokens';
 export { DisconnectResponse, Introspection, Account } from './account';
 export { Income, Location, Money, HRIS } from './hris/hris';
 export { Jobs } from './jobs/jobs';
@@ -10,4 +11,5 @@ export {
   RequestForwardingForwardParams,
   RequestForwarding,
 } from './request-forwarding';
+export { Sandbox } from './sandbox/sandbox';
 export { Webhooks } from './webhooks';