Merge pull request 'OVPAY-1946 - Added bulk reject/return endpoints.' (#32) from feature/OVPAY-1946 into develop

Reviewed-on: #32

src/openapi/fiko/fiko-crud.yaml

@@ -657,8 +657,8 @@ paths:
                         status: failed
                         description: Validation XYZ failed.
                         correlationId: null
-                ? List containing multiple transaction audit trails of one transaction item
+                List containing multiple transaction audit trails of one transaction item:
-                : summary: List containing multiple audit trails of one transaction item
+                  summary: List containing multiple audit trails of one transaction item
                   description: List containing multiple audit trail records of one transaction item (with id `d667d293-aa82-4c9e-9b10-77cffc9058a1`).
                   value:
                     "@odata.context": "$metadata#TransactionAuditTrail"
@@ -703,8 +703,8 @@ paths:
                         status: created
                         description: Transaction created.
                         correlationId: null
-                ? List containing multiple audit trails of different failed transactions
+                List containing multiple audit trails of different failed transactions:
-                : summary: List containing multiple audit trails of different failed transactions
+                  summary: List containing multiple audit trails of different failed transactions
                   description: List containing multiple audit trails of different failed transactions (status = failed).
                   value:
                     "@odata.context": "$metadata#TransactionAuditTrail"
@@ -2979,6 +2979,164 @@ paths:
         - default: []
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited
+  /transactionitems/reject:
+    post:
+      summary: Reject transaction items to source in bulk.
+      description: Reject transaction items to source in bulk.
+      tags:
+        - Bulk processing v2.2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TransactionItemsBulkRequestBody"
+            examples:
+              List of transaction item ids to reject:
+                summary: List of transaction item ids to reject to source
+                description: List of transaction item ids to reject to source.
+                value:
+                  transactionItemIds:
+                    - afce35b2-1dff-4ace-98d0-4b9ac405c87d
+                    - b1c4f8e7-3f4e-4d2a-9c6e-2f5e6d7c8b9a
+                    - c2d5e6f7-4g5h-5i6j-0k1l-3m4n5o6p7q8r
+      responses:
+        "202":
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionItemsPostResponseBody"
+              examples:
+                Array of transaction items accepted:
+                  summary: Array of transaction item ids accepted
+                  description: |
+                    The array of transaction item ids was accepted successfully.
+                    The transaction items will be processed asynchronously.
+                    In the response body the consumer will find information on how to retrieve the processing status.
+                  value:
+                    startTime: 2025-02-14T05:32:47.0672237Z
+                    status: Running
+                    clientTrackingId: 08584620957189579629541919368CU00
+                    callbackurl: https://api.integratielaag.nl/transactionitems/reject/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
+                    retryAfter: 10
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /transactionitems/responsestatus/reject/{clientTrackingId}:
+    get:
+      tags:
+        - Bulk processing v2.2
+      summary: Get the status of the transaction item bulk reject.
+      description: Get the status of the asynchronous transaction item bulk reject.
+      parameters:
+        - in: path
+          name: clientTrackingId
+          schema:
+            type: string
+          required: true
+          description: The clientTrackingId of the transaction item bulk reject.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionItemsRejectResponseStatusGetResponseBody"
+              examples:
+                Batch successfully processed:
+                  summary: Batch successfully processed
+                  description: |
+                    Body of a batch of transaction items that was successfully rejected. 
+                    A number of transaction items were rejected.
+                  value:
+                    summary:
+                      rejected: 15
+                      total: 15
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /transactionitems/return:
+    post:
+      summary: Return transaction items to trx db in bulk.
+      description: Return transaction items to trx db in bulk.
+      tags:
+        - Bulk processing v2.2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/TransactionItemsBulkRequestBody"
+            examples:
+              List of transaction item ids to reject:
+                summary: List of transaction item ids to return to trx db
+                description: List of transaction item ids to return to trx db.
+                value:
+                  transactionItemIds:
+                    - afce35b2-1dff-4ace-98d0-4b9ac405c87d
+                    - b1c4f8e7-3f4e-4d2a-9c6e-2f5e6d7c8b9a
+                    - c2d5e6f7-4g5h-5i6j-0k1l-3m4n5o6p7q8r
+      responses:
+        "202":
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionItemsPostResponseBody"
+              examples:
+                Array of transaction items accepted:
+                  summary: Array of transaction item ids accepted
+                  description: |
+                    The array of transaction item ids was accepted successfully.
+                    The transaction items will be processed asynchronously.
+                    In the response body the consumer will find information on how to retrieve the processing status.
+                  value:
+                    startTime: 2025-02-14T05:32:47.0672237Z
+                    status: Running
+                    clientTrackingId: 08584620957189579629541919368CU00
+                    callbackurl: https://api.integratielaag.nl/transactionitems/return/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
+                    retryAfter: 10
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /transactionitems/responsestatus/return/{clientTrackingId}:
+    get:
+      tags:
+        - Bulk processing v2.2
+      summary: Get the status of the transaction item bulk return.
+      description: Get the status of the asynchronous transaction item bulk return.
+      parameters:
+        - in: path
+          name: clientTrackingId
+          schema:
+            type: string
+          required: true
+          description: The clientTrackingId of the transaction item bulk return.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/TransactionItemsReturnResponseStatusGetResponseBody"
+              examples:
+                Batch successfully processed:
+                  summary: Batch successfully processed
+                  description: |
+                    Body of a batch of transaction items that was successfully returned to trx db. 
+                    A number of transaction items were returned to trx db.
+                  value:
+                    summary:
+                      returned: 15
+                      total: 15
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
 components:
   securitySchemes:
     default:
@@ -4801,6 +4959,51 @@ components:
               transactionLineId:
                 type: string
                 example: fee907dd-e59d-44f5-a63b-bbdec38f79b7
+    TransactionItemsBulkRequestBody:
+      type: object
+      properties:
+        transactionItemIds:
+          type: array
+          items:
+            type: string
+            format: uuid
+            example: 1ad109d3-fd7d-4b6f-872b-220d492f385f
+      required:
+        - transactionItemIds
+    TransactionItemsRejectResponseStatusGetResponseBody:
+      type: object
+      properties:
+        summary:
+          type: object
+          properties:
+            rejected:
+              type: integer
+              example: 3
+            total:
+              type: integer
+              example: 3
+          required:
+            - rejected
+            - total
+      required:
+        - summary
+    TransactionItemsReturnResponseStatusGetResponseBody:
+      type: object
+      properties:
+        summary:
+          type: object
+          properties:
+            returned:
+              type: integer
+              example: 3
+            total:
+              type: integer
+              example: 3
+          required:
+            - returned
+            - total
+      required:
+        - summary
     rfc9457:
       type: object
       properties: