@tryfinch/finch-api 1.0.0

package/dist/cjs/tests/api-resources/top-level.test.js

@@ -0,0 +1,52 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P ? value : (
+          new P(function (resolve) {
+            resolve(value);
+          })
+        );
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+const index_1 = __importDefault(require('../../index'));
+const finch = new index_1.default({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+describe('top level methods', () => {
+  test('getAccessToken', () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      // TODO
+    }));
+  test('getAuthUrl', () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      // TODO
+    }));
+});
+//# sourceMappingURL=top-level.test.js.map

package/dist/cjs/tests/api-resources/top-level.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level.test.js","sourceRoot":"","sources":["../../../../tests/api-resources/top-level.test.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;;;;;;;;;;AAErD,oDAA4B;AAE5B,MAAM,KAAK,GAAG,IAAI,eAAK,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC,CAAC;AAE5F,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,IAAI,CAAC,gBAAgB,EAAE,GAAS,EAAE;QAChC,OAAO;IACT,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,EAAE,GAAS,EAAE;QAC5B,OAAO;IACT,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/tests/form.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=form.test.d.ts.map

package/dist/cjs/tests/form.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.test.d.ts","sourceRoot":"","sources":["../../../tests/form.test.ts"],"names":[],"mappings":""}

package/dist/cjs/tests/form.test.js

@@ -0,0 +1,61 @@
+'use strict';
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P ? value : (
+          new P(function (resolve) {
+            resolve(value);
+          })
+        );
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+const core_1 = require('../core');
+const formdata_node_1 = require('formdata-node');
+const file_from_path_1 = require('formdata-node/file-from-path');
+describe('form data validation', () => {
+  test('valid values do not error', () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      (0, core_1.multipartFormRequestOptions)({
+        body: {
+          foo: 'foo',
+          string: 1,
+          bool: true,
+          file: yield (0, file_from_path_1.fileFromPath)('README.md'),
+          blob: new formdata_node_1.Blob(['Some content'], { type: 'text/plain' }),
+        },
+      });
+    }));
+  test('null', () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      expect(() =>
+        (0, core_1.multipartFormRequestOptions)({
+          body: {
+            null: null,
+          },
+        }),
+      ).toThrow(TypeError);
+    }));
+});
+//# sourceMappingURL=form.test.js.map

package/dist/cjs/tests/form.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.test.js","sourceRoot":"","sources":["../../../tests/form.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,iCAAqD;AACrD,iDAAqC;AACrC,iEAA4D;AAE5D,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,IAAI,CAAC,2BAA2B,EAAE,GAAS,EAAE;QAC3C,IAAA,kCAA2B,EAAC;YAC1B,IAAI,EAAE;gBACJ,GAAG,EAAE,KAAK;gBACV,MAAM,EAAE,CAAC;gBACT,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,MAAM,IAAA,6BAAY,EAAC,WAAW,CAAC;gBACrC,IAAI,EAAE,IAAI,oBAAI,CAAC,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;aACzD;SACF,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,EAAE,GAAS,EAAE;QACtB,MAAM,CAAC,GAAG,EAAE,CACV,IAAA,kCAA2B,EAAC;YAC1B,IAAI,EAAE;gBACJ,IAAI,EAAE,IAAI;aACX;SACF,CAAC,CACH,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/tests/index.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.test.d.ts.map

package/dist/cjs/tests/index.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../../tests/index.test.ts"],"names":[],"mappings":""}

package/dist/cjs/tests/index.test.js

@@ -0,0 +1,34 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+const index_1 = __importDefault(require('../index'));
+describe('instantiate client', () => {
+  const env = process.env;
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = Object.assign({}, env);
+    console.warn = jest.fn();
+  });
+  afterEach(() => {
+    process.env = env;
+  });
+  test('with accessToken argument', () => {
+    const client = new index_1.default({ accessToken: 'another access token' });
+    expect(client.accessToken).toBe('another access token');
+  });
+  test('with options argument', () => {
+    // accessToken
+    const client = new index_1.default({ accessToken: 'my access token' });
+    expect(client.accessToken).toBe('my access token');
+  });
+  test('with disabled authentication', () => {
+    const client = new index_1.default({ accessToken: null });
+    expect(client.accessToken).toBeNull();
+  });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/cjs/tests/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../tests/index.test.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;;;AAErD,qDAA6B;AAE7B,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,qBAAQ,GAAG,CAAE,CAAC;QAEzB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,eAAK,CAAC,EAAE,WAAW,EAAE,sBAAsB,EAAE,CAAC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACjC,cAAc;QACd,MAAM,MAAM,GAAG,IAAI,eAAK,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACxC,MAAM,MAAM,GAAG,IAAI,eAAK,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/tests/responses.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=responses.test.d.ts.map

