@tryfinch/finch-api 1.1.0 → 3.0.0

package/error.d.ts

@@ -0,0 +1,48 @@
+import { Headers } from './core.js';
+export declare class APIError extends Error {
+  readonly status: number | undefined;
+  readonly headers: Headers | undefined;
+  readonly error: Object | undefined;
+  constructor(
+    status: number | undefined,
+    error: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  );
+  static generate(
+    status: number | undefined,
+    errorResponse: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ): APIError;
+}
+export declare class APIConnectionError extends APIError {
+  readonly status: undefined;
+  constructor({ message, cause }: { message?: string; cause?: Error | undefined });
+}
+export declare class APIConnectionTimeoutError extends APIConnectionError {
+  constructor();
+}
+export declare class BadRequestError extends APIError {
+  readonly status: 400;
+}
+export declare class AuthenticationError extends APIError {
+  readonly status: 401;
+}
+export declare class PermissionDeniedError extends APIError {
+  readonly status: 403;
+}
+export declare class NotFoundError extends APIError {
+  readonly status: 404;
+}
+export declare class ConflictError extends APIError {
+  readonly status: 409;
+}
+export declare class UnprocessableEntityError extends APIError {
+  readonly status: 422;
+}
+export declare class RateLimitError extends APIError {
+  readonly status: 429;
+}
+export declare class InternalServerError extends APIError {}
+//# sourceMappingURL=error.d.ts.map

package/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,OAAO,EAAE,MAAM,QAAQ,CAAC;AAE9C,qBAAa,QAAS,SAAQ,KAAK;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;gBAGjC,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GAAG,SAAS;IAQ9B,MAAM,CAAC,QAAQ,CACb,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,aAAa,EAAE,MAAM,GAAG,SAAS,EACjC,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GAAG,SAAS;CA0C/B;AAED,qBAAa,kBAAmB,SAAQ,QAAQ;IAC9C,SAAkB,MAAM,EAAE,SAAS,CAAa;gBAEpC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAA;KAAE;CAMhF;AAED,qBAAa,yBAA0B,SAAQ,kBAAkB;;CAIhE;AAED,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,mBAAoB,SAAQ,QAAQ;IAC/C,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,qBAAsB,SAAQ,QAAQ;IACjD,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,aAAc,SAAQ,QAAQ;IACzC,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,aAAc,SAAQ,QAAQ;IACzC,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,wBAAyB,SAAQ,QAAQ;IACpD,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,cAAe,SAAQ,QAAQ;IAC1C,SAAkB,MAAM,EAAE,GAAG,CAAO;CACrC;AAED,qBAAa,mBAAoB,SAAQ,QAAQ;CAAG"}

package/error.js

@@ -0,0 +1,126 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+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.APIError =
+    void 0;
+const core_1 = require('./core.js');
+class APIError extends Error {
+  constructor(status, error, message, headers) {
+    super(
+      message || (error === null || error === void 0 ? void 0 : error.message) || 'Unknown error occurred.',
+    );
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+  static generate(status, errorResponse, message, headers) {
+    if (!status) {
+      return new APIConnectionError({ 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 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;
+  }
+}
+exports.APIConnectionError = APIConnectionError;
+class APIConnectionTimeoutError extends APIConnectionError {
+  constructor() {
+    super({ message: 'Request timed out.' });
+  }
+}
+exports.APIConnectionTimeoutError = APIConnectionTimeoutError;
+class BadRequestError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 400;
+  }
+}
+exports.BadRequestError = BadRequestError;
+class AuthenticationError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 401;
+  }
+}
+exports.AuthenticationError = AuthenticationError;
+class PermissionDeniedError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 403;
+  }
+}
+exports.PermissionDeniedError = PermissionDeniedError;
+class NotFoundError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 404;
+  }
+}
+exports.NotFoundError = NotFoundError;
+class ConflictError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 409;
+  }
+}
+exports.ConflictError = ConflictError;
+class UnprocessableEntityError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 422;
+  }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;
+class RateLimitError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 429;
+  }
+}
+exports.RateLimitError = RateLimitError;
+class InternalServerError extends APIError {}
+exports.InternalServerError = InternalServerError;
+//# sourceMappingURL=error.js.map

