@tryfinch/finch-api 6.31.0 → 8.0.0

package/error.js

@@ -1,113 +1,6 @@
 "use strict";
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalServerError = exports.RateLimitError = exports.UnprocessableEntityError = exports.ConflictError = exports.NotFoundError = exports.PermissionDeniedError = exports.AuthenticationError = exports.BadRequestError = exports.APIConnectionTimeoutError = exports.APIConnectionError = exports.APIUserAbortError = exports.APIError = exports.FinchError = void 0;
-const core_1 = require("./core.js");
-class FinchError extends Error {
-}
-exports.FinchError = FinchError;
-class APIError extends FinchError {
-    constructor(status, error, message, headers) {
-        super(`${APIError.makeMessage(status, error, message)}`);
-        this.status = status;
-        this.headers = headers;
-        this.error = error;
-    }
-    static makeMessage(status, error, message) {
-        const msg = error?.message ?
-            typeof error.message === 'string' ?
-                error.message
-                : JSON.stringify(error.message)
-            : error ? JSON.stringify(error)
-                : message;
-        if (status && msg) {
-            return `${status} ${msg}`;
-        }
-        if (status) {
-            return `${status} status code (no body)`;
-        }
-        if (msg) {
-            return msg;
-        }
-        return '(no status code or body)';
-    }
-    static generate(status, errorResponse, message, headers) {
-        if (!status || !headers) {
-            return new APIConnectionError({ message, cause: (0, core_1.castToError)(errorResponse) });
-        }
-        const error = errorResponse;
-        if (status === 400) {
-            return new BadRequestError(status, error, message, headers);
-        }
-        if (status === 401) {
-            return new AuthenticationError(status, error, message, headers);
-        }
-        if (status === 403) {
-            return new PermissionDeniedError(status, error, message, headers);
-        }
-        if (status === 404) {
-            return new NotFoundError(status, error, message, headers);
-        }
-        if (status === 409) {
-            return new ConflictError(status, error, message, headers);
-        }
-        if (status === 422) {
-            return new UnprocessableEntityError(status, error, message, headers);
-        }
-        if (status === 429) {
-            return new RateLimitError(status, error, message, headers);
-        }
-        if (status >= 500) {
-            return new InternalServerError(status, error, message, headers);
-        }
-        return new APIError(status, error, message, headers);
-    }
-}
-exports.APIError = APIError;
-class APIUserAbortError extends APIError {
-    constructor({ message } = {}) {
-        super(undefined, undefined, message || 'Request was aborted.', undefined);
-    }
-}
-exports.APIUserAbortError = APIUserAbortError;
-class APIConnectionError extends APIError {
-    constructor({ message, cause }) {
-        super(undefined, undefined, message || 'Connection error.', undefined);
-        // in some environments the 'cause' property is already declared
-        // @ts-ignore
-        if (cause)
-            this.cause = cause;
-    }
-}
-exports.APIConnectionError = APIConnectionError;
-class APIConnectionTimeoutError extends APIConnectionError {
-    constructor({ message } = {}) {
-        super({ message: message ?? 'Request timed out.' });
-    }
-}
-exports.APIConnectionTimeoutError = APIConnectionTimeoutError;
-class BadRequestError extends APIError {
-}
-exports.BadRequestError = BadRequestError;
-class AuthenticationError extends APIError {
-}
-exports.AuthenticationError = AuthenticationError;
-class PermissionDeniedError extends APIError {
-}
-exports.PermissionDeniedError = PermissionDeniedError;
-class NotFoundError extends APIError {
-}
-exports.NotFoundError = NotFoundError;
-class ConflictError extends APIError {
-}
-exports.ConflictError = ConflictError;
-class UnprocessableEntityError extends APIError {
-}
-exports.UnprocessableEntityError = UnprocessableEntityError;
-class RateLimitError extends APIError {
-}
-exports.RateLimitError = RateLimitError;
-class InternalServerError extends APIError {
-}
-exports.InternalServerError = InternalServerError;
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/error instead */
+tslib_1.__exportStar(require("./core/error.js"), exports);
 //# sourceMappingURL=error.js.map

