@defra-fish/connectors-lib 1.62.0-rc.1 → 1.62.0-rc.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/connectors-lib",
-  "version": "1.62.0-rc.1",
+  "version": "1.62.0-rc.2",
   "description": "Shared connectors",
   "type": "module",
   "engines": {
@@ -46,5 +46,5 @@
     "node-fetch": "^2.7.0",
     "redlock": "^4.2.0"
   },
-  "gitHead": "89028907ee2ee612a0126fb9b7857791c2e9563d"
+  "gitHead": "6a3a2c6a81067424144382557214c49c27559cdf"
 }

package/src/__tests__/sales-api-connector.spec.js

@@ -706,4 +706,44 @@ describe('sales-api-connector', () => {
       })
     })
   })
+
+  describe('cancelRecurringPayment', () => {
+    describe.each([['id'], ['abc-123']])("Cancelling recurring payment id '%s'", id => {
+      beforeEach(() => {
+        fetch.mockReturnValue({
+          ok: true,
+          status: 200,
+          statusText: 'OK',
+          text: async () => JSON.stringify({ id })
+        })
+      })
+
+      it('calls the endpoint with the correct parameters', async () => {
+        await salesApi.cancelRecurringPayment(id)
+
+        expect(fetch).toHaveBeenCalledWith(`http://0.0.0.0:4000/cancelRecurringPayment/${id}`, {
+          method: 'get',
+          headers: expect.any(Object),
+          timeout: 20000
+        })
+      })
+
+      it('returns the expected response data', async () => {
+        const processedResult = await salesApi.cancelRecurringPayment(id)
+
+        expect(processedResult).toEqual({ id })
+      })
+    })
+
+    it('throws an error on non-2xx response', async () => {
+      fetch.mockReturnValue({
+        ok: false,
+        status: 500,
+        statusText: 'Internal Server Error',
+        text: async () => 'Server Error'
+      })
+
+      await expect(salesApi.cancelRecurringPayment('id')).rejects.toThrow('Internal Server Error')
+    })
+  })
 })

package/src/sales-api-connector.js

@@ -308,3 +308,14 @@ export const preparePermissionDataForRenewal = async referenceNumber =>
 export const processRPResult = async (transactionId, paymentId, createdDate) => {
   return exec2xxOrThrow(call(new URL(`/processRPResult/${transactionId}/${paymentId}/${createdDate}`, urlBase), 'get'))
 }
+
+/**
+ * Cancel a RecurringPayment
+ *
+ * @param id
+ * @returns {Promise<*>}
+ * @throws on a non-2xx response
+ */
+export const cancelRecurringPayment = async id => {
+  return exec2xxOrThrow(call(new URL(`/cancelRecurringPayment/${id}`, urlBase), 'get'))
+}