OVPAY-2485 - Added SE endpoint for AGO OTP verification.

src/openapi/customers/SE-customers-v2.yaml

@@ -3716,13 +3716,13 @@ paths:
       responses:
         "200":
           description: OK
-  /customers/tokens/{ovPayTokenId}/activateAgo:
+  /customers/tokens/{ovPayTokenId}/activateago:
     parameters:
     - name: ovPayTokenId
       in: path
       required: true
       style: simple
-      description: Id of the OvPayToken to get product-instances for.
+      description: Id of the OvPayToken to activate AGO for.
       schema:
         type: integer
         example: 1
@@ -3785,7 +3785,7 @@ paths:
                     key: 123456789123456789123456789abcde
                     description: OTP Sent
         "400":
-          description: OK
+          description: Bad Request
           content:
             application/json:
               schema:
@@ -3802,7 +3802,7 @@ paths:
                     title: Invalid Parameter
                     detail: Required parameter {0} is invalid.
         "401":
-          description: OK
+          description: Unauthorized
           content:
             application/json:
               schema:
@@ -3814,7 +3814,7 @@ paths:
                     title: Unauthorized
                     detail: Invalid Access Token
         "404":
-          description: OK
+          description: Not found
           content:
             application/json:
               schema:
@@ -3826,7 +3826,7 @@ paths:
                     title: Not Found
                     detail: TAT Account Not Found
         "409":
-          description: 409 Conflict
+          description: Conflict
           content:
             application/json:
               schema:
@@ -3838,7 +3838,105 @@ paths:
                     title: Conflict
                     detail: TAT Already Secured
         "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              example:
+                error: An unknown error has occurred
+  /customers/tokens/{ovPayTokenId}/validateotp:
+    parameters:
+    - name: ovPayTokenId
+      in: path
+      required: true
+      style: simple
+      description: Id of the OvPayToken to verify OTP for.
+      schema:
+        type: integer
+        example: 1
+    - name: X-HTM-JWT-AUTH-HEADER
+      in: header
+      schema:
+        type: string
+        example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+      required: false
+      description: The JWT of a customer in case of touchpoint were customer logs in themselves       
+    - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER
+      in: header
+      schema:
+        type: integer
+        example: 323
+      required: false
+      description: The id of the customer Profile
+    - name: X-HTM-ROLE-HEADER
+      in: header
+      schema:
+        type: string
+        example: Customer
+      required: false
+      description: The role of the HTM employee in the case of the SMP    
+    post:
+      tags:
+        - AGO
+      summary: Request additional OV-pas security for a token in profile.
+      description: Request additional OV-pas security for a token in profile.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/unavailable"
+            example:
+              otp: 123456
+      responses:
+        "200":
           description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                oneOf:
+                  - $ref: '#/components/schemas/AuthCodeResponse'
+                  - $ref: '#/components/schemas/ValidateTatOutputDescription'
+                  - $ref: '#/components/schemas/TatUnsecured'
+              examples:
+                AuthCodeResponse:
+                  value:
+                ValidateTatOutputDescription:
+                  value:
+                TatUnsecured:
+                  value:
+        "400":
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Missing Parameters:
+                  value:
+                    status: 400
+                    title: Missing Mandatory Parameter
+                    detail: Required parameter {0} is missing.
+                Invalid Parameters:
+                  value:
+                    status: 400
+                    title: Invalid Parameter
+                    detail: Required parameter {0} is invalid.
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+              examples:
+                Unauthorized:
+                  value:
+                    status: 401
+                    title: Unauthorized
+                    detail: Invalid Access Token
+        "500":
+          description: Internal server error
           content:
             application/json:
               schema:
@@ -4795,6 +4893,43 @@ components:
             A description IS A string THAT describes the reason why the email is
             not pre-approved.
           example: OTP Sent
+    AuthCodeResponse:
+      type: object
+      properties:
+        authCode:
+          type: string
+          description: >-
+            An AuthCodeResponse IS A string that represents the authorization
+            code that can be exchanged for a user access token.
+          example: 4f3a9c8b-xxxx
+    ValidateTatOutputDescription:
+      type: string
+      properties:
+        authCode:
+          type: string
+          description: >-
+            An AuthCodeResponse IS A string that represents the authorization
+            code that can be exchanged for a user access token.
+          example: 4f3a9c8b-xxxx
+        status:
+          type: string
+          example: Success
+        description:
+          type: string
+          description: >-
+            A ValidateTatOutputDescription IS A string that provides more
+            details about the OTP validation result.
+          example: TAT Secured 
+    TatUnsecured:
+      type: object
+      description: A TatUnsecured IS AN object THAT represents the response of TAT security
+      properties:
+        status:
+          type: string
+          example: Success
+        description:
+          type: string
+          example: TAT Unsecured         
     ErrorResponse:
       description: Default response when an invalid request has been sent
       type: object