Skip to content

moov-io/ach-node-sdk

Repository files navigation

ACH Node SDK

Generated Typescript SDK for the moov-io/ach service.

Installation

Install in your Node.js or Typescript project using npm:

npm install ach-node-sdk

Usage

Using require sytax:

const { ACHFilesApi, Configuration } = require('ach-node-sdk');

Using import syntax:

import { ACHFilesApi, Configuration } from 'ach-node-sdk';

Build the client instance:

const configuration = new Configuration({ basePath: 'https://ach.mycompany.com' });
const achFilesApi = new ACHFilesApi(configuration);

Call functions on the client:

achFilesApi.getFiles().then(response => console.log(response.data));
=> Promise{ <pending> }
{ files: [], error: null };

See the generated documentation for more detail.

Building Locally

Run the following to build our library locally.

tsc --build tsconfig.json

Generating Client

Run the following for generating the TypeScript client.

make client

Generating Docs

Run the following for generating the documentation.

make docs