package/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["src/error.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,oCAA8C;AAE9C,MAAa,QAAS,SAAQ,KAAK;IAKjC,YACE,MAA0B,EAC1B,KAAyB,EACzB,OAA2B,EAC3B,OAA4B;QAE5B,KAAK,CAAC,OAAO,KAAK,KAAa,aAAb,KAAK,uBAAL,KAAK,CAAU,OAAO,CAAA,IAAI,yBAAyB,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,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,IAAA,kBAAW,EAAC,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;AA/DD,4BA+DC;AAED,MAAa,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;AATD,gDASC;AAED,MAAa,yBAA0B,SAAQ,kBAAkB;IAC/D;QACE,KAAK,CAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,8DAIC;AAED,MAAa,eAAgB,SAAQ,QAAQ;IAA7C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,0CAEC;AAED,MAAa,mBAAoB,SAAQ,QAAQ;IAAjD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,kDAEC;AAED,MAAa,qBAAsB,SAAQ,QAAQ;IAAnD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,sDAEC;AAED,MAAa,aAAc,SAAQ,QAAQ;IAA3C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,sCAEC;AAED,MAAa,aAAc,SAAQ,QAAQ;IAA3C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,sCAEC;AAED,MAAa,wBAAyB,SAAQ,QAAQ;IAAtD;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,4DAEC;AAED,MAAa,cAAe,SAAQ,QAAQ;IAA5C;;QACoB,WAAM,GAAQ,GAAG,CAAC;IACtC,CAAC;CAAA;AAFD,wCAEC;AAED,MAAa,mBAAoB,SAAQ,QAAQ;CAAG;AAApD,kDAAoD"}

package/error.mjs

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless.
+import { castToError } from './core.mjs';
+export class APIError extends Error {
+  constructor(status, error, message, headers) {
+    super(
+      message || (error === null || error === void 0 ? void 0 : error.message) || 'Unknown error occurred.',
+    );
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+  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);
+  }
+}
+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;
+  }
+}
+export class APIConnectionTimeoutError extends APIConnectionError {
+  constructor() {
+    super({ message: 'Request timed out.' });
+  }
+}
+export class BadRequestError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 400;
+  }
+}
+export class AuthenticationError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 401;
+  }
+}
+export class PermissionDeniedError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 403;
+  }
+}
+export class NotFoundError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 404;
+  }
+}
+export class ConflictError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 409;
+  }
+}
+export class UnprocessableEntityError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 422;
+  }
+}
+export class RateLimitError extends APIError {
+  constructor() {
+    super(...arguments);
+    this.status = 429;
+  }
+}
+export class InternalServerError extends APIError {}
+//# sourceMappingURL=error.mjs.map

package/error.mjs.map

@@ -0,0 +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,OAAO,KAAK,KAAa,aAAb,KAAK,uBAAL,KAAK,CAAU,OAAO,CAAA,IAAI,yBAAyB,CAAC,CAAC;QACvE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,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,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;QACE,KAAK,CAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE,CAAC,CAAC;IAC3C,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

