modern-treasury
Advanced tools
This library provides convenient access to the Modern Treasury REST API from server-side TypeScript or JavaScript.
The REST API documentation can be found on docs.moderntreasury.com. The full API of this library can be found in api.md.
npm install modern-treasury
The full API of this library can be found in api.md.
import ModernTreasury from 'modern-treasury';
const modernTreasury = new ModernTreasury({
organizationId: process.env['MODERN_TREASURY_ORGANIZATION_ID'], // This is the default and can be omitted
apiKey: process.env['MODERN_TREASURY_API_KEY'], // This is the default and can be omitted
});
async function main() {
const counterparty = await modernTreasury.counterparties.create({ name: 'my first counterparty' });
console.log(counterparty.id);
}
main();
This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
import ModernTreasury from 'modern-treasury';
const modernTreasury = new ModernTreasury({
organizationId: process.env['MODERN_TREASURY_ORGANIZATION_ID'], // This is the default and can be omitted
apiKey: process.env['MODERN_TREASURY_API_KEY'], // This is the default and can be omitted
});
async function main() {
const params: ModernTreasury.CounterpartyCreateParams = { name: 'my first counterparty' };
const counterparty: ModernTreasury.Counterparty = await modernTreasury.counterparties.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.
Request parameters that correspond to file uploads can be passed in many different forms:
File (or an object with the same structure)fetch Response (or an object with the same structure)fs.ReadStreamtoFile helperimport fs from 'fs';
import fetch from 'node-fetch';
import ModernTreasury, { toFile } from 'modern-treasury';
const modernTreasury = new ModernTreasury();
// If you have access to Node `fs` we recommend using `fs.createReadStream()`:
await modernTreasury.documents.create({
documentable_id: '24c6b7a3-02...',
documentable_type: 'counterparties',
file: fs.createReadStream('my/file.txt'),
});
// Or if you have the web `File` API you can pass a `File` instance:
await modernTreasury.documents.create({
documentable_id: '24c6b7a3-02...',
documentable_type: 'counterparties',
file: new File(['my bytes'], 'file.txt'),
});
// You can also pass a `fetch` `Response`:
await modernTreasury.documents.create({
documentable_id: '24c6b7a3-02...',
documentable_type: 'counterparties',
file: await fetch('https://somesite/file.txt'),
});
// Finally, if none of the above are convenient, you can use our `toFile` helper:
await modernTreasury.documents.create({
documentable_id: '24c6b7a3-02...',
documentable_type: 'counterparties',
file: await toFile(Buffer.from('my bytes'), 'file.txt'),
});
await modernTreasury.documents.create({
documentable_id: '24c6b7a3-02...',
documentable_type: 'counterparties',
file: await toFile(new Uint8Array([0, 1, 2]), 'file.txt'),
});
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 externalAccount = await modernTreasury.externalAccounts
.create({ counterparty_id: 'missing' })
.catch(async (err) => {
if (err instanceof ModernTreasury.APIError) {
console.log(err.status); // 400
console.log(err.name); // BadRequestError
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 |
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), 408 Request Timeout, 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 modernTreasury = new ModernTreasury({
maxRetries: 0, // default is 2
});
// Or, configure per-request:
await modernTreasury.counterparties.create({ name: 'my first counterparty' }, {
maxRetries: 5,
});
Requests time out after 1 minute by default. You can configure this with a timeout option:
// Configure the default for all requests:
const modernTreasury = new ModernTreasury({
timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});
// Override per-request:
await modernTreasury.counterparties.create({ name: 'my first counterparty' }, {
timeout: 5 * 1000,
});
On timeout, an APIConnectionTimeoutError is thrown.
Note that requests which time out will be retried twice by default.
List methods in the ModernTreasury API are paginated.
You can use for await … of syntax to iterate through items across all pages:
async function fetchAllCounterparties(params) {
const allCounterparties = [];
// Automatically fetches more pages as needed.
for await (const counterparty of modernTreasury.counterparties.list()) {
allCounterparties.push(counterparty);
}
return allCounterparties;
}
Alternatively, you can make request a single page at a time:
let page = await modernTreasury.counterparties.list();
for (const counterparty of page.items) {
console.log(counterparty);
}
// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
page = page.getNextPage();
// ...
}
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 modernTreasury = new ModernTreasury();
const response = await modernTreasury.counterparties.create({ name: 'my first counterparty' }).asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object
const { data: counterparty, response: raw } = await modernTreasury.counterparties
.create({ name: 'my first counterparty' })
.withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(counterparty.id);
This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.
To make requests to undocumented endpoints, you can use client.get, client.post, and other HTTP verbs.
Options on the client, such as retries, will be respected when making these requests.
await client.post('/some/path', {
body: { some_prop: 'foo' },
query: { some_query_arg: 'bar' },
});
To make requests using undocumented parameters, you may use // @ts-expect-error on the undocumented
parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you
send will be sent as-is.
client.foo.create({
foo: 'my_param',
bar: 12,
// @ts-expect-error baz is not yet public
baz: 'undocumented option',
});
For requests with the GET verb, any extra params will be in the query, all other requests will send the
extra param in the body.
If you want to explicitly send an extra argument, you can do so with the query, body, and headers request
options.
To access undocumented response properties, you may access the response object with // @ts-expect-error on
the response object, or cast the response object to the requisite type. Like the request params, we do not
validate or strip extra properties from the response from the API.
By default, this library uses node-fetch in Node, and expects a global fetch function in other environments.
If you would prefer to use a global, web-standards-compliant fetch function even in a Node environment,
(for example, if you are running Node with --experimental-fetch or using NextJS which polyfills with undici),
add the following import before your first import from "ModernTreasury":
// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
import 'modern-treasury/shims/web';
import ModernTreasury from 'modern-treasury';
To do the inverse, add import "modern-treasury/shims/node" (which does import polyfills).
This can also be useful if you are getting the wrong TypeScript types for Response (more details).
You may also provide a custom fetch function when instantiating the client,
which can be used to inspect or alter the Request or Response before/after each request:
import { fetch } from 'undici'; // as one example
import ModernTreasury from 'modern-treasury';
const client = new ModernTreasury({
fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => {
console.log('About to make a request', url, init);
const response = await fetch(url, init);
console.log('Got response', response);
return response;
},
});
Note that if given a DEBUG=true environment variable, this library will log all requests and responses automatically.
This is intended for debugging purposes only and may change in the future without notice.
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 modernTreasury = new ModernTreasury({
httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
});
// Override per-request:
await modernTreasury.counterparties.create(
{ name: 'my first counterparty' },
{
httpAgent: new http.Agent({ keepAlive: false }),
},
);
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
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.
TypeScript >= 4.5 is supported.
The following runtimes are supported:
import ModernTreasury from "npm:modern-treasury"."node" environment ("jsdom" is not supported at this time).Note that React Native is not supported at this time.
If you are interested in other runtime environments, please open or upvote an issue on GitHub.
FAQs
The official TypeScript library for the Modern Treasury API
The npm package modern-treasury receives a total of 20,163 weekly downloads. As such, modern-treasury popularity was classified as popular.
We found that modern-treasury demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.