package/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oCAA8C;AAE9C,MAAa,UAAW,SAAQ,KAAK;CAAG;AAAxC,gCAAwC;AAExC,MAAa,QAIX,SAAQ,UAAU;IAQlB,YAAY,MAAe,EAAE,KAAa,EAAE,OAA2B,EAAE,OAAiB;QACxF,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,MAA0B,EAAE,KAAU,EAAE,OAA2B;QAC5F,MAAM,GAAG,GACP,KAAK,EAAE,OAAO,CAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;gBACjC,KAAK,CAAC,OAAO;gBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,OAAO,CAAC;QAEZ,IAAI,MAAM,IAAI,GAAG,EAAE;YACjB,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;SAC3B;QACD,IAAI,MAAM,EAAE;YACV,OAAO,GAAG,MAAM,wBAAwB,CAAC;SAC1C;QACD,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,0BAA0B,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE;YACvB,OAAO,IAAI,kBAAkB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAA,kBAAW,EAAC,aAAa,CAAC,EAAE,CAAC,CAAC;SAC/E;QAED,MAAM,KAAK,GAAG,aAAoC,CAAC;QAEnD,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjE;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACnE;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,wBAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACtE;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5D;QAED,IAAI,MAAM,IAAI,GAAG,EAAE;YACjB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjE;QAED,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAtFD,4BAsFC;AAED,MAAa,iBAAkB,SAAQ,QAAyC;IAC9E,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;CACF;AAJD,8CAIC;AAED,MAAa,kBAAmB,SAAQ,QAAyC;IAC/E,YAAY,EAAE,OAAO,EAAE,KAAK,EAA+D;QACzF,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACvE,gEAAgE;QAChE,aAAa;QACb,IAAI,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IAChC,CAAC;CACF;AAPD,gDAOC;AAED,MAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAJD,8DAIC;AAED,MAAa,eAAgB,SAAQ,QAAsB;CAAG;AAA9D,0CAA8D;AAE9D,MAAa,mBAAoB,SAAQ,QAAsB;CAAG;AAAlE,kDAAkE;AAElE,MAAa,qBAAsB,SAAQ,QAAsB;CAAG;AAApE,sDAAoE;AAEpE,MAAa,aAAc,SAAQ,QAAsB;CAAG;AAA5D,sCAA4D;AAE5D,MAAa,aAAc,SAAQ,QAAsB;CAAG;AAA5D,sCAA4D;AAE5D,MAAa,wBAAyB,SAAQ,QAAsB;CAAG;AAAvE,4DAAuE;AAEvE,MAAa,cAAe,SAAQ,QAAsB;CAAG;AAA7D,wCAA6D;AAE7D,MAAa,mBAAoB,SAAQ,QAAyB;CAAG;AAArE,kDAAqE"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AACnD,0DAA6B"}

package/error.mjs

