investec-openapi - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

package.json

 {
   "name": "investec-openapi",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "A JavaScript/TypeScript wrapper to get up and running fast with Investec's Open API for programmable banking.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -5,2 +5,174 @@ # Investec Programmable Banking Open API Wrapper
 
-# Documentation Coming Soon!
+### Installation
+
+**Using npm:**
+
+```
+npm install investec-openapi
+```
+
+**Using yarn:**
+
+```
+yarn add investec-openapi
+```
+
+### Usage
+
+**Setup:**
+
+```
+import api from 'investec-openapi'
+
+api.configure({
+  proxyUrl: 'ProxyUrl_see_docs_below',
+  clientId: 'YourClientId_do_not_share'
+  secret: 'YourSecret_do_not_share'
+})
+```
+
+**Get Data:**
+
+```
+const fetchData = async () => {
+    const accounts = await api.getAccounts()
+    console.log(accounts) // prints accounts linked to account
+
+    const accountBalance = await api.getAccountBalance('accountId')
+    console.log(accountBalance) // prints account balance
+
+    const accountTransactions = await api.getAccountTransactions('accountId')
+    console.log(accountTransactions) // prints account transactions
+}
+```
+
+**OR:**
+
+```
+const fetchData = async () => {
+    api.getAccounts().then(accounts => console.log(accounts))
+
+    api.getAccountBalance('accountId')
+        .then(accountBalance => console.log(accountBalance))
+
+    api.getAccountTransactions('accountId')
+        .then(accountTransactions => console.log(accountTransactions))
+}
+```
+
+### Documentation
+
+`api` is a class that once `configured` will generate an `access_token` behind the scenes and replace it with a new one once it's within a minute of expiring with no work required on your end.
+
+This wrapper supports `getAccounts`, `getAccountBalance` and `getAccountTransactions` as documented in the [Investec Developer Documentation] with TypeScript definitions included.
+
+---
+
+#### **`api.configure(config)`**
+
+Sets up `api` class with credentials to acquire and refresh `access_token`. Can be called again to change credentials and refresh `access_token` for new credentials. Other API calls will wait until `access_token` is set (by calling this function) before running.
+
+##### **`config` parameters:**
+
+###### `proxyUrl` - _optional_
+
+_default:_ `'https://young-thicket-56542.herokuapp.com/'`
+**Note:** Without a `proxyUrl`, you'll experience _CORS issues_. If anyone has an ideas on how to bypass this more cleanly, let me know! For now the default value should work. Sometimes the Heroko app needs to spin up initially so the first load may take longer than usual. Default url is a clone of https://cors-anywhere.herokuapp.com/ from this SO post: https://stackoverflow.com/a/43268098/2111515
+
+###### `clientId` - _required_
+
+Get this from https://login.secure.investec.com/io/programmable-banking/cards/overview
+
+###### `secret` - _required_
+
+Get this from Get this from https://login.secure.investec.com/io/programmable-banking/cards/overview
+
+---
+
+#### **`api.getAccounts()`**
+
+Returns list of accounts with details for configured credentials.
+**Response:**
+
+```
+{
+    data: {
+        accounts: {
+            accountId: string
+            accountNumber: string
+            accountName: string
+            referenceName: string
+            productName: string
+         }[]
+    }
+    links: {
+        self: string
+    }
+    meta: {
+        totalPages: number
+    }
+}
+```
+
+---
+
+#### **`api.getAccountBalance(accountId)`**
+
+Returns account balance details for selected account.
+`accountId` - _required_
+**Response:**
+
+```
+{
+    data: {
+        accountId: string
+        currentBalance: number
+        availableBalance: number
+        currency: string
+    }
+    links: {
+        self: string
+    }
+    meta: {
+        totalPages: number
+    }
+}
+```
+
+---
+
+#### **`api.getAccountBalance(accountId)`**
+
+Returns list of transaction details for selected account.
+`accountId` - _required_
+**Response:**
+
+```
+{
+    data: {
+        transactions: {
+            accountId: string
+            type: string
+            status: string
+             description: string
+            cardNumber: string
+            postingData: string
+            valueDate: string
+            actionDate: string
+            amount: number
+        }[]
+    }
+    links: {
+        self: string
+    }
+    meta: {
+        totalPages: number
+    }
+}
+```
+
+---
+
+Hope you find this useful! Please give a star and feel free to contribute or log issues and feature requests!
+
+[investec developer documentation]: https://developer.investec.com/programmable-banking/#programmable-banking

Fixed alerts

Major refactor

Supply chain risk

Package 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

Improved metrics

Total package byte prevSize

20135

increased by25.84%

Number of lines in readme file

178

increased by2866.67%

Number of medium supply chain risk alerts

4

decreased by-20%

No dependency changes