@@ -0,0 +1,160 @@
+import * as qs from 'qs';
+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';
+type Config = {
+  /**
+   * 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;
+  /**
+   * 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;
+};
+/** Instantiate the API Client. */
+export declare class Finch extends Core.APIClient {
+  accessToken: string | null;
+  clientId?: string | null;
+  clientSecret?: string | null;
+  private _options;
+  constructor(config?: Config);
+  ats: API.ATS;
+  hris: API.HRIS;
+  providers: API.Providers;
+  account: API.Account;
+  /**
+   * 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(): Core.Headers;
+  protected validateHeaders(headers: Core.Headers, customHeaders: Core.Headers): void;
+  protected authHeaders(): Core.Headers;
+  protected qsOptions(): qs.IStringifyOptions;
+  static APIError: typeof Errors.APIError;
+  static APIConnectionError: typeof Errors.APIConnectionError;
+  static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
+  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,
+  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 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 ATS = API.ATS;
+  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 default Finch;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts

@@ -0,0 +1,160 @@
+import * as qs from 'qs';
+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';
+type Config = {
+  /**
+   * 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;
+  /**
+   * 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;
+};
+/** Instantiate the API Client. */
+export declare class Finch extends Core.APIClient {
+  accessToken: string | null;
+  clientId?: string | null;
+  clientSecret?: string | null;
+  private _options;
+  constructor(config?: Config);
+  ats: API.ATS;
+  hris: API.HRIS;
+  providers: API.Providers;
+  account: API.Account;
+  /**
+   * 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(): Core.Headers;
+  protected validateHeaders(headers: Core.Headers, customHeaders: Core.Headers): void;
+  protected authHeaders(): Core.Headers;
+  protected qsOptions(): qs.IStringifyOptions;
+  static APIError: typeof Errors.APIError;
+  static APIConnectionError: typeof Errors.APIConnectionError;
+  static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
+  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,
+  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 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 ATS = API.ATS;
+  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 default Finch;
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAC;AAC9D,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAErC,KAAK,MAAM,GAAG;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAEjC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEF,kCAAkC;AAClC,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;IACvC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,CAAC,QAAQ,CAAS;gBAEb,MAAM,CAAC,EAAE,MAAM;IAoB3B,GAAG,EAAE,GAAG,CAAC,GAAG,CAAqB;IACjC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAE7C;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvF;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GACR,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,MAAM;cAiBS,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,IAAI,IAAI,CAAC,OAAO;cAQ9B,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO;cAalE,WAAW,IAAI,IAAI,CAAC,OAAO;cAO3B,SAAS,IAAI,EAAE,CAAC,iBAAiB;IAIpD,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;CACnE;AAED,eAAO,MACL,QAAQ,0BACR,kBAAkB,oCAClB,yBAAyB,2CACzB,aAAa,+BACb,aAAa,+BACb,cAAc,gCACd,eAAe,iCACf,mBAAmB,qCACnB,mBAAmB,qCACnB,qBAAqB,uCACrB,wBAAwB,wCAChB,CAAC;AAEX,MAAM,QAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACtC,MAAM,QAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;AAElD,yBAAiB,KAAK,CAAC;IAErB,MAAM,QAAQ,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACtC,MAAM,QAAQ,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAElD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAEjE,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IACvD,MAAM,QAAQ,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAEvE,MAAM,QAAQ,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;IAC3D,MAAM,QAAQ,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACvE,MAAM,QAAQ,uBAAuB,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAE3E,MAAM,QAAQ,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACzD,MAAM,QAAQ,oBAAoB,GAAG,UAAU,CAAC,oBAAoB,CAAC;IACrE,MAAM,QAAQ,sBAAsB,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAEzE,MAAM,QAAQ,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAC7D,MAAM,QAAQ,sBAAsB,GAAG,UAAU,CAAC,sBAAsB,CAAC;IACzE,MAAM,QAAQ,wBAAwB,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAE7E,MAAM,QAAQ,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;IAC7C,MAAM,QAAQ,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IACzD,MAAM,QAAQ,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAE7D,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,MAAM,QAAQ,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAC7D,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAEjE,MAAM,QAAQ,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;IAE5B,MAAM,QAAQ,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC9B,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAClC,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IAElC,MAAM,QAAQ,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC;IACxC,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,MAAM,QAAQ,mBAAmB,GAAG,GAAG,CAAC,mBAAmB,CAAC;IAE5D,MAAM,QAAQ,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IACpC,MAAM,QAAQ,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;IAC1D,MAAM,QAAQ,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;CACjD;AAED,eAAe,KAAK,CAAC"}