package/dist/cjs/tests/responses.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.test.d.ts","sourceRoot":"","sources":["../../../tests/responses.test.ts"],"names":[],"mappings":""}

package/dist/cjs/tests/responses.test.js

@@ -0,0 +1,60 @@
+'use strict';
+var __awaiter =
+  (this && this.__awaiter) ||
+  function (thisArg, _arguments, P, generator) {
+    function adopt(value) {
+      return value instanceof P ? value : (
+          new P(function (resolve) {
+            resolve(value);
+          })
+        );
+    }
+    return new (P || (P = Promise))(function (resolve, reject) {
+      function fulfilled(value) {
+        try {
+          step(generator.next(value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function rejected(value) {
+        try {
+          step(generator['throw'](value));
+        } catch (e) {
+          reject(e);
+        }
+      }
+      function step(result) {
+        result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected);
+      }
+      step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+  };
+Object.defineProperty(exports, '__esModule', { value: true });
+const core_1 = require('../core');
+const node_fetch_1 = require('node-fetch');
+describe('response parsing', () => {
+  // TODO: test unicode characters
+  test('headers are case agnostic', () =>
+    __awaiter(void 0, void 0, void 0, function* () {
+      const headers = (0, core_1.createResponseHeaders)(
+        new node_fetch_1.Headers({ 'Content-Type': 'foo', Accept: 'text/plain' }),
+      );
+      expect(headers['content-type']).toEqual('foo');
+      expect(headers['Content-type']).toEqual('foo');
+      expect(headers['Content-Type']).toEqual('foo');
+      expect(headers['accept']).toEqual('text/plain');
+      expect(headers['Accept']).toEqual('text/plain');
+      expect(headers['Hello-World']).toBeUndefined();
+    }));
+  test('duplicate headers are concatenated', () => {
+    const headers = (0, core_1.createResponseHeaders)(
+      new node_fetch_1.Headers([
+        ['Content-Type', 'text/xml'],
+        ['Content-Type', 'application/json'],
+      ]),
+    );
+    expect(headers['content-type']).toBe('text/xml, application/json');
+  });
+});
+//# sourceMappingURL=responses.test.js.map

package/dist/cjs/tests/responses.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.test.js","sourceRoot":"","sources":["../../../tests/responses.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,iCAA+C;AAC/C,2CAAqC;AAErC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,gCAAgC;IAChC,IAAI,CAAC,2BAA2B,EAAE,GAAS,EAAE;QAC3C,MAAM,OAAO,GAAG,IAAA,4BAAqB,EAAC,IAAI,oBAAO,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;QACpG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAChD,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAChD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACjD,CAAC,CAAA,CAAC,CAAC;IAEH,IAAI,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC9C,MAAM,OAAO,GAAG,IAAA,4BAAqB,EACnC,IAAI,oBAAO,CAAC;YACV,CAAC,cAAc,EAAE,UAAU,CAAC;YAC5B,CAAC,cAAc,EAAE,kBAAkB,CAAC;SACrC,CAAC,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = '1.0.0';
+//# sourceMappingURL=version.d.ts.map

package/dist/cjs/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/dist/cjs/version.js

@@ -0,0 +1,5 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '1.0.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/dist/cjs/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/fetch-polyfill.ts

@@ -0,0 +1,69 @@
+import type NodeFetch from 'node-fetch';
+import type { RequestInfo, RequestInit, Response } from 'node-fetch';
+import type KeepAliveAgent from 'agentkeepalive';
+import type { Agent } from 'http';
+import { AbortController as AbortControllerPolyfill } from 'abort-controller';
+
+declare const Deno: any;
+// For now, we just pretend that Fetch is the same type as NodeFetch.
+declare const fetch: Fetch | undefined;
+
+let nodeFetch: typeof NodeFetch | undefined = undefined;
+let nodeFetchImportError: unknown;
+let defaultHttpAgent: Agent;
+let defaultHttpsAgent: Agent;
+
+// In a Node environment, we prefer `node-fetch` to other fetch implementations
+// which may be present, because it allows keepAlive and others don't.
+// Alternative, "Web Standards"-based environments typically provide fetch implementations
+// which provide good performance for this by default, and may not support node-fetch.
+const isProbablyNode = typeof process !== 'undefined' && typeof Deno === 'undefined';
+if (isProbablyNode) {
+  try {
+    /* eslint-disable @typescript-eslint/no-var-requires */
+    nodeFetch = require('node-fetch').default;
+    const KeepAliveHttpAgent: typeof KeepAliveAgent = require('agentkeepalive');
+    /* eslint-enable @typescript-eslint/no-var-requires */
+
+    defaultHttpAgent = new KeepAliveHttpAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+    defaultHttpsAgent = new KeepAliveHttpAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+  } catch (e) {
+    // We can fall back to a built-in "fetch".
+    nodeFetchImportError = e;
+  }
+}
+
+// Polyfill global object if needed.
+if (typeof AbortController === 'undefined') {
+  AbortController = AbortControllerPolyfill as typeof AbortController;
+}
+
+export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
+
+export const getFetch = (): Fetch => {
+  if (isProbablyNode && nodeFetch) {
+    return nodeFetch;
+  }
+
+  // For other environments, use a global fetch function expected to already be present
+  if (typeof fetch === 'undefined' || typeof fetch !== 'function') {
+    if (isProbablyNode) {
+      throw new Error(
+        `Could not import "node-fetch", and no global "fetch" function is defined.`,
+        // @ts-expect-error This is only Node 16.9.0+, but isn't harmful in other contexts.
+        { cause: nodeFetchImportError },
+      );
+    }
+    throw new Error(
+      `Unexpected: running in a non-Node environment without a global "fetch" function defined.`,
+    );
+  }
+
+  return fetch;
+};
+
+export const getDefaultAgent = (url: string): Agent | undefined => {
+  if (defaultHttpsAgent && url.startsWith('https')) return defaultHttpsAgent;
+  if (defaultHttpAgent) return defaultHttpAgent;
+  return undefined;
+};

package/index.ts

@@ -0,0 +1,212 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import qs from 'qs';
+import * as Core from './core';
+import * as Pagination from './pagination';
+import * as API from './resources';
+import type { Agent } from 'http';
+import * as FileFromPath from 'formdata-node/file-from-path';
+
+type Config = {
+  /**
+   * Set it to null if you want to send unauthenticated requests.
+   */
+  accessToken?: string | null;
+  baseURL?: string;
+  timeout?: number;
+  httpAgent?: Agent;
+  clientId?: string | null;
+  clientSecret?: string | null;
+};
+
+/** Instantiate the API Client. */
+export class Finch extends Core.APIClient {
+  accessToken: string | null;
+  clientId?: string | null;
+  clientSecret?: string | null;
+
+  constructor(config?: Config) {
+    const options: Config = {
+      accessToken: null,
+      baseURL: 'https://api.tryfinch.com',
+      ...config,
+    };
+
+    super({
+      baseURL: options.baseURL!,
+      timeout: options.timeout,
+      httpAgent: options.httpAgent,
+    });
+    this.accessToken = options.accessToken || null;
+
+    this.clientId = config?.clientId || process.env['FINCH_CLIENT_ID'] || null;
+    this.clientSecret = config?.clientSecret || process.env['FINCH_CLIENT_SECRET'] || null;
+  }
+
+  ats: API.ATS = new API.ATS(this);
+  hris: API.HRIS = new API.HRIS(this);
+  providers: API.Providers = new API.Providers(this);
+  account: API.Account = new API.Account(this);
+
+  /**
+   * 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> {
+    if (!this.clientId) {
+      throw new Error('Expected the clientId to be set in order to call getAccessToken');
+    }
+    if (!this.clientSecret) {
+      throw new Error('Expected the clientSecret to be set in order to call getAccessToken');
+    }
+    return this.post<Record<string, any>, { access_token: string }>('/auth/token', {
+      body: {
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
+        code: code,
+        redirect_uri: redirectUri,
+      },
+      headers: {
+        Authorization: null,
+      },
+    }).then((response) => response.access_token);
+  }
+  /**
+   * 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 {
+    if (!this.clientId) {
+      throw new Error('Expected the clientId to be set in order to call getAuthUrl');
+    }
+    const url = new URL('/authorize', 'https://connect.tryfinch.com/authorize');
+    url.search = qs.stringify(
+      {
+        client_id: this.clientId,
+        products: products,
+        redirect_uri: redirectUri,
+        sandbox: sandbox,
+      },
+      this.qsOptions(),
+    );
+    return url.toString();
+  }
+
+  protected override defaultHeaders(): Core.Headers {
+    return {
+      ...super.defaultHeaders(),
+      'Finch-API-Version': '2020-09-17',
+    };
+  }
+
+  protected override validateHeaders(headers: Core.Headers, customHeaders: Core.Headers) {
+    if (this.accessToken && headers['Authorization']) {
+      return;
+    }
+    if (customHeaders['Authorization'] === null) {
+      return;
+    }
+
+    throw new Error(
+      'Could not resolve authentication method. Expected the accessToken to be set. Or for the "Authorization" headers to be explicitly omitted',
+    );
+  }
+
+  protected override authHeaders(): Core.Headers {
+    if (this.accessToken == null) {
+      return {};
+    }
+    return { Authorization: `Bearer ${this.accessToken}` };
+  }
+
+  protected override qsOptions(): qs.IStringifyOptions {
+    return { arrayFormat: 'comma' };
+  }
+
+  static APIError = Core.APIError;
+
+  static APIConnectionError = Core.APIConnectionError;
+  static APIConnectionTimeoutError = Core.APIConnectionTimeoutError;
+
+  static BadRequestError = Core.BadRequestError;
+  static AuthenticationError = Core.AuthenticationError;
+  static PermissionDeniedError = Core.PermissionDeniedError;
+  static NotFoundError = Core.NotFoundError;
+  static ConflictError = Core.ConflictError;
+  static UnprocessableEntityError = Core.UnprocessableEntityError;
+  static RateLimitError = Core.RateLimitError;
+  static InternalServerError = Core.InternalServerError;
+}
+
+export const {
+  APIError,
+
+  APIConnectionError,
+  APIConnectionTimeoutError,
+
+  BadRequestError,
+  AuthenticationError,
+  PermissionDeniedError,
+  NotFoundError,
+  ConflictError,
+  UnprocessableEntityError,
+  RateLimitError,
+  InternalServerError,
+} = Finch;
+
+export import fileFromPath = FileFromPath.fileFromPath;
+
+export namespace Finch {
+  // Helper functions
+  export import fileFromPath = FileFromPath.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 Income = API.Income;
+  export import Location = API.Location;
+  export import Money = API.Money;
+  export import Paging = API.Paging;
+
+  export import Provider = API.Provider;
+  export import ProvidersSinglePage = API.ProvidersSinglePage;
+
+  export import DisconnectResponse = API.DisconnectResponse;
+  export import Introspection = API.Introspection;
+}
+
+exports = module.exports = Finch;
+export default Finch;

package/jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  moduleNameMapper: {
+    '^~/(.*)$': '<rootDir>/$1',
+  },
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@tryfinch/finch-api",
+  "version": "1.0.0",
+  "description": "Client library for the Finch API",
+  "author": "Finch <founders@tryfinch.com>",
+  "types": "dist/cjs/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "type": "commonjs",
+  "repository": "github:Finch-API/finch-api-node",
+  "license": "Apache-2.0",
+  "private": false,
+  "scripts": {
+    "test": "bin/check-test-server && yarn jest",
+    "build": "bash ./build",
+    "prepack": "yarn build",
+    "format": "prettier --write .",
+    "tsn": "ts-node -r tsconfig-paths/register",
+    "fix": "eslint --fix --ext ts,js ."
+  },
+  "dependencies": {
+    "@types/node": "^18.11.18",
+    "@types/node-fetch": "^2.6.1",
+    "@types/qs": "^6.9.7",
+    "abort-controller": "^3.0.0",
+    "agentkeepalive": "^4.2.1",
+    "digest-fetch": "^1.3.0",
+    "form-data-encoder": "1.7.2",
+    "formdata-node": "^4.3.2",
+    "node-fetch": "^2.6.7",
+    "qs": "^6.10.3"
+  },
+  "devDependencies": {
+    "@tryfinch/finch-api": "link:.",
+    "@types/jest": "^27.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "@typescript-eslint/parser": "^5.33.0",
+    "eslint": "^8.22.0",
+    "eslint-plugin-unused-imports": "^2.0.0",
+    "jest": "^28.1.0",
+    "prettier": "rattrayalex/prettier#postfix-ternaries",
+    "ts-jest": "^28.0.2",
+    "ts-node": "^10.5.0",
+    "tsc-alias": "^1.6.9",
+    "tsconfig-paths": "^3.12.0",
+    "typescript": "^4.8.2"
+  }
+}