@mojaloop/api-snippets 12.6.7 → 12.6.8

package/CHANGELOG.md

@@ -1,11 +1,4 @@
 # Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
-### [12.6.7](https://github.com/mojaloop/api-snippets/compare/v12.6.6...v12.6.7) (2021-09-22)
-
-
-### Maintenance
-
-* **deps:** bump tmpl from 1.0.4 to 1.0.5 ([#109](https://github.com/mojaloop/api-snippets/issues/109)) ([314cc5c](https://github.com/mojaloop/api-snippets/commit/314cc5c3231cc8eb4ae3b1efa8c6f90abc1f6b27))
-
 ### [12.6.6](https://github.com/mojaloop/api-snippets/compare/v12.6.5...v12.6.6) (2021-08-26)
 
 

package/docs/thirdparty-openapi3-snippets.yaml

@@ -8230,18 +8230,17 @@ paths:
         - sampled
       operationId: PutThirdpartyRequestsVerificationsById
       summary: PutThirdpartyRequestsVerificationsById
-      description: >
+      description: >-
         The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by
-        the Auth-Service to inform
-
-        the DFSP of a successful result in validating the verification of a
-        Thirdparty Transaction Request.
+        the Auth-Service to inform the DFSP of a successful result in validating
+        the verification of a Thirdparty Transaction Request.
 
+        If the validation fails, the auth-service will send back `PUT
+        /thirdpartyRequests/verifications/{ID}` with `authenticationResponse:
+        'REJECTED'`.
 
-        If the validation fails, The Auth-Service MUST use `PUT
-        /thirdpartyRequests/verifications/{ID}/error`
-
-        instead.
+        In unplanned error cases the Auth-Service MUST use `PUT
+        /thirdpartyRequests/verifications/{ID}/error`.
       parameters:
         - name: Content-Length
           in: header
@@ -8265,13 +8264,21 @@ paths:
               description: >-
                 The object sent in the PUT
                 /thirdpartyRequests/verifications/{ID} request.
-              properties: &ref_162
+              properties: &ref_163
                 authenticationResponse:
+                  title: AuthenticationResponse
                   type: string
-                  enum:
+                  enum: &ref_162
                     - VERIFIED
-                  description: The verification passed
-              required: &ref_163
+                    - REJECTED
+                  description: >-
+                    Below are the allowed values for the enumeration
+                    AuthenticationResponse.
+
+                    - VERIFIED - The challenge was correctly signed.
+
+                    - REJECTED - The challenge was not correctly signed.
+              required: &ref_164
                 - authenticationResponse
             example:
               authenticationResponse: VERIFIED
@@ -9548,14 +9555,22 @@ components:
       description: The object sent in the POST /thirdpartyRequests/verifications request.
       properties: *ref_160
       required: *ref_161
+    AuthenticationResponse:
+      title: AuthenticationResponse
+      type: string
+      enum: *ref_162
+      description: |-
+        Below are the allowed values for the enumeration AuthenticationResponse.
+        - VERIFIED - The challenge was correctly signed.
+        - REJECTED - The challenge was not correctly signed.
     ThirdpartyRequestsVerificationsIDPutResponse:
       title: ThirdpartyRequestsVerificationsIDPutResponse
       type: object
       description: >-
         The object sent in the PUT /thirdpartyRequests/verifications/{ID}
         request.
-      properties: *ref_162
-      required: *ref_163
+      properties: *ref_163
+      required: *ref_164
   parameters:
     ID:
       name: ID

package/lib/thirdparty/index.d.ts

@@ -6,6 +6,7 @@ export declare namespace Schemas {
     type AccountsIDPutResponse = components['schemas']['AccountsIDPutResponse'];
     type Amount = components['schemas']['Amount'];
     type AmountType = components['schemas']['AmountType'];
+    type AuthenticationResponse = components['schemas']['AuthenticationResponse'];
     type AuthenticationType = components['schemas']['AuthenticationType'];
     type AuthorizationChannelType = components['schemas']['AuthorizationChannelType'];
     type AuthorizationResponseType = components['schemas']['AuthorizationResponseType'];

package/lib/thirdparty/openapi.d.ts

@@ -17872,11 +17872,9 @@ export interface operations {
         };
     };
     /**
-     * The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform
-     * the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
-     *
-     * If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
-     * instead.
+     * The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
+     * If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
+     * In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
      */
     PutThirdpartyRequestsVerificationsById: {
         parameters: {
@@ -17892,9 +17890,11 @@ export interface operations {
         requestBody: {
             "application/json": {
                 /**
-                 * The verification passed
+                 * Below are the allowed values for the enumeration AuthenticationResponse.
+                 * - VERIFIED - The challenge was correctly signed.
+                 * - REJECTED - The challenge was not correctly signed.
                  */
-                authenticationResponse: "VERIFIED";
+                authenticationResponse: "VERIFIED" | "REJECTED";
             };
         };
         responses: {
@@ -22133,14 +22133,22 @@ export interface components {
              */
             signedPayload: string;
         };
+        /**
+         * Below are the allowed values for the enumeration AuthenticationResponse.
+         * - VERIFIED - The challenge was correctly signed.
+         * - REJECTED - The challenge was not correctly signed.
+         */
+        AuthenticationResponse: "VERIFIED" | "REJECTED";
         /**
          * The object sent in the PUT /thirdpartyRequests/verifications/{ID} request.
          */
         ThirdpartyRequestsVerificationsIDPutResponse: {
             /**
-             * The verification passed
+             * Below are the allowed values for the enumeration AuthenticationResponse.
+             * - VERIFIED - The challenge was correctly signed.
+             * - REJECTED - The challenge was not correctly signed.
              */
-            authenticationResponse: "VERIFIED";
+            authenticationResponse: "VERIFIED" | "REJECTED";
         };
     };
     responses: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/api-snippets",
-  "version": "12.6.7",
+  "version": "12.6.8",
   "description": "Mojaloop API specification reusable snippets",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/thirdparty/openapi3/components/schemas/AuthenticationResponse.yaml

@@ -0,0 +1,9 @@
+title: AuthenticationResponse
+type: string
+enum:
+  - VERIFIED
+  - REJECTED
+description: |-
+  Below are the allowed values for the enumeration AuthenticationResponse.
+  - VERIFIED - The challenge was correctly signed.
+  - REJECTED - The challenge was not correctly signed.

package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml

@@ -3,10 +3,6 @@ type: object
 description: The object sent in the PUT /thirdpartyRequests/verifications/{ID} request.
 properties:
   authenticationResponse:
-    type: string
-    enum:
-      - VERIFIED
-    description: 'The verification passed'
+    $ref: ./AuthenticationResponse.yaml
 required:
   - authenticationResponse
-  

package/thirdparty/openapi3/paths/thirdpartyRequests_verifications_ID.yaml

@@ -17,12 +17,14 @@ put:
     - sampled
   operationId: PutThirdpartyRequestsVerificationsById
   summary: PutThirdpartyRequestsVerificationsById
-  description: |
+  description: >-
     The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform
     the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
 
-    If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
-    instead.
+    If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}`
+    with `authenticationResponse: 'REJECTED'`.
+
+    In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
   parameters:
     - $ref: ../components/parameters/Content-Length.yaml
   requestBody: