Comparing version 0.0.10 to 2.4.2
{ | ||
"name": "mx-atrium", | ||
"version": "0.0.10", | ||
"description": "Node wrapper for the MX Atrium API", | ||
"main": "index.js", | ||
"scripts": { | ||
"test": "eslint index.js" | ||
}, | ||
"author": "MX", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/mxenabled/mx-atrium-node/issues" | ||
}, | ||
"homepage": "https://github.com/mxenabled/mx-atrium-node", | ||
"dependencies": { | ||
"es6-promise": "^4.0.5", | ||
"isomorphic-fetch": "^2.2.1" | ||
}, | ||
"devDependencies": { | ||
"eslint": "^3.7.1" | ||
} | ||
"name": "mx-atrium", | ||
"version": "2.4.2", | ||
"description": "NodeJS client for mx-atrium-node", | ||
"repository": "mxenabled/mx-atrium-node", | ||
"main": "api.js", | ||
"types": "api.d.ts", | ||
"scripts": { | ||
"clean": "rm -Rf node_modules/ *.js", | ||
"build": "tsc", | ||
"test": "npm run build && node client.js" | ||
}, | ||
"author": "MX", | ||
"license": "MIT", | ||
"dependencies": { | ||
"bluebird": "^3.5.0", | ||
"request": "^2.81.0", | ||
"@types/bluebird": "*", | ||
"@types/request": "*" | ||
}, | ||
"devDependencies": { | ||
"typescript": "^2.4.2" | ||
}, | ||
"publishConfig": { | ||
"registry": "https://registry.npmjs.org/" | ||
} | ||
} |
@@ -1,48 +0,37 @@ | ||
# MX Atrium | ||
[![npm version](https://badge.fury.io/js/mx-atrium.svg)](http://badge.fury.io/js/mx-atrium) [![Build Status](https://travis-ci.org/mxenabled/mx-atrium-node.svg?branch=master)](https://travis-ci.org/mxenabled/mx-atrium-node) | ||
# MX API | ||
The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification. Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes. Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. | ||
## Description | ||
This is a Node wrapper for the [MX Atrium API](https://atrium.mx.com). It is intended to be used as a helper for the implementation of a proxy server. To get an API key and Client ID, [click here](https://atrium.mx.com/developers/sign_up). | ||
## Installation & Usage | ||
## Installation | ||
### Install dependencies | ||
```sh | ||
npm install | ||
``` | ||
npm install mx-atrium | ||
``` | ||
## Usage | ||
### Generate JavaScript file | ||
```sh | ||
npm run build | ||
``` | ||
const Atrium = require('mx-atrium'); | ||
const AtriumClient = new Atrium.Client('API_KEY', 'CLIENT_ID', Atrium.environments.sand); | ||
``` | ||
## Example Usage | ||
Sample Express.js route | ||
``` | ||
app.get('/institutions', (request, response) => { | ||
AtriumClient.listInstitutions(request) | ||
.then(json => { | ||
response.json(json); | ||
}); | ||
}); | ||
``` | ||
Please see `docs` directory for additional endpoint examples | ||
For a complete express.js server example, [click here](https://github.com/mxenabled/mx-atrium-express). | ||
```javascript | ||
var atrium = require('./atrium.js'); | ||
## Helpers | ||
var client = new atrium.AtriumClient("YOUR_API_KEY", "YOUR_CLIENT_ID"); | ||
There are two constants returned with the Atrium instance, `endpoints` and `environments`. | ||
var accountGuid = "ACT-123"; // string | The unique identifier for an `account`. | ||
var userGuid = "USR-123"; // string | The unique identifier for a `user`. | ||
var fromDate = "2016-09-20"; // string | Filter transactions from this date. (optional) | ||
var toDate = "2016-10-20"; // string | Filter transactions to this date. (optional) | ||
var page = 1; // number | Specify current page. (optional) | ||
var recordsPerPage = 12; // number | Specify records per page. (optional) | ||
#### Atrium.environments | ||
This returns a `sand` and `production` URL that must be passed to the new client. | ||
var response = client.accounts.listAccountTransactions(accountGuid, userGuid, fromDate, toDate, page, recordsPerPage); | ||
#### Atrium.endpoints | ||
This returns an array of objects that can be used to build routes for the server. | ||
Sample object | ||
response.then(function(value) { | ||
console.log(value); | ||
}); | ||
``` | ||
{ | ||
method: 'post', | ||
url: '/users', | ||
clientMethod: 'createUser' | ||
} | ||
``` |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
606820
21
10826
1
4
1
38
+ Added@types/bluebird@*
+ Added@types/request@*
+ Addedbluebird@^3.5.0
+ Addedrequest@^2.81.0
+ Added@types/bluebird@3.5.42(transitive)
+ Added@types/caseless@0.12.5(transitive)
+ Added@types/node@22.13.1(transitive)
+ Added@types/request@2.48.12(transitive)
+ Added@types/tough-cookie@4.0.5(transitive)
+ Addedajv@6.12.6(transitive)
+ Addedasn1@0.2.6(transitive)
+ Addedassert-plus@1.0.0(transitive)
+ Addedasynckit@0.4.0(transitive)
+ Addedaws-sign2@0.7.0(transitive)
+ Addedaws4@1.13.2(transitive)
+ Addedbcrypt-pbkdf@1.0.2(transitive)
+ Addedbluebird@3.7.2(transitive)
+ Addedcaseless@0.12.0(transitive)
+ Addedcombined-stream@1.0.8(transitive)
+ Addedcore-util-is@1.0.2(transitive)
+ Addeddashdash@1.14.1(transitive)
+ Addeddelayed-stream@1.0.0(transitive)
+ Addedecc-jsbn@0.1.2(transitive)
+ Addedextend@3.0.2(transitive)
+ Addedextsprintf@1.3.0(transitive)
+ Addedfast-deep-equal@3.1.3(transitive)
+ Addedfast-json-stable-stringify@2.1.0(transitive)
+ Addedforever-agent@0.6.1(transitive)
+ Addedform-data@2.3.32.5.2(transitive)
+ Addedgetpass@0.1.7(transitive)
+ Addedhar-schema@2.0.0(transitive)
+ Addedhar-validator@5.1.5(transitive)
+ Addedhttp-signature@1.2.0(transitive)
+ Addedis-typedarray@1.0.0(transitive)
+ Addedisstream@0.1.2(transitive)
+ Addedjsbn@0.1.1(transitive)
+ Addedjson-schema@0.4.0(transitive)
+ Addedjson-schema-traverse@0.4.1(transitive)
+ Addedjson-stringify-safe@5.0.1(transitive)
+ Addedjsprim@1.4.2(transitive)
+ Addedmime-db@1.52.0(transitive)
+ Addedmime-types@2.1.35(transitive)
+ Addedoauth-sign@0.9.0(transitive)
+ Addedperformance-now@2.1.0(transitive)
+ Addedpsl@1.15.0(transitive)
+ Addedpunycode@2.3.1(transitive)
+ Addedqs@6.5.3(transitive)
+ Addedrequest@2.88.2(transitive)
+ Addedsafe-buffer@5.2.1(transitive)
+ Addedsshpk@1.18.0(transitive)
+ Addedtough-cookie@2.5.0(transitive)
+ Addedtunnel-agent@0.6.0(transitive)
+ Addedtweetnacl@0.14.5(transitive)
+ Addedundici-types@6.20.0(transitive)
+ Addeduri-js@4.4.1(transitive)
+ Addeduuid@3.4.0(transitive)
+ Addedverror@1.10.0(transitive)
- Removedes6-promise@^4.0.5
- Removedisomorphic-fetch@^2.2.1
- Removedencoding@0.1.13(transitive)
- Removedes6-promise@4.2.8(transitive)
- Removediconv-lite@0.6.3(transitive)
- Removedis-stream@1.1.0(transitive)
- Removedisomorphic-fetch@2.2.1(transitive)
- Removednode-fetch@1.7.3(transitive)
- Removedwhatwg-fetch@3.6.20(transitive)