@@ -1,97 +1,2 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-import { castToError } from "./core.mjs";
-export class FinchError extends Error {
-}
-export class APIError extends FinchError {
-    constructor(status, error, message, headers) {
-        super(`${APIError.makeMessage(status, error, message)}`);
-        this.status = status;
-        this.headers = headers;
-        this.error = error;
-    }
-    static makeMessage(status, error, message) {
-        const msg = error?.message ?
-            typeof error.message === 'string' ?
-                error.message
-                : JSON.stringify(error.message)
-            : error ? JSON.stringify(error)
-                : message;
-        if (status && msg) {
-            return `${status} ${msg}`;
-        }
-        if (status) {
-            return `${status} status code (no body)`;
-        }
-        if (msg) {
-            return msg;
-        }
-        return '(no status code or body)';
-    }
-    static generate(status, errorResponse, message, headers) {
-        if (!status || !headers) {
-            return new APIConnectionError({ message, cause: castToError(errorResponse) });
-        }
-        const error = errorResponse;
-        if (status === 400) {
-            return new BadRequestError(status, error, message, headers);
-        }
-        if (status === 401) {
-            return new AuthenticationError(status, error, message, headers);
-        }
-        if (status === 403) {
-            return new PermissionDeniedError(status, error, message, headers);
-        }
-        if (status === 404) {
-            return new NotFoundError(status, error, message, headers);
-        }
-        if (status === 409) {
-            return new ConflictError(status, error, message, headers);
-        }
-        if (status === 422) {
-            return new UnprocessableEntityError(status, error, message, headers);
-        }
-        if (status === 429) {
-            return new RateLimitError(status, error, message, headers);
-        }
-        if (status >= 500) {
-            return new InternalServerError(status, error, message, headers);
-        }
-        return new APIError(status, error, message, headers);
-    }
-}
-export class APIUserAbortError extends APIError {
-    constructor({ message } = {}) {
-        super(undefined, undefined, message || 'Request was aborted.', undefined);
-    }
-}
-export class APIConnectionError extends APIError {
-    constructor({ message, cause }) {
-        super(undefined, undefined, message || 'Connection error.', undefined);
-        // in some environments the 'cause' property is already declared
-        // @ts-ignore
-        if (cause)
-            this.cause = cause;
-    }
-}
-export class APIConnectionTimeoutError extends APIConnectionError {
-    constructor({ message } = {}) {
-        super({ message: message ?? 'Request timed out.' });
-    }
-}
-export class BadRequestError extends APIError {
-}
-export class AuthenticationError extends APIError {
-}
-export class PermissionDeniedError extends APIError {
-}
-export class NotFoundError extends APIError {
-}
-export class ConflictError extends APIError {
-}
-export class UnprocessableEntityError extends APIError {
-}
-export class RateLimitError extends APIError {
-}
-export class InternalServerError extends APIError {
-}
+export * from "./core/error.mjs";
 //# sourceMappingURL=error.mjs.map

package/error.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"error.mjs","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAW;AAE/B,MAAM,OAAO,UAAW,SAAQ,KAAK;CAAG;AAExC,MAAM,OAAO,QAIX,SAAQ,UAAU;IAQlB,YAAY,MAAe,EAAE,KAAa,EAAE,OAA2B,EAAE,OAAiB;QACxF,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEO,MAAM,CAAC,WAAW,CAAC,MAA0B,EAAE,KAAU,EAAE,OAA2B;QAC5F,MAAM,GAAG,GACP,KAAK,EAAE,OAAO,CAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;gBACjC,KAAK,CAAC,OAAO;gBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;YACjC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,OAAO,CAAC;QAEZ,IAAI,MAAM,IAAI,GAAG,EAAE;YACjB,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;SAC3B;QACD,IAAI,MAAM,EAAE;YACV,OAAO,GAAG,MAAM,wBAAwB,CAAC;SAC1C;QACD,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;QACD,OAAO,0BAA0B,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE;YACvB,OAAO,IAAI,kBAAkB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;SAC/E;QAED,MAAM,KAAK,GAAG,aAAoC,CAAC;QAEnD,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjE;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACnE;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,wBAAwB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACtE;QAED,IAAI,MAAM,KAAK,GAAG,EAAE;YAClB,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC5D;QAED,IAAI,MAAM,IAAI,GAAG,EAAE;YACjB,OAAO,IAAI,mBAAmB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjE;QAED,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,QAAyC;IAC9E,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,QAAyC;IAC/E,YAAY,EAAE,OAAO,EAAE,KAAK,EAA+D;QACzF,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QACvE,gEAAgE;QAChE,aAAa;QACb,IAAI,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,yBAA0B,SAAQ,kBAAkB;IAC/D,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,QAAsB;CAAG;AAE9D,MAAM,OAAO,mBAAoB,SAAQ,QAAsB;CAAG;AAElE,MAAM,OAAO,qBAAsB,SAAQ,QAAsB;CAAG;AAEpE,MAAM,OAAO,aAAc,SAAQ,QAAsB;CAAG;AAE5D,MAAM,OAAO,aAAc,SAAQ,QAAsB;CAAG;AAE5D,MAAM,OAAO,wBAAyB,SAAQ,QAAsB;CAAG;AAEvE,MAAM,OAAO,cAAe,SAAQ,QAAsB;CAAG;AAE7D,MAAM,OAAO,mBAAoB,SAAQ,QAAyB;CAAG"}
+{"version":3,"file":"error.mjs","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":""}

