@mft/moneyhub-api-client 4.13.0 → 4.14.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+4.13.0 / 2022-01-05
+==================
+
+**Features**
+
+* Add getRentalRecords
+* Add createRentalRecord
+* Add deleteRentalRecord
 
 4.0.0 / 2021-01-11
 ==================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mft/moneyhub-api-client",
-  "version": "4.13.0",
+  "version": "4.14.0",
   "description": "Node.JS client for the Moneyhub API",
   "main": "src/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   "license": "ISC",
   "dependencies": {
     "form-data": "^3.0.0",
-    "got": "^11.8.1",
+    "got": "^11.8.3",
     "jose": "^2.0.5",
     "openid-client": "^4.2.2",
     "ramda": "^0.27.1"
@@ -37,8 +37,8 @@
     "eslint": "^7.32.0",
     "express": "^4.17.1",
     "husky": "^7.0.2",
-    "mocha": "^9.1.2",
-    "mocha-junit-reporter": "^2.0.0"
+    "mocha": "^9.2.0",
+    "mocha-junit-reporter": "^2.0.2"
   },
   "husky": {
     "hooks": {

package/readme.md

@@ -1345,6 +1345,57 @@ const regulartransactions = await moneyhub.getRegularTransactions({
 })
 ```
 
+### Rental records
+
+#### `getRentalRecords`
+
+This method will return the rental record for the user. Requires the scope `rental_records:read`.
+
+```javascript
+const getRentalRecordResponse = await moneyhub.getRentalRecords({
+  userId: "user-id"
+})
+const rentalRecord = getRentalRecordResponse.data[0]
+```
+
+#### `createRentalRecord`
+
+This method will create a rental record for the user. Requires the scope `rental_records:write`. Please note only one rental record can exist for a user.
+
+```javascript
+const createRentalRecordResponse = await moneyhub.createRentalRecord({
+  userId: "user-id",
+  rentalData: {
+    title: "Title",
+    firstName: "firstName",
+    lastName: "lastName",
+    birthdate: "2000-11-19",
+    addressLine1: "First address line",
+    addressLine2: "Second address line", // optional
+    addressLine3: "Third address line", // optional
+    addressLine4: "Fourth address line", // optional
+    postalCode: "CA12345",
+    tenancyStartDate: "2020-11-19",
+    rentalAmount: {
+      value: 10000
+    },
+    rentalFrequency: "monthly",
+  }
+})
+const createdRentalRecord = createRentalRecordResponse.data
+```
+
+#### `deleteRentalRecord`
+
+This method deletes the rental record for a user.
+
+```javascript
+await moneyhub.deleteRentalRecord({
+  userId: "user-id",
+  rentalId: "rental-id"
+})
+```
+
 ### Financial Connections
 
 #### `listConnections`

package/src/__tests__/index.js

@@ -89,6 +89,9 @@ describe("API client", () => {
         "getStandingOrder",
         "getStandingOrders",
         "getRegularTransactions",
+        "getRentalRecords",
+        "createRentalRecord",
+        "deleteRentalRecord",
         "getAuthorizeUrl",
         "getAuthorizeUrlFromRequestUri",
         "requestObject",

package/src/__tests__/rental-records.js

@@ -0,0 +1,90 @@
+/* eslint-disable max-nested-callbacks */
+const Moneyhub = require("..")
+const config = require("../../test/test-client-config")
+const {expect, assert} = require("chai")
+
+const testRentalData = {
+  title: "Title",
+  firstName: "firstName",
+  lastName: "lastName",
+  birthdate: "2000-11-19",
+  addressLine1: "First address line",
+  addressLine2: "Second address line",
+  addressLine3: "Third address line",
+  addressLine4: "Fourth address line",
+  postalCode: "CA12345",
+  tenancyStartDate: "2020-11-19",
+  rentalAmount: {
+    value: 10000
+  },
+  rentalFrequency: "monthly",
+}
+
+describe("Rental records", () => {
+  let moneyhub
+  let seriesId
+  let rentalId
+  const userId = config.testUserIdWithconnection
+
+  before(async () => {
+    moneyhub = await Moneyhub(config)
+    const {data: regularTransactions} = await moneyhub.getRegularTransactions({userId})
+    seriesId = regularTransactions[0].seriesId
+    const {data: rentals} = await moneyhub.getRentalRecords({userId})
+    if (rentals.length) {
+      const existingRentalId = rentals[0].id
+      await moneyhub.deleteRentalRecord({userId, rentalId: existingRentalId})
+    }
+  })
+
+  beforeEach(async () => {
+    const {data} = await moneyhub.createRentalRecord({rentalData: {...testRentalData, seriesId}, userId})
+    rentalId = data.id
+  })
+
+  afterEach(async () => {
+    try {
+      await moneyhub.deleteRentalRecord({userId, rentalId})
+    } catch (e) {
+      if (!e.message.includes("404")) {
+        throw e
+      }
+    }
+
+  })
+
+  it("get rental record", async () => {
+    const {data} = await moneyhub.getRentalRecords({userId})
+    expect(data.length).to.be.above(0)
+    expect(data[0]).to.have.property("seriesId")
+  })
+
+  it("create rental record", async () => {
+    const {data} = await moneyhub.getRentalRecords({userId})
+    expect(data.length).to.be.above(0)
+    assert.containsAllKeys(data[0], {
+      title: "Title",
+      firstName: "firstName",
+      lastName: "lastName",
+      birthdate: "2000-11-19",
+      addressLine1: "First address line",
+      addressLine2: "Second address line",
+      addressLine3: "Third address line",
+      addressLine4: "Fourth address line",
+      postalCode: "CA12345",
+      tenancyStartDate: "2020-11-19",
+      rentalAmount: {
+        value: 10000,
+        currency: "GBP"
+      },
+      rentalFrequency: "monthly",
+    })
+  })
+
+  it("delete rental record", async () => {
+    await moneyhub.deleteRentalRecord({userId, rentalId})
+    const {data} = await moneyhub.getRentalRecords({userId})
+    expect(data.length).to.eql(0)
+  })
+
+})

package/src/index.js

@@ -20,6 +20,7 @@ const requestFactories = [
   require("./requests/categories"),
   require("./requests/standing-orders"),
   require("./requests/regular-transactions"),
+  require("./requests/rental-records")
 ]
 const DEFAULT_TIMEOUT = 60000
 

package/src/requests/rental-records.js

@@ -0,0 +1,41 @@
+module.exports = ({config, request}) => {
+  const {resourceServerUrl} = config
+
+  return {
+    getRentalRecords: async ({userId}) =>
+      request(
+        `${resourceServerUrl}/rental-records`,
+        {
+          cc: {
+            scope: "rental_records:read",
+            sub: userId,
+          },
+        },
+      ),
+    createRentalRecord: async ({userId, rentalData}) => {
+      return await request(
+        `${resourceServerUrl}/rental-records`,
+        {
+          method: "POST",
+          cc: {
+            scope: "rental_records:write",
+            sub: userId,
+          },
+          body: rentalData,
+        },
+      )
+    },
+    deleteRentalRecord: async ({userId, rentalId}) => {
+      return await request(
+        `${resourceServerUrl}/rental-records/${rentalId}`,
+        {
+          method: "DELETE",
+          cc: {
+            scope: "rental_records:write",
+            sub: userId,
+          },
+        },
+      )
+    },
+  }
+}