modern-treasury 0.0.1

package/.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'unused-imports', 'prettier'],
+  rules: {
+    'no-unused-vars': 'off',
+    'prettier/prettier': 'error',
+    'unused-imports/no-unused-imports': 'error',
+  },
+  root: true,
+};

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "arrowParens": "always",
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 110
+}

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Modern Treasury
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,198 @@
+# ModernTreasury Node API Library
+
+[![NPM version](https://img.shields.io/npm/v/modern-treasury.svg)](https://npmjs.org/package/modern-treasury)
+
+The ModernTreasury Node library provides convenient access to the ModernTreasury REST API from applications written in server-side JavaScript.
+It includes TypeScript definitions for all request params and response fields.
+
+## Documentation
+
+The API documentation can be found [here](https://docs.moderntreasury.com).
+
+## Installation
+
+```sh
+npm install --save modern-treasury
+# or
+yarn add modern-treasury
+```
+
+## Usage
+
+```js
+import ModernTreasury from 'modern-treasury';
+
+const modernTreasury = new ModernTreasury({
+  apiKey: 'my api key', // defaults to process.env["MODERN_TREASURY_API_KEY"]
+  organizationId: 'my organization id',
+});
+
+async function main() {
+  const externalAccount = await modernTreasury.externalAccounts.create({
+    counterparty_id: '123',
+    name: 'my bank',
+  });
+
+  console.log(externalAccount.id);
+}
+main();
+```
+
+### Usage with TypeScript
+
+Importing, instantiating, and interacting with the library are the same as above.
+If you like, you may reference our types directly:
+
+```ts
+import ModernTreasury from 'modern-treasury';
+
+const modernTreasury = new ModernTreasury({
+  apiKey: 'my api key', // defaults to process.env["MODERN_TREASURY_API_KEY"]
+  organizationId: 'my organization id',
+});
+
+async function main() {
+  const params: ModernTreasury.ExternalAccountCreateParams = { counterparty_id: '123', name: 'my bank' };
+
+  const externalAccount: ModernTreasury.ExternalAccount = await modernTreasury.externalAccounts.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.
+
+## 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:
+
+```ts
+async function main() {
+  const externalAccount = await modernTreasury.externalAccounts
+    .create({ counterparty_id: 'missing' })
+    .catch((err) => {
+      if (err instanceof ModernTreasury.APIError) {
+        console.log(err.status); // 400
+        console.log(err.name); // BadRequestError
+
+        console.log(err.headers); // {server: 'nginx', ...}
+      }
+    });
+}
+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:
+
+<!-- prettier-ignore -->
+```js
+// Configure the default for all requests:
+const modernTreasury = new ModernTreasury({
+  maxRetries: 0, // default is 2
+  organizationId: 'my organization id',
+});
+
+// Or, configure per-request:
+modernTreasury.externalAccounts.list({
+  maxRetries: 5,
+});
+```
+
+### Timeouts
+
+Requests time out after 60 seconds by default. You can configure this with a `timeout` option:
+
+<!-- prettier-ignore -->
+```ts
+// Configure the default for all requests:
+const modernTreasury = new ModernTreasury({
+  timeout: 20 * 1000, // 20 seconds (default is 60s)
+  organizationId: 'my organization id',
+});
+
+// Override per-request:
+modernTreasury.externalAccounts.list({ party_name: 'my bank' }, {
+  timeout: 5 * 1000,
+});
+```
+
+On timeout, an `APIConnectionTimeoutError` is thrown.
+
+Note that requests which time out will be [retried twice by default](#retries).
+
+## Auto-pagination
+
+List methods in the ModernTreasury API are paginated.
+Use `for await … of` syntax to iterate through items across all pages.
+
+```js
+async function fetchAllExternalAccounts(params) {
+  const allExternalAccounts = [];
+  // Automatically fetches more pages as needed.
+  for await (const externalAccount of modernTreasury.externalAccounts.list()) {
+    allExternalAccounts.push(externalAccount);
+  }
+  return allExternalAccounts;
+}
+```
+
+## 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:
+
+<!-- prettier-ignore -->
+```ts
+import http from 'http';
+import HttpsProxyAgent from 'https-proxy-agent';
+
+// Configure the default for all requests:
+const modernTreasury = new ModernTreasury({
+  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
+  organizationId: 'my organization id',
+});
+
+// Override per-request:
+modernTreasury.externalAccounts.list({
+  baseURL: 'http://localhost:8080/test-api',
+  httpAgent: new http.Agent({ keepAlive: false }),
+})
+```
+
+## Status
+
+This package is in beta. Its internals and interfaces are not stable
+and subject to change without a major semver bump;
+please reach out if you rely on any undocumented behavior.
+
+We are keen for your feedback; please email us at [dev-feedback@moderntreasury.com](mailto:dev-feedback@moderntreasury.com)
+or open an issue with questions, bugs, or suggestions.
+
+## Requirements
+
+Node.js version 12 or higher.
+
+If you are interested in other runtime environments, please open or upvote an issue on Github.

package/build

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+rm -rf dist/*
+
+tsc -p tsconfig.cjs.json
+
+tsc-alias -p tsconfig.cjs.json
+
+yarn prettier --write .