@tryfinch/finch-api 5.1.0 → 5.3.0

package/error.mjs

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

package/error.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"error.mjs","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAAE,WAAW,EAAW;AAE/B,MAAM,OAAO,QAAS,SAAQ,KAAK;IAKjC,YACE,MAA0B,EAC1B,KAAyB,EACzB,OAA2B,EAC3B,OAA4B;QAE5B,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAC5C,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,KAAU,EAAE,OAA2B;QAChE,OAAO,CACL,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;gBACjD,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,IAAI,wBAAwB,CACtC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,kBAAkB,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;SACtE;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,QAAQ;IAG7C,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;QAH1D,WAAM,GAAc,SAAS,CAAC;IAIhD,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,QAAQ;IAG9C,YAAY,EAAE,OAAO,EAAE,KAAK,EAAmD;QAC7E,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QAHvD,WAAM,GAAc,SAAS,CAAC;QAI9C,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,aAAP,OAAO,cAAP,OAAO,GAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IAA7C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;IAAjD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,qBAAsB,SAAQ,QAAQ;IAAnD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,aAAc,SAAQ,QAAQ;IAA3C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,aAAc,SAAQ,QAAQ;IAA3C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,wBAAyB,SAAQ,QAAQ;IAAtD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAA5C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;CAAG"}
+{"version":3,"file":"error.mjs","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAAE,WAAW,EAAW;AAE/B,MAAM,OAAO,UAAW,SAAQ,KAAK;CAAG;AAExC,MAAM,OAAO,QAAS,SAAQ,UAAU;IAKtC,YACE,MAA0B,EAC1B,KAAyB,EACzB,OAA2B,EAC3B,OAA4B;QAE5B,KAAK,CAAC,GAAG,MAAM,IAAI,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3D,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,KAAU,EAAE,OAA2B;QAChE,OAAO,CACL,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,EAAC,CAAC;YACd,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;gBACjD,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,IAAI,uBAAuB,CACrC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,QAAQ,CACb,MAA0B,EAC1B,aAAiC,EACjC,OAA2B,EAC3B,OAA4B;QAE5B,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,kBAAkB,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;SACtE;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,QAAQ;IAG7C,YAAY,EAAE,OAAO,KAA2B,EAAE;QAChD,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,sBAAsB,EAAE,SAAS,CAAC,CAAC;QAH1D,WAAM,GAAc,SAAS,CAAC;IAIhD,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,QAAQ;IAG9C,YAAY,EAAE,OAAO,EAAE,KAAK,EAAmD;QAC7E,KAAK,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,CAAC,CAAC;QAHvD,WAAM,GAAc,SAAS,CAAC;QAI9C,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,aAAP,OAAO,cAAP,OAAO,GAAI,oBAAoB,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IAA7C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;IAAjD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,qBAAsB,SAAQ,QAAQ;IAAnD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,aAAc,SAAQ,QAAQ;IAA3C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,aAAc,SAAQ,QAAQ;IAA3C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,wBAAyB,SAAQ,QAAQ;IAAtD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,cAAe,SAAQ,QAAQ;IAA5C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAED,MAAM,OAAO,mBAAoB,SAAQ,QAAQ;CAAG"}

package/index.d.mts