package/index.d.mts

@@ -1,197 +1,7 @@
-import { type Agent } from "./_shims/index.js";
-import * as Core from "./core.js";
-import * as Errors from "./error.js";
-import * as Pagination from "./pagination.js";
-import { type IndividualsPageParams, IndividualsPageResponse, type PageParams, PageResponse, ResponsesPageResponse, SinglePageResponse } from "./pagination.js";
-import * as Uploads from "./uploads.js";
-import * as API from "./resources/index.js";
-import { AccessTokenCreateParams, AccessTokens, CreateAccessTokenResponse } from "./resources/access-tokens.js";
-import { Account, DisconnectResponse, Introspection } from "./resources/account.js";
-import { Provider, Providers, ProvidersSinglePage } from "./resources/providers.js";
-import { RequestForwarding, RequestForwardingForwardParams, RequestForwardingForwardResponse } from "./resources/request-forwarding.js";
-import { AccountUpdateEvent, BaseWebhookEvent, CompanyEvent, DirectoryEvent, EmploymentEvent, IndividualEvent, JobCompletionEvent, PayStatementEvent, PaymentEvent, WebhookEvent, Webhooks } from "./resources/webhooks.js";
-import { Connect } from "./resources/connect/connect.js";
-import { HRIS, Income, Location, Money } from "./resources/hris/hris.js";
-import { Jobs } from "./resources/jobs/jobs.js";
-import { Payroll } from "./resources/payroll/payroll.js";
-import { Sandbox } from "./resources/sandbox/sandbox.js";
-export interface ClientOptions {
-    accessToken?: string | null | undefined;
-    /**
-     * Defaults to process.env['FINCH_CLIENT_ID'].
-     */
-    clientId?: string | null | undefined;
-    /**
-     * Defaults to process.env['FINCH_CLIENT_SECRET'].
-     */
-    clientSecret?: string | null | undefined;
-    /**
-     * Defaults to process.env['FINCH_WEBHOOK_SECRET'].
-     */
-    webhookSecret?: string | null | undefined;
-    /**
-     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
-     *
-     * Defaults to process.env['FINCH_BASE_URL'].
-     */
-    baseURL?: string | null | undefined;
-    /**
-     * The maximum amount of time (in milliseconds) that the client should wait for a response
-     * from the server before timing out a single request.
-     *
-     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
-     * much longer than this timeout before the promise succeeds or fails.
-     */
-    timeout?: number | undefined;
-    /**
-     * An HTTP agent used to manage HTTP(S) connections.
-     *
-     * If not provided, an agent will be constructed by default in the Node.js environment,
-     * otherwise no agent is used.
-     */
-    httpAgent?: Agent | undefined;
-    /**
-     * Specify a custom `fetch` function implementation.
-     *
-     * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
-     * defined globally.
-     */
-    fetch?: Core.Fetch | undefined;
-    /**
-     * The maximum number of times that the client will retry a request in case of a
-     * temporary failure, like a network error or a 5XX error from the server.
-     *
-     * @default 2
-     */
-    maxRetries?: number | undefined;
-    /**
-     * Default headers to include with every request to the API.
-     *
-     * These can be removed in individual requests by explicitly setting the
-     * header to `undefined` or `null` in request options.
-     */
-    defaultHeaders?: Core.Headers | undefined;
-    /**
-     * Default query parameters to include with every request to the API.
-     *
-     * These can be removed in individual requests by explicitly setting the
-     * param to `undefined` in request options.
-     */
-    defaultQuery?: Core.DefaultQuery | undefined;
-    /**
-     * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
-     * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
-     */
-    dangerouslyAllowBrowser?: boolean | undefined;
-}
-/**
- * API Client for interfacing with the Finch API.
- */
-export declare class Finch extends Core.APIClient {
-    accessToken: string | null;
-    clientId: string | null;
-    clientSecret: string | null;
-    webhookSecret: string | null;
-    private _options;
-    /**
-     * API Client for interfacing with the Finch API.
-     *
-     * @param {string | null | undefined} [opts.accessToken]
-     * @param {string | null | undefined} [opts.clientId=process.env['FINCH_CLIENT_ID'] ?? null]
-     * @param {string | null | undefined} [opts.clientSecret=process.env['FINCH_CLIENT_SECRET'] ?? null]
-     * @param {string | null | undefined} [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.
-     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
-     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
-     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
-     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
-     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
-     * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
-     */
-    constructor({ baseURL, accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
-    accessTokens: API.AccessTokens;
-    hris: API.HRIS;
-    providers: API.Providers;
-    account: API.Account;
-    webhooks: API.Webhooks;
-    requestForwarding: API.RequestForwarding;
-    jobs: API.Jobs;
-    sandbox: API.Sandbox;
-    payroll: API.Payroll;
-    connect: API.Connect;
-    /**
-     * DEPRECATED: use client.accessTokens.create instead.
-     */
-    getAccessToken(code: string, options?: {
-        redirectUri: string;
-    }): Promise<string>;
-    /**
-     * Returns the authorization url which can be visited in order to obtain an
-     * authorization code from Finch. The authorization code can then be exchanged for
-     * an access token for the Finch api by calling get_access_token().
-     */
-    getAuthURL({ products, redirectUri, sandbox, }: {
-        products: string;
-        redirectUri: string;
-        sandbox: boolean;
-    }): string;
-    /**
-     * Returns a copy of the current Finch client with the given access token for
-     * authentication.
-     */
-    withAccessToken(accessToken: string): Finch;
-    protected defaultQuery(): Core.DefaultQuery | undefined;
-    protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
-    protected validateHeaders(headers: Core.Headers, customHeaders: Core.Headers): void;
-    protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
-    protected bearerAuth(opts: Core.FinalRequestOptions): Core.Headers;
-    protected basicAuth(opts: Core.FinalRequestOptions): Core.Headers;
-    protected stringifyQuery(query: Record<string, unknown>): string;
-    static Finch: typeof Finch;
-    static DEFAULT_TIMEOUT: number;
-    static FinchError: typeof Errors.FinchError;
-    static APIError: typeof Errors.APIError;
-    static APIConnectionError: typeof Errors.APIConnectionError;
-    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
-    static APIUserAbortError: typeof Errors.APIUserAbortError;
-    static NotFoundError: typeof Errors.NotFoundError;
-    static ConflictError: typeof Errors.ConflictError;
-    static RateLimitError: typeof Errors.RateLimitError;
-    static BadRequestError: typeof Errors.BadRequestError;
-    static AuthenticationError: typeof Errors.AuthenticationError;
-    static InternalServerError: typeof Errors.InternalServerError;
-    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
-    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
-    static toFile: typeof Uploads.toFile;
-    static fileFromPath: typeof Uploads.fileFromPath;
-}
-export declare namespace Finch {
-    export type RequestOptions = Core.RequestOptions;
-    export import SinglePage = Pagination.SinglePage;
-    export { type SinglePageResponse as SinglePageResponse };
-    export import ResponsesPage = Pagination.ResponsesPage;
-    export { type ResponsesPageResponse as ResponsesPageResponse };
-    export import IndividualsPage = Pagination.IndividualsPage;
-    export { type IndividualsPageParams as IndividualsPageParams, type IndividualsPageResponse as IndividualsPageResponse, };
-    export import Page = Pagination.Page;
-    export { type PageParams as PageParams, type PageResponse as PageResponse };
-    export { AccessTokens as AccessTokens, type CreateAccessTokenResponse as CreateAccessTokenResponse, type AccessTokenCreateParams as AccessTokenCreateParams, };
-    export { HRIS as HRIS, type Income as Income, type Location as Location, type Money as Money };
-    export { Providers as Providers, type Provider as Provider, ProvidersSinglePage as ProvidersSinglePage };
-    export { Account as Account, type DisconnectResponse as DisconnectResponse, type Introspection as Introspection, };
-    export { Webhooks as Webhooks, type AccountUpdateEvent as AccountUpdateEvent, type BaseWebhookEvent as BaseWebhookEvent, type CompanyEvent as CompanyEvent, type DirectoryEvent as DirectoryEvent, type EmploymentEvent as EmploymentEvent, type IndividualEvent as IndividualEvent, type JobCompletionEvent as JobCompletionEvent, type PayStatementEvent as PayStatementEvent, type PaymentEvent as PaymentEvent, type WebhookEvent as WebhookEvent, };
-    export { RequestForwarding as RequestForwarding, type RequestForwardingForwardResponse as RequestForwardingForwardResponse, type RequestForwardingForwardParams as RequestForwardingForwardParams, };
-    export { Jobs as Jobs };
-    export { Sandbox as Sandbox };
-    export { Payroll as Payroll };
-    export { Connect as Connect };
-    export type ConnectionStatusType = API.ConnectionStatusType;
-    export type OperationSupport = API.OperationSupport;
-    export type OperationSupportMatrix = API.OperationSupportMatrix;
-    export type Paging = API.Paging;
-}
-export { toFile, fileFromPath } from "./uploads.js";
-export { FinchError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
-export default Finch;
-//# sourceMappingURL=index.d.ts.map
+export { Finch as default } from "./client.mjs";
+export { type Uploadable, toFile } from "./core/uploads.mjs";
+export { APIPromise } from "./core/api-promise.mjs";
+export { Finch, type ClientOptions } from "./client.mjs";
+export { PagePromise } from "./core/pagination.mjs";
+export { FinchError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./core/error.mjs";
+//# sourceMappingURL=index.d.mts.map

package/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"OAEO,EAAE,KAAK,IAAI,OAAO,EAAE;OAEpB,EAAE,KAAK,UAAU,EAAE,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,EAAE,KAAK,aAAa,EAAE;OAC7B,EAAE,WAAW,EAAE;OACf,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB"}

package/index.d.ts

@@ -1,197 +1,7 @@
-import { type Agent } from "./_shims/index.js";
-import * as Core from "./core.js";
-import * as Errors from "./error.js";
-import * as Pagination from "./pagination.js";
-import { type IndividualsPageParams, IndividualsPageResponse, type PageParams, PageResponse, ResponsesPageResponse, SinglePageResponse } from "./pagination.js";
-import * as Uploads from "./uploads.js";
-import * as API from "./resources/index.js";
-import { AccessTokenCreateParams, AccessTokens, CreateAccessTokenResponse } from "./resources/access-tokens.js";
-import { Account, DisconnectResponse, Introspection } from "./resources/account.js";
-import { Provider, Providers, ProvidersSinglePage } from "./resources/providers.js";
-import { RequestForwarding, RequestForwardingForwardParams, RequestForwardingForwardResponse } from "./resources/request-forwarding.js";
-import { AccountUpdateEvent, BaseWebhookEvent, CompanyEvent, DirectoryEvent, EmploymentEvent, IndividualEvent, JobCompletionEvent, PayStatementEvent, PaymentEvent, WebhookEvent, Webhooks } from "./resources/webhooks.js";
-import { Connect } from "./resources/connect/connect.js";
-import { HRIS, Income, Location, Money } from "./resources/hris/hris.js";
-import { Jobs } from "./resources/jobs/jobs.js";
-import { Payroll } from "./resources/payroll/payroll.js";
-import { Sandbox } from "./resources/sandbox/sandbox.js";
-export interface ClientOptions {
-    accessToken?: string | null | undefined;
-    /**
-     * Defaults to process.env['FINCH_CLIENT_ID'].
-     */
-    clientId?: string | null | undefined;
-    /**
-     * Defaults to process.env['FINCH_CLIENT_SECRET'].
-     */
-    clientSecret?: string | null | undefined;
-    /**
-     * Defaults to process.env['FINCH_WEBHOOK_SECRET'].
-     */
-    webhookSecret?: string | null | undefined;
-    /**
-     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
-     *
-     * Defaults to process.env['FINCH_BASE_URL'].
-     */
-    baseURL?: string | null | undefined;
-    /**
-     * The maximum amount of time (in milliseconds) that the client should wait for a response
-     * from the server before timing out a single request.
-     *
-     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
-     * much longer than this timeout before the promise succeeds or fails.
-     */
-    timeout?: number | undefined;
-    /**
-     * An HTTP agent used to manage HTTP(S) connections.
-     *
-     * If not provided, an agent will be constructed by default in the Node.js environment,
-     * otherwise no agent is used.
-     */
-    httpAgent?: Agent | undefined;
-    /**
-     * Specify a custom `fetch` function implementation.
-     *
-     * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
-     * defined globally.
-     */
-    fetch?: Core.Fetch | undefined;
-    /**
-     * The maximum number of times that the client will retry a request in case of a
-     * temporary failure, like a network error or a 5XX error from the server.
-     *
-     * @default 2
-     */
-    maxRetries?: number | undefined;
-    /**
-     * Default headers to include with every request to the API.
-     *
-     * These can be removed in individual requests by explicitly setting the
-     * header to `undefined` or `null` in request options.
-     */
-    defaultHeaders?: Core.Headers | undefined;
-    /**
-     * Default query parameters to include with every request to the API.
-     *
-     * These can be removed in individual requests by explicitly setting the
-     * param to `undefined` in request options.
-     */
-    defaultQuery?: Core.DefaultQuery | undefined;
-    /**
-     * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
-     * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
-     */
-    dangerouslyAllowBrowser?: boolean | undefined;
-}
-/**
- * API Client for interfacing with the Finch API.
- */
-export declare class Finch extends Core.APIClient {
-    accessToken: string | null;
-    clientId: string | null;
-    clientSecret: string | null;
-    webhookSecret: string | null;
-    private _options;
-    /**
-     * API Client for interfacing with the Finch API.
-     *
-     * @param {string | null | undefined} [opts.accessToken]
-     * @param {string | null | undefined} [opts.clientId=process.env['FINCH_CLIENT_ID'] ?? null]
-     * @param {string | null | undefined} [opts.clientSecret=process.env['FINCH_CLIENT_SECRET'] ?? null]
-     * @param {string | null | undefined} [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.
-     * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
-     * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
-     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
-     * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
-     * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
-     * @param {boolean} [opts.dangerouslyAllowBrowser=false] - By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
-     */
-    constructor({ baseURL, accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
-    accessTokens: API.AccessTokens;
-    hris: API.HRIS;
-    providers: API.Providers;
-    account: API.Account;
-    webhooks: API.Webhooks;
-    requestForwarding: API.RequestForwarding;
-    jobs: API.Jobs;
-    sandbox: API.Sandbox;
-    payroll: API.Payroll;
-    connect: API.Connect;
-    /**
-     * DEPRECATED: use client.accessTokens.create instead.
-     */
-    getAccessToken(code: string, options?: {
-        redirectUri: string;
-    }): Promise<string>;
-    /**
-     * Returns the authorization url which can be visited in order to obtain an
-     * authorization code from Finch. The authorization code can then be exchanged for
-     * an access token for the Finch api by calling get_access_token().
-     */
-    getAuthURL({ products, redirectUri, sandbox, }: {
-        products: string;
-        redirectUri: string;
-        sandbox: boolean;
-    }): string;
-    /**
-     * Returns a copy of the current Finch client with the given access token for
-     * authentication.
-     */
-    withAccessToken(accessToken: string): Finch;
-    protected defaultQuery(): Core.DefaultQuery | undefined;
-    protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers;
-    protected validateHeaders(headers: Core.Headers, customHeaders: Core.Headers): void;
-    protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers;
-    protected bearerAuth(opts: Core.FinalRequestOptions): Core.Headers;
-    protected basicAuth(opts: Core.FinalRequestOptions): Core.Headers;
-    protected stringifyQuery(query: Record<string, unknown>): string;
-    static Finch: typeof Finch;
-    static DEFAULT_TIMEOUT: number;
-    static FinchError: typeof Errors.FinchError;
-    static APIError: typeof Errors.APIError;
-    static APIConnectionError: typeof Errors.APIConnectionError;
-    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
-    static APIUserAbortError: typeof Errors.APIUserAbortError;
-    static NotFoundError: typeof Errors.NotFoundError;
-    static ConflictError: typeof Errors.ConflictError;
-    static RateLimitError: typeof Errors.RateLimitError;
-    static BadRequestError: typeof Errors.BadRequestError;
-    static AuthenticationError: typeof Errors.AuthenticationError;
-    static InternalServerError: typeof Errors.InternalServerError;
-    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
-    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
-    static toFile: typeof Uploads.toFile;
-    static fileFromPath: typeof Uploads.fileFromPath;
-}
-export declare namespace Finch {
-    export type RequestOptions = Core.RequestOptions;
-    export import SinglePage = Pagination.SinglePage;
-    export { type SinglePageResponse as SinglePageResponse };
-    export import ResponsesPage = Pagination.ResponsesPage;
-    export { type ResponsesPageResponse as ResponsesPageResponse };
-    export import IndividualsPage = Pagination.IndividualsPage;
-    export { type IndividualsPageParams as IndividualsPageParams, type IndividualsPageResponse as IndividualsPageResponse, };
-    export import Page = Pagination.Page;
-    export { type PageParams as PageParams, type PageResponse as PageResponse };
-    export { AccessTokens as AccessTokens, type CreateAccessTokenResponse as CreateAccessTokenResponse, type AccessTokenCreateParams as AccessTokenCreateParams, };
-    export { HRIS as HRIS, type Income as Income, type Location as Location, type Money as Money };
-    export { Providers as Providers, type Provider as Provider, ProvidersSinglePage as ProvidersSinglePage };
-    export { Account as Account, type DisconnectResponse as DisconnectResponse, type Introspection as Introspection, };
-    export { Webhooks as Webhooks, type AccountUpdateEvent as AccountUpdateEvent, type BaseWebhookEvent as BaseWebhookEvent, type CompanyEvent as CompanyEvent, type DirectoryEvent as DirectoryEvent, type EmploymentEvent as EmploymentEvent, type IndividualEvent as IndividualEvent, type JobCompletionEvent as JobCompletionEvent, type PayStatementEvent as PayStatementEvent, type PaymentEvent as PaymentEvent, type WebhookEvent as WebhookEvent, };
-    export { RequestForwarding as RequestForwarding, type RequestForwardingForwardResponse as RequestForwardingForwardResponse, type RequestForwardingForwardParams as RequestForwardingForwardParams, };
-    export { Jobs as Jobs };
-    export { Sandbox as Sandbox };
-    export { Payroll as Payroll };
-    export { Connect as Connect };
-    export type ConnectionStatusType = API.ConnectionStatusType;
-    export type OperationSupport = API.OperationSupport;
-    export type OperationSupportMatrix = API.OperationSupportMatrix;
-    export type Paging = API.Paging;
-}
-export { toFile, fileFromPath } from "./uploads.js";
-export { FinchError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
-export default Finch;
+export { Finch as default } from "./client.js";
+export { type Uploadable, toFile } from "./core/uploads.js";
+export { APIPromise } from "./core/api-promise.js";
+export { Finch, type ClientOptions } from "./client.js";
+export { PagePromise } from "./core/pagination.js";
+export { FinchError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./core/error.js";
 //# sourceMappingURL=index.d.ts.map