feat: add consentRequests error request (#133)

* feat: add consentRequests error request * chore: fix function
mojaloop · Mar 15, 2021 · 10249e3 · 10249e3
1 parent 7306e94
commit 10249e3
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 3 deletions.
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -156,6 +156,19 @@ declare namespace SDKStandardComponents {
             destParticipantId: string
         ): Promise<GenericRequestResponse | GenericRequestResponseUndefined>;
 
+        /**
+         * @function putConsentRequestsError
+         * @description Executes a `PUT /consentRequests/{id}/error` request.
+         * @param {string} consentRequestId The `id` of the consent request object to be updated
+         * @param {PutConsentsRequest} consentRequestBody The body of the consent request object
+         * @param {string} destParticipantId The id of the destination participant
+         */
+        putConsentRequestsError(
+            consentRequestId: string,
+            consentRequestBody: fspiopAPI.Schemas.ErrorInformationObject,
+            destParticipantId: string
+        ): Promise<GenericRequestResponse | GenericRequestResponseUndefined>;
+
         /**
          * @function postAuthorizations
          * @description
@@ -269,7 +282,7 @@ declare namespace SDKStandardComponents {
             transactionRequestId: string,
             destParticipantId: string
         ): Promise<GenericRequestResponse | GenericRequestResponseUndefined>;
-        
+
         /**
          * @function getAccounts
          * @description Executes a `GET /accounts/{id}` request.
@@ -305,7 +318,7 @@ declare namespace SDKStandardComponents {
             userId: string,
             accountsBody: fspiopAPI.Schemas.ErrorInformationObject,
             destParticipantId: string
-        ): Promise<GenericRequestResponse | GenericRequestResponseUndefined>;        
+        ): Promise<GenericRequestResponse | GenericRequestResponseUndefined>;
     }
 
     class MojaloopRequests extends BaseRequests {

diff --git a/src/lib/requests/thirdpartyRequests.js b/src/lib/requests/thirdpartyRequests.js
@@ -36,6 +36,11 @@ class ThirdpartyRequests extends BaseRequests {
         return this._post('consentRequests', 'thirdparty', consentRequestBody, destParticipantId);
     }
 
+    async putConsentRequestsError(consentRequestId, consentRequestBody, destParticipantId) {
+        const url = `consentRequests/${consentRequestId}/error`;
+        return this._put(url, 'thirdparty', consentRequestBody, destParticipantId);
+    }
+
     async postAuthorizations(authorizationBody, destParticipantId) {
         return this._post('authorizations', 'authorizations', authorizationBody, destParticipantId);
     }

diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-standard-components",
-  "version": "15.2.1",
+  "version": "15.3.0",
   "description": "A set of standard components for connecting to Mojaloop API enabled Switches",
   "main": "index.js",
   "types": "index.d.ts",

diff --git a/src/test/unit/data/putConsentRequestsRequestError.json b/src/test/unit/data/putConsentRequestsRequestError.json
@@ -0,0 +1,14 @@
+{
+  "errorInformation": {
+      "errorCode":"6000",
+      "errorDescription":"Generic third party error.",
+      "extensionList":{
+          "extension":[
+              {
+                  "key":"errorDescription",
+                  "value":"This is a more detailed error description"
+              }
+          ]
+      }
+  }
+}
diff --git a/src/test/unit/lib/requests/thirdpartyRequests.test.js b/src/test/unit/lib/requests/thirdpartyRequests.test.js
@@ -297,6 +297,53 @@ describe('ThirdpartyRequests', () => {
         });
     });
 
+    describe('putConsentRequestsRequestError', () => {
+        const putConsentRequestsRequestError = require('../../data/putConsentRequestsRequestError.json');
+        const wso2Auth = new WSO2Auth({ logger: mockLogger({ app: 'put-consent-requests-error-test' }) });
+        const config = {
+            logger: mockLogger({ app: 'put-consent-requests-error-test' }),
+            peerEndpoint: '127.0.0.1',
+            thirdpartyRequestsEndpoint: 'thirdparty-api-adapter.local',
+            tls: {
+                mutualTLS: {
+                    enabled: false
+                }
+            },
+            jwsSign: false,
+            jwsSignPutParties: false,
+            jwsSigningKey: jwsSigningKey,
+            wso2Auth,
+        };
+
+        it('executes a `PUT /consentRequests/{ID}/error` request', async () => {
+            http.__request.mockClear();
+            // Arrange
+            http.__request = jest.fn(() => ({
+                statusCode: 200,
+                headers: {
+                    'content-length': 0
+                },
+            }));
+            const tpr = new ThirdpartyRequests(config);
+            const requestBody = putConsentRequestsRequestError;
+            const consentRequestId = '12345';
+            // Act
+            await tpr.putConsentRequestsError(consentRequestId, requestBody, 'pispa');
+
+            // Assert
+            expect(http.__write).toHaveBeenCalledWith((JSON.stringify(requestBody)));
+            expect(http.__request).toHaveBeenCalledWith(
+                expect.objectContaining({
+                    'method': 'PUT',
+                    'path': '/consentRequests/12345/error',
+                    'headers': expect.objectContaining({
+                        'fspiop-destination': 'pispa'
+                    })
+                })
+            );
+        });
+    });
+
     describe('postConsentRequests', () => {
         const postConsentRequestsRequest = require('../../data/postConsentRequestsRequest.json');
         const wso2Auth = new WSO2Auth({ logger: mockLogger({ app: 'post-consent-requests-test' }) });