# @quo-finance/synapsenode

> Node.js Library for SynapseFI API v3.1 Rest

Latest version **1.2.17** (published 2020-07-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @quo-finance/synapsenode
pnpm add @quo-finance/synapsenode
yarn add @quo-finance/synapsenode
bun add @quo-finance/synapsenode
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.17 |
| Published | 2020-07-24 |
| First published | 2020-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 43.5 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | tuckerhaas |
| Keywords | API, payments, synapsefi, synapsepay |

## Links

- npm: https://www.npmjs.com/package/@quo-finance/synapsenode
- npm.io page: https://npm.io/package/@quo-finance/synapsenode

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [dotenv](https://npm.io/package/dotenv.md) ^6.2.0
- [tunnel](https://npm.io/package/tunnel.md) 0.0.6

## Recent versions

- 1.2.17 (latest) — 2020-07-24
- 1.2.16 — 2020-07-23
- 1.2.15 — 2020-07-20
- 1.2.14 — 2020-07-20
- 1.2.13 — 2020-07-20
- 1.2.12 — 2020-07-20
- 1.2.11 — 2020-06-30

## README

# SynapseNode
![npm](https://img.shields.io/npm/v/synapsenode.svg)
![status](https://img.shields.io/badge/status-beta-yellow.svg)
Node.js Client Library for SynapseFI REST V3.1 API

## Code Examples
Please refer to [samples.md](samples.md) and our [API documentation](https://docs.synapsefi.com) for examples.

## Setup
```
npm install synapsenode
```

## Update
To update to the most recent version of synapsenode
```
npm update synapsenode
```

## Initialization
Require and configure dotenv:
```javascript
require('dotenv').config()
```
Create a .env file at the root directory and add the following variables to it:
```
CLIENT_ID=<YOUR_CLIENT_ID>
CLIENT_SECRET=<YOUR_CLIENT_SECRET>
FINGERPRINT=<YOUR_FINGERPRINT>
```
Initialize new Client:
```javascript
const Synapse = require('synapsenode');
const Client = Synapse.Client;

const client = new Client({
  client_id: process.env.CLIENT_ID,
  client_secret: process.env.CLIENT_SECRET,
  fingerprint: process.env.FINGERPRINT,
  ip_address: '<ip_address>',
  // isProduction boolean determines if production (true) or sandbox (false) endpoint is used
  isProduction: false
});
```

## Testing
Run the following command from the root package directory after the .env file is set up and '<OBJ_ID>' values are replaced in the test files:
```
npm test
```

## License
[MIT License](LICENSE)

---
_Source: https://npm.io/package/@quo-finance/synapsenode · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._