@@ -1,188 +1,155 @@
-import * as Core from './core.js';
-import * as Pagination from './pagination.js';
-import * as API from './resources/index.js';
-import * as Errors from './error.js';
-import type { Agent } from '@tryfinch/finch-api/_shims/agent';
-import * as Uploads from './uploads.js';
+import * as Core from "./core.js";
+import * as Pagination from "./pagination.js";
+import * as API from "./resources/index.js";
+import * as Errors from "./error.js";
+import { type Agent } from "./_shims/index.js";
+import * as Uploads from "./uploads.js";
 export interface ClientOptions {
-  /**
-   * Set it to null if you want to send unauthenticated requests.
-   */
-  accessToken?: string | null;
-  /**
-   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
-   */
-  baseURL?: string;
-  /**
-   * 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;
-  /**
-   * 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;
-  /**
-   * 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;
-  /**
-   * 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;
-  /**
-   * 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;
-  clientId?: string | null;
-  clientSecret?: string | null;
-  webhookSecret?: string | null;
+    /**
+     * Set it to null if you want to send unauthenticated requests.
+     */
+    accessToken?: string | null;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+     */
+    baseURL?: string;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    clientId?: string | null;
+    clientSecret?: string | null;
+    webhookSecret?: string | null;
 }
 /** 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} opts.accessToken - The Access Token to send to the API.
-   * @param {string} [opts.baseURL] - 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 {string | null} [opts.clientId]
-   * @param {string | null} [opts.clientSecret]
-   * @param {string | null} [opts.webhookSecret]
-   */
-  constructor({ accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
-  hris: API.HRIS;
-  ats: API.ATS;
-  providers: API.Providers;
-  account: API.Account;
-  webhooks: API.Webhooks;
-  /**
-   * Returns an access token for the Finch API given an authorization code. An
-   * authorization code can be obtained by visiting the url returned by
-   * get_auth_url().
-   */
-  getAccessToken(
-    code: string,
-    {
-      redirectUri,
-    }: {
-      redirectUri: string;
-    },
-  ): Promise<string>;
-  /**
-   * Returns the authorization url which can be visited in order to obtain an
-   * authorization code from Finch. The autorization 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;
-  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;
-  static Finch: typeof Finch;
-  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;
+    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} opts.accessToken - The Access Token to send to the API.
+     * @param {string} [opts.baseURL] - 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 {string | null} [opts.clientId]
+     * @param {string | null} [opts.clientSecret]
+     * @param {string | null} [opts.webhookSecret]
+     */
+    constructor({ accessToken, clientId, clientSecret, webhookSecret, ...opts }?: ClientOptions);
+    hris: API.HRIS;
+    providers: API.Providers;
+    account: API.Account;
+    webhooks: API.Webhooks;
+    /**
+     * Returns an access token for the Finch API given an authorization code. An
+     * authorization code can be obtained by visiting the url returned by
+     * get_auth_url().
+     */
+    getAccessToken(code: string, { redirectUri }: {
+        redirectUri: string;
+    }): Promise<string>;
+    /**
+     * Returns the authorization url which can be visited in order to obtain an
+     * authorization code from Finch. The autorization 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;
+    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;
+    static Finch: typeof Finch;
+    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;
 }
-export declare const APIError: typeof Errors.APIError,
-  APIConnectionError: typeof Errors.APIConnectionError,
-  APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError,
-  APIUserAbortError: typeof Errors.APIUserAbortError,
-  NotFoundError: typeof Errors.NotFoundError,
-  ConflictError: typeof Errors.ConflictError,
-  RateLimitError: typeof Errors.RateLimitError,
-  BadRequestError: typeof Errors.BadRequestError,
-  AuthenticationError: typeof Errors.AuthenticationError,
-  InternalServerError: typeof Errors.InternalServerError,
-  PermissionDeniedError: typeof Errors.PermissionDeniedError,
-  UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
+export declare const FinchError: typeof Errors.FinchError, APIError: typeof Errors.APIError, APIConnectionError: typeof Errors.APIConnectionError, APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError, APIUserAbortError: typeof Errors.APIUserAbortError, NotFoundError: typeof Errors.NotFoundError, ConflictError: typeof Errors.ConflictError, RateLimitError: typeof Errors.RateLimitError, BadRequestError: typeof Errors.BadRequestError, AuthenticationError: typeof Errors.AuthenticationError, InternalServerError: typeof Errors.InternalServerError, PermissionDeniedError: typeof Errors.PermissionDeniedError, UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
 export import toFile = Uploads.toFile;
 export import fileFromPath = Uploads.fileFromPath;
 export declare namespace Finch {
-  export import toFile = Uploads.toFile;
-  export import fileFromPath = Uploads.fileFromPath;
-  export import RequestOptions = Core.RequestOptions;
-  export import SinglePage = Pagination.SinglePage;
-  export import SinglePageResponse = Pagination.SinglePageResponse;
-  export import ResponsesPage = Pagination.ResponsesPage;
-  export import ResponsesPageResponse = Pagination.ResponsesPageResponse;
-  export import IndividualsPage = Pagination.IndividualsPage;
-  export import IndividualsPageParams = Pagination.IndividualsPageParams;
-  export import IndividualsPageResponse = Pagination.IndividualsPageResponse;
-  export import CandidatesPage = Pagination.CandidatesPage;
-  export import CandidatesPageParams = Pagination.CandidatesPageParams;
-  export import CandidatesPageResponse = Pagination.CandidatesPageResponse;
-  export import ApplicationsPage = Pagination.ApplicationsPage;
-  export import ApplicationsPageParams = Pagination.ApplicationsPageParams;
-  export import ApplicationsPageResponse = Pagination.ApplicationsPageResponse;
-  export import JobsPage = Pagination.JobsPage;
-  export import JobsPageParams = Pagination.JobsPageParams;
-  export import JobsPageResponse = Pagination.JobsPageResponse;
-  export import OffersPage = Pagination.OffersPage;
-  export import OffersPageParams = Pagination.OffersPageParams;
-  export import OffersPageResponse = Pagination.OffersPageResponse;
-  export import HRIS = API.HRIS;
-  export import Income = API.Income;
-  export import Location = API.Location;
-  export import Money = API.Money;
-  export import Paging = API.Paging;
-  export import ATS = API.ATS;
-  export import Providers = API.Providers;
-  export import Provider = API.Provider;
-  export import ProvidersSinglePage = API.ProvidersSinglePage;
-  export import Account = API.Account;
-  export import DisconnectResponse = API.DisconnectResponse;
-  export import Introspection = API.Introspection;
-  export import Webhooks = API.Webhooks;
+    export import toFile = Uploads.toFile;
+    export import fileFromPath = Uploads.fileFromPath;
+    export import RequestOptions = Core.RequestOptions;
+    export import SinglePage = Pagination.SinglePage;
+    export import SinglePageResponse = Pagination.SinglePageResponse;
+    export import ResponsesPage = Pagination.ResponsesPage;
+    export import ResponsesPageResponse = Pagination.ResponsesPageResponse;
+    export import IndividualsPage = Pagination.IndividualsPage;
+    export import IndividualsPageParams = Pagination.IndividualsPageParams;
+    export import IndividualsPageResponse = Pagination.IndividualsPageResponse;
+    export import HRIS = API.HRIS;
+    export import Income = API.Income;
+    export import Location = API.Location;
+    export import Money = API.Money;
+    export import Paging = API.Paging;
+    export import Providers = API.Providers;
+    export import Provider = API.Provider;
+    export import ProvidersSinglePage = API.ProvidersSinglePage;
+    export import Account = API.Account;
+    export import DisconnectResponse = API.DisconnectResponse;
+    export import Introspection = API.Introspection;
+    export import Webhooks = API.Webhooks;
 }
 export default Finch;
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map