https://github.com/moov-io/ach-node-sdk
Generated Typescript SDK for the moov-io/ach service
https://github.com/moov-io/ach-node-sdk
ach hacktoberfest node typescript
Last synced: 10 months ago
JSON representation
Generated Typescript SDK for the moov-io/ach service
- Host: GitHub
- URL: https://github.com/moov-io/ach-node-sdk
- Owner: moov-io
- Created: 2020-05-18T19:33:34.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T13:06:21.000Z (over 1 year ago)
- Last Synced: 2024-12-04T14:19:57.876Z (over 1 year ago)
- Topics: ach, hacktoberfest, node, typescript
- Language: TypeScript
- Homepage: https://moov-io.github.io/ach-node-sdk/docs/
- Size: 1.59 MB
- Stars: 17
- Watchers: 5
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ACH Node SDK
Generated Typescript SDK for the [moov-io/ach](https://github.com/moov-io/ach) service.
## Installation
Install in your Node.js or Typescript project using npm:
```bash
npm install ach-node-sdk
```
## Usage
Using `require` sytax:
```js
const { ACHFilesApi, Configuration } = require('ach-node-sdk');
```
Using `import` syntax:
```js
import { ACHFilesApi, Configuration } from 'ach-node-sdk';
```
Build the client instance:
```js
const configuration = new Configuration({ basePath: 'https://ach.mycompany.com' });
const achFilesApi = new ACHFilesApi(configuration);
```
Call functions on the client:
```js
achFilesApi.getFiles().then(response => console.log(response.data));
=> Promise{ }
{ files: [], error: null };
```
See the [generated documentation](https://moov-io.github.io/ach-node-sdk/docs/) 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
```