@defra-fish/dynamics-lib 1.61.0-rc.0 → 1.61.0-rc.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/dynamics-lib",
-  "version": "1.61.0-rc.0",
+  "version": "1.61.0-rc.2",
   "description": "Framework to support integration with dynamics",
   "type": "module",
   "engines": {
@@ -43,5 +43,5 @@
     "simple-oauth2": "^4.3.0",
     "uuid": "^8.3.2"
   },
-  "gitHead": "67185f8a721c75f38052b63bdb92a5549622367c"
+  "gitHead": "4a762cba2fbe794d581e4f6c05af93016b6d8728"
 }

package/src/entities/__tests__/recurring-payment.entity.spec.js

@@ -16,6 +16,7 @@ describe('recurring payment entity', () => {
     recurringPayment.endDate = '2019-12-15T00:00:00Z'
     recurringPayment.agreementId = 'c9267c6e-573d-488b-99ab-ea18431fc472'
     recurringPayment.publicId = '649-213'
+    recurringPayment.lastDigitsCardNumbers = '1234'
     recurringPayment.status = 1
 
     recurringPayment.bindToEntity(RecurringPayment.definition.relationships.contact, contact)
@@ -38,6 +39,7 @@ describe('recurring payment entity', () => {
       defra_enddate: '2019-12-15T00:00:00Z',
       defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
       defra_publicid: '649-213',
+      defra_lastdigitscardnumbers: '1234',
       statecode: 1,
       _defra_contact_value: 'b3d33cln-2e83-ea11-a811-000d3a649213',
       _defra_activepermission_value: 'a5b24adf-2e83-ea11-a811-000d3a649213',
@@ -68,6 +70,7 @@ describe('recurring payment entity', () => {
           endDate: '2019-12-15T00:00:00Z',
           agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           publicId: '649-213',
+          lastDigitsCardNumbers: '1234',
           status: 1
         })
       )
@@ -92,6 +95,7 @@ describe('recurring payment entity', () => {
           defra_enddate: '2019-12-15T00:00:00Z',
           defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           defra_publicid: '649-213',
+          defra_lastdigitscardnumbers: '1234',
           statecode: 1,
           'defra_Contact@odata.bind': `$${contact.uniqueContentId}`,
           'defra_ActivePermission@odata.bind': `$${permission.uniqueContentId}`
@@ -119,6 +123,7 @@ describe('recurring payment entity', () => {
           endDate: '2019-12-15T00:00:00Z',
           agreementId: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           publicId: '649-213',
+          lastDigitsCardNumbers: '1234',
           status: 1
         })
       )
@@ -138,6 +143,7 @@ describe('recurring payment entity', () => {
           defra_enddate: '2019-12-15T00:00:00Z',
           defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           defra_publicid: '649-213',
+          defra_lastdigitscardnumbers: '1234',
           statecode: 1,
           'defra_Contact@odata.bind': `$${contact.uniqueContentId}`,
           'defra_ActivePermission@odata.bind': `$${permission.uniqueContentId}`
@@ -162,6 +168,7 @@ describe('recurring payment entity', () => {
           defra_enddate: '2019-12-15T00:00:00Z',
           defra_agreementid: 'c9267c6e-573d-488b-99ab-ea18431fc472',
           defra_publicid: '649-213',
+          defra_lastdigitscardnumbers: '1234',
           statecode: 1,
           'defra_Contact@odata.bind': `$${contact.uniqueContentId}`,
           'defra_ActivePermission@odata.bind': `$${permission.uniqueContentId}`,

package/src/entities/recurring-payment.entity.js

@@ -24,7 +24,8 @@ export class RecurringPayment extends BaseEntity {
       activePermission: { field: '_defra_activepermission_value', type: 'string' },
       contactId: { field: '_defra_contact_value', type: 'string' },
       publicId: { field: 'defra_publicid', type: 'string' },
-      nextRecurringPayment: { field: '_defra_nextrecurringpayment_value', type: 'string' }
+      nextRecurringPayment: { field: '_defra_nextrecurringpayment_value', type: 'string' },
+      lastDigitsCardNumbers: { field: 'defra_lastdigitscardnumbers', type: 'string' }
     },
     relationships: {
       contact: { property: 'defra_Contact', entity: Contact, parent: true },
@@ -136,4 +137,16 @@ export class RecurringPayment extends BaseEntity {
   set status (status) {
     super._setState('status', status)
   }
+
+  /**
+   * Last four digits of card number
+   * @type {string}
+   */
+  get lastDigitsCardNumbers () {
+    return super._getState('lastDigitsCardNumbers')
+  }
+
+  set lastDigitsCardNumbers (lastDigitsCardNumbers) {
+    super._setState('lastDigitsCardNumbers', lastDigitsCardNumbers)
+  }
 }

package/src/queries/__tests__/recurring-payments-queries.spec.js

@@ -1,4 +1,4 @@
-import { findDueRecurringPayments } from '../recurring-payments.queries.js'
+import { findDueRecurringPayments, findRecurringPaymentsByAgreementId } from '../recurring-payments.queries.js'
 
 describe('Recurring Payment Queries', () => {
   describe('findDueRecurringPayments', () => {
@@ -22,10 +22,39 @@ describe('Recurring Payment Queries', () => {
           '_defra_activepermission_value',
           '_defra_contact_value',
           'defra_publicid',
-          '_defra_nextrecurringpayment_value'
+          '_defra_nextrecurringpayment_value',
+          'defra_lastdigitscardnumbers'
         ],
         expand: [{ property: 'defra_Contact' }, { property: 'defra_ActivePermission' }]
       })
     })
   })
+
+  describe('findRecurringPaymentsByAgreementId', () => {
+    it('builds a query to retrieve active recurring payments', () => {
+      const agreementId = 'abc123'
+
+      const query = findRecurringPaymentsByAgreementId(agreementId)
+
+      expect(query.toRetrieveRequest()).toEqual({
+        collection: 'defra_recurringpayments',
+        filter: `defra_agreementId eq '${agreementId}'`,
+        select: [
+          'defra_recurringpaymentid',
+          'defra_name',
+          'statecode',
+          'defra_nextduedate',
+          'defra_cancelleddate',
+          'defra_cancelledreason',
+          'defra_enddate',
+          'defra_agreementid',
+          '_defra_activepermission_value',
+          '_defra_contact_value',
+          'defra_publicid',
+          '_defra_nextrecurringpayment_value',
+          'defra_lastdigitscardnumbers'
+        ]
+      })
+    })
+  })
 })

package/src/queries/recurring-payments.queries.js

@@ -18,3 +18,17 @@ export const findDueRecurringPayments = date => {
     expand: [contact, activePermission]
   })
 }
+/**
+ * Builds a query to retrieve recurring payments by agreementId
+ *
+ * @param agreementId the agreementId assigned by GOV.UK Pay
+ * @returns {PredefinedQuery}
+ */
+export const findRecurringPaymentsByAgreementId = agreementId => {
+  const filter = `defra_agreementId eq '${agreementId}'`
+
+  return new PredefinedQuery({
+    root: RecurringPayment,
+    filter: filter
+  })
+}