Merge pull request #13 from mxenabled/bm/readme_and_openapi_updates

brettmortensen · web-flow · commit 75fdffcf8c1c · 2021-11-30T15:19:51.000-07:00
README and OpenAPI updates
diff --git a/README.md b/README.md
@@ -1,24 +1,16 @@
-*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-node/issues) to report issues using the MX Platform API Node Library.*
+*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-node/issues) to report issues using the MX Platform Node.js library.*
 
-## MX Platform Node
+# MX Platform Node.js
 
-A Node.js library for the [MX Platform API](https://www.mx.com/products/platform-api).
+The [MX Platform API](https://www.mx.com/products/platform-api) is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
 
-### Documentation
+## Documentation
 
-See the [documentation](https://docs.mx.com/api).
+Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
 
-### Install
+## Requirements
 
-To build and compile the typescript sources to javascript use:
-
-```shell
-$ npm install mx-platform-node
-```
-
-### Getting Started
-
-The [openapi-generator](https://github.com/OpenAPITools/openapi-generator) creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
+The generated Node module can be used in the following environments:
 
 Environment
 * Node.js
@@ -33,15 +25,31 @@ Module system
 * CommonJS
 * ES6 module system
 
+## Installation
+
+To build and compile the TypeScript sources to JavaScript use:
+
+```shell
+npm install mx-platform-node
+```
+
+## Getting Started
+
 In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
 
+Please follow the [installation](#installation) procedure and then run the following code to create your first User:
+
 ```javascript
 import { Configuration, MxPlatformApi } from 'mx-platform-node';
 
 const configuration = new Configuration({
+  // Configure with your Client ID/API Key from https://dashboard.mx.com
+  username: 'Your Client ID',
+  password: 'Your API Key',
+
+  // Configure environment. https://int-api.mx.com for development, https://api.mx.com for production
   basePath: 'https://int-api.mx.com',
-  username: 'Client ID',
-  password: 'API Key',
+
   baseOptions: {
     headers: {
       Accept: 'application/vnd.mx.api.v1+json'
@@ -51,13 +59,30 @@ const configuration = new Configuration({
 
 const client = new MxPlatformApi(configuration);
 
-const userGuid = 'USR-123';
+const requestBody = {
+  user: {  
+    metadata: 'Creating a user!'
+  }
+};
 
-const response = await client.readUser(userGuid);
+const response = await client.createUser(requestBody);
 
 console.log(response.data);
 ```
 
+## Development
+
+This project was generated by the [OpenAPI Generator](https://openapi-generator.tech). To generate this library, verify you have the latest version of the `openapi-generator-cli` found [here.](https://github.com/OpenAPITools/openapi-generator#17---npm)
+
+Running the following command in this repo's directory will generate this library using the [MX Platform API OpenAPI spec](https://github.com/mxenabled/openapi/blob/master/openapi/mx_platform_api_beta.yml) with our [configuration and templates.](https://github.com/mxenabled/mx-platform-ruby/tree/master/openapi)
+```shell
+openapi-generator-cli generate \
+-i https://raw.githubusercontent.com/mxenabled/openapi/master/openapi/mx_platform_api_beta.yml \
+-g typescript-axios \
+-c ./openapi/config.yml \
+-t ./openapi/templates
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on [GitHub](https://github.com/mxenabled/mx-platform-node).
+Please [open an issue](https://github.com/mxenabled/mx-platform-node/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-node/pulls)
diff --git a/api.ts b/api.ts
@@ -970,18 +970,42 @@ export interface EnhanceTransactionResponse {
      * @memberof EnhanceTransactionResponse
      */
     'amount'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof EnhanceTransactionResponse
+     */
+    'categorized_by'?: number | null;
     /**
      * 
      * @type {string}
      * @memberof EnhanceTransactionResponse
      */
     'category'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnhanceTransactionResponse
+     */
+    'category_guid'?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof EnhanceTransactionResponse
+     */
+    'described_by'?: number | null;
     /**
      * 
      * @type {string}
      * @memberof EnhanceTransactionResponse
      */
     'description'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnhanceTransactionResponse
+     */
+    'extended_transaction_type'?: string | null;
     /**
      * 
      * @type {string}
@@ -1036,6 +1060,18 @@ export interface EnhanceTransactionResponse {
      * @memberof EnhanceTransactionResponse
      */
     'is_payroll_advance'?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof EnhanceTransactionResponse
+     */
+    'is_subscription'?: boolean | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnhanceTransactionResponse
+     */
+    'memo'?: string | null;
     /**
      * 
      * @type {number}
@@ -1048,6 +1084,12 @@ export interface EnhanceTransactionResponse {
      * @memberof EnhanceTransactionResponse
      */
     'merchant_guid'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnhanceTransactionResponse
+     */
+    'merchant_location_guid'?: string | null;
     /**
      * 
      * @type {string}
@@ -1079,12 +1121,24 @@ export interface EnhanceTransactionsRequest {
      * @memberof EnhanceTransactionsRequest
      */
     'description': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnhanceTransactionsRequest
+     */
+    'extended_transaction_type'?: string;
     /**
      * 
      * @type {string}
      * @memberof EnhanceTransactionsRequest
      */
     'id': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EnhanceTransactionsRequest
+     */
+    'memo'?: string;
     /**
      * 
      * @type {number}
@@ -3118,6 +3172,12 @@ export interface TransactionResponse {
      * @memberof TransactionResponse
      */
     'category'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TransactionResponse
+     */
+    'category_guid'?: string | null;
     /**
      * 
      * @type {string}
@@ -3148,6 +3208,12 @@ export interface TransactionResponse {
      * @memberof TransactionResponse
      */
     'description'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof TransactionResponse
+     */
+    'extended_transaction_type'?: string | null;
     /**
      * 
      * @type {string}
diff --git a/openapi/config.yml b/openapi/config.yml
@@ -1,3 +1,3 @@
 npmName: "mx-platform-node"
-npmVersion: 0.4.1
+npmVersion: 0.4.2
 supportsES6: true
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "mx-platform-node",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A Node library for the MX Platform API.",
   "author": "MX",
   "keywords": [

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "mx-platform-node",`
`3`		`- "version": "0.4.1",`
	`3`	`+ "version": "0.4.2",`
`4`	`4`	`"description": "A Node library for the MX Platform API.",`
`5`	`5`	`"author": "MX",`
`6`	`6`	`"keywords": [`