@mft/moneyhub-api-client 4.17.0 → 4.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mft/moneyhub-api-client",
-  "version": "4.17.0",
+  "version": "4.18.0",
   "description": "Node.JS client for the Moneyhub API",
   "main": "src/index.js",
   "scripts": {

package/readme.md

@@ -96,6 +96,8 @@ The options below can be set on the following URL generating methods:
 - `getRefreshAuthorizeUrlForCreatedUser`
 
 The `expirationDateTime` and `transactionFromDateTime` options can be set according to the [AIS Consents documentation](https://docs.moneyhubenterprise.com/docs/ais-consents)
+
+Set `enableAsync` to true if you wish to make an AIS connection that won't wait for accounts and transactions to be fetched.
 #### `getAuthorizeUrl`
 
 This method returns an authorize url for your API client. You can redirect a user to this url, after which they will be redirected back to your `redirect_uri`. 
@@ -116,6 +118,7 @@ const url = await moneyhub.getAuthorizeUrl({
   permissions: ["ReadBeneficiariesDetail"], // optional - set of extra permissions to set for auth URL
   expirationDateTime: "2022-09-01T00:00:00.000Z", // optional
   transactionFromDateTime: "2020-09-01T00:00:00.000Z", // optional,
+  enableAsync: false // optional
 })
 
 // Default claims if none are provided
@@ -148,7 +151,8 @@ const url = await moneyhub.getAuthorizeUrlForCreatedUser({
   state: "your state value", // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
-  permissions: ["ReadBeneficiariesDetail"] // optional - set of extra permissions to set for auth URL
+  permissions: ["ReadBeneficiariesDetail"], // optional - set of extra permissions to set for auth URL
+  enableAsync: false // optional
 })
 
 // Scope used with the bankId provided
@@ -179,6 +183,7 @@ const url = await moneyhub.getReauthAuthorizeUrlForCreatedUser({
   state: "your state value", // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
+  enableAsync: false // optional
 })
 
 // Default claims if none are provided
@@ -207,6 +212,7 @@ const url = await moneyhub.getRefreshAuthorizeUrlForCreatedUser({
   state: "your state value", // optional
   nonce: "your nonce value", // optional
   claims: claimsObject, // optional
+  enableAsync: false // optional
 })
 
 // Default claims if none are provided
@@ -520,6 +526,30 @@ const user = await moneyhub.deleteUserConnection({
   })
 ```
 
+#### `getConnectionSyncs`
+
+Retrieve the syncs for a given connection ID.
+```javascript
+const syncs = await moneyhub.getConnectionSyncs({
+  userId: "user-id",
+  connectionId: "connection-id",
+  params: {
+    limit: 10,
+    offset: 0
+  }
+})
+```
+
+#### `getSync`
+
+Retrieve the syncs for the given sync ID.
+```javascript
+const syncs = await moneyhub.getSync({
+  userId: "user-id",
+  syncId: "sync-id"
+})
+```
+
 ### Data API
 
 #### `getAccounts`

package/src/__tests__/index.js

@@ -80,6 +80,8 @@ describe("API client", () => {
         "getUserConnections",
         "deleteUserConnection",
         "deleteUser",
+        "getConnectionSyncs",
+        "getSync",
         "getCategories",
         "getStandardCategories",
         "getCategory",

package/src/get-auth-urls.js

@@ -36,6 +36,7 @@ module.exports = ({client, config}) => {
     nonce,
     claims = {},
     permissions,
+    enableAsync,
     expirationDateTime,
     transactionFromDateTime,
   }) => {
@@ -55,6 +56,12 @@ module.exports = ({client, config}) => {
               ...transactionFromDateTime && {transactionFromDateTime},
             }
           }
+        },
+        ...enableAsync && {
+          "mh:sync": {
+            "essential": true,
+            "value": {"enableAsync": true}
+          }
         }
       },
     }
@@ -136,6 +143,7 @@ module.exports = ({client, config}) => {
       permissions,
       expirationDateTime,
       transactionFromDateTime,
+      enableAsync,
     }) => {
       const scope = `id:${bankId} openid`
       const defaultClaims = {
@@ -161,6 +169,7 @@ module.exports = ({client, config}) => {
         claims: _claims,
         expirationDateTime,
         transactionFromDateTime,
+        enableAsync,
       })
       return url
     },
@@ -173,6 +182,7 @@ module.exports = ({client, config}) => {
       claims = {},
       expirationDateTime,
       transactionFromDateTime,
+      enableAsync,
     }) => {
       const scope = "openid reauth"
       const defaultClaims = {
@@ -196,6 +206,7 @@ module.exports = ({client, config}) => {
         claims: _claims,
         expirationDateTime,
         transactionFromDateTime,
+        enableAsync,
       })
       return url
     },
@@ -208,6 +219,7 @@ module.exports = ({client, config}) => {
       claims = {},
       expirationDateTime,
       transactionFromDateTime,
+      enableAsync
     }) => {
       const scope = "openid refresh"
       const defaultClaims = {
@@ -231,6 +243,7 @@ module.exports = ({client, config}) => {
         claims: _claims,
         expirationDateTime,
         transactionFromDateTime,
+        enableAsync
       })
       return url
     },

package/src/requests/users-and-connections.js

@@ -60,5 +60,20 @@ module.exports = ({config, request}) => {
           scope: "user:delete",
         },
       }),
+
+    getConnectionSyncs: async ({userId, connectionId, params = {}}) =>
+      request(`${usersEndpoint}/${userId}/connections/${connectionId}/syncs`, {
+        searchParams: params,
+        cc: {
+          scope: "user:read"
+        }
+      }),
+
+    getSync: async ({userId, syncId}) =>
+      request(`${usersEndpoint}/${userId}/syncs/${syncId}`, {
+        cc: {
+          scope: "user:read"
+        }
+      })
   }
 }