increase

Increase Node API Library

This library provides convenient access to the Increase Node REST API from server-side TypeScript or JavaScript.

The API documentation can be found here.

Installation

npm install --save increase
# or
yarn add increase

Usage

The full API of this library can be found in api.md.

import Increase from 'increase';

const increase = new Increase({
  apiKey: 'my api key', // defaults to process.env["INCREASE_API_KEY"]
  environment: 'sandbox', // defaults to 'production'
});

async function main() {
  const account = await increase.accounts.create({ name: 'My First Increase Account' });

  console.log(account.id);
}

main();

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

import Increase from 'increase';

const increase = new Increase({
  apiKey: 'my api key', // defaults to process.env["INCREASE_API_KEY"]
  environment: 'sandbox', // defaults to 'production'
});

async function main() {
  const params: Increase.AccountCreateParams = { name: 'My First Increase Account' };
  const account: Increase.Account = await increase.accounts.create(params);
}

main();

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

File Uploads

Request parameters that correspond to file uploads can be passed in many different forms:

• File (or an object with the same structure)
• a fetch Response (or an object with the same structure)
• an fs.ReadStream
• the return value of our toFile helper

import fs from 'fs';
import fetch from 'node-fetch';
import Increase, { toFile } from 'increase';

const increase = new Increase();

// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
await increase.files.create({ file: fs.createReadStream('my/file.txt'), purpose: 'other' });

// Or if you have the web `File` API you can pass a `File` instance:
await increase.files.create({ file: new File(['my bytes'], 'file.txt'), purpose: 'other' });

// You can also pass a `fetch` `Response`:
await increase.files.create({ file: await fetch('https://somesite/file.txt'), purpose: 'other' });

// Finally, if none of the above are convenient, you can use our `toFile` helper:
await increase.files.create({ file: await toFile(Buffer.from('my bytes'), 'file.txt'), purpose: 'other' });
await increase.files.create({ file: await toFile(new Uint8Array([0, 1, 2]), 'file.txt'), purpose: 'other' });

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of APIError will be thrown:

async function main() {
  const account = await increase.accounts.create({ name: 'x' }).catch((err) => {
    if (err instanceof Increase.APIError) {
      console.log(err.status); // 400
      console.log(err.name); // BadRequestError
      console.log(err.error?.type); // missing_param
      console.log(err.error?.title); // Missing param "name"
      console.log(err.error?.detail); // Looks like "naem" may have been a typo?
      console.log(err.error?.status); // 400
      console.log(err.headers); // {server: 'nginx', ...}
    } else {
      throw err;
    }
  });
}

main();

Error codes are as followed:

Status Code	Error Type
400	BadRequestError
401	AuthenticationError
403	PermissionDeniedError
404	NotFoundError
422	UnprocessableEntityError
429	RateLimitError
>=500	InternalServerError
N/A	APIConnectionError

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.

You can use the maxRetries option to configure or disable this:

// Configure the default for all requests:
const increase = new Increase({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await increase.accounts.create({ name: 'Jack' }, {
  maxRetries: 5,
});

Timeouts

Requests time out after 1 minute by default. You can configure this with a timeout option:

// Configure the default for all requests:
const increase = new Increase({
  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});

// Override per-request:
await increase.accounts.list({ status: 'open' }, {
  timeout: 5 * 1000,
});

On timeout, an APIConnectionTimeoutError is thrown.

Note that requests which time out will be retried twice by default.

Auto-pagination

List methods in the Increase API are paginated. You can use for await … of syntax to iterate through items across all pages:

async function fetchAllAccounts(params) {
  const allAccounts = [];
  // Automatically fetches more pages as needed.
  for await (const account of increase.accounts.list()) {
    allAccounts.push(account);
  }
  return allAccounts;
}

Alternatively, you can make request a single page at a time:

let page = await increase.accounts.list();
for (const account of page.data) {
  console.log(account);
}

// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
  page = page.getNextPage();
  // ...
}

Advanced Usage

Accessing raw Response data (e.g., headers)

The "raw" Response returned by fetch() can be accessed through the .asResponse() method on the APIPromise type that all methods return.

You can also use the .withResponse() method to get the raw Response along with the parsed data.

const increase = new Increase();

const response = await increase.accounts.create({ name: 'My First Increase Account' }).asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object

const { data: accounts, response: raw } = await increase.accounts
  .create({ name: 'My First Increase Account' })
  .withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(accounts.id);

Configuring an HTTP(S) Agent (e.g., for proxies)

By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.

If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an httpAgent which is used for all requests (be they http or https), for example:

import http from 'http';
import HttpsProxyAgent from 'https-proxy-agent';

// Configure the default for all requests:
const increase = new Increase({
  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
});

// Override per-request:
await increase.accounts.list({ status: 'open' }, {
  baseURL: 'http://localhost:8080/test-api',
  httpAgent: new http.Agent({ keepAlive: false }),
})

Semantic Versioning

This package generally attempts to follow SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Requirements

TypeScript >= 4.5 is supported.

The following runtimes are supported:

• Node.js 16 LTS or later (non-EOL) versions.
• Deno v1.28.0 or higher, using import Increase from "npm:increase". Deno Deploy is not yet supported.
• Cloudflare Workers.
• Vercel Edge Runtime.

If you are interested in other runtime environments, please open or upvote an issue on GitHub.

Changelog

0.11.0 (2023-09-12)

Full Changelog: v0.10.4...v0.11.0

⚠ BREAKING CHANGES

• api: remove Limits API, add ACH controls to Account Numbers (#156)

Features

• api: remove Limits API, add ACH controls to Account Numbers (#156) (4e4d1b2)