From 683b12f6ebd2c9e649ecc0d964243d3d75e8a94f Mon Sep 17 00:00:00 2001
From: Mirjam Herald <m.herald@htm.nl>
Date: Mon, 17 Feb 2025 17:44:50 +0100
Subject: [PATCH] started on mandates

---
 src/openapi/customers/customers-crud-v2.yaml | 103 +++++++++++--------
 1 file changed, 62 insertions(+), 41 deletions(-)

diff --git a/src/openapi/customers/customers-crud-v2.yaml b/src/openapi/customers/customers-crud-v2.yaml
index 969281a..b4327ae 100644
--- a/src/openapi/customers/customers-crud-v2.yaml
+++ b/src/openapi/customers/customers-crud-v2.yaml
@@ -922,7 +922,7 @@ paths:
   /customers/{customerProfileId}/addresses:
       post:
         tags:
-          - Customer
+          - Customer address
         summary: Add a customer address
         description: >-
           
@@ -965,7 +965,7 @@ paths:
   /addresses/{addressId}:
     patch:
       tags:
-        - Customer
+        - Customer address
       summary: Edit a customer address
       description: >-
           
@@ -1000,7 +1000,7 @@ paths:
       x-throttling-tier: Unlimited
     delete:
       tags:
-        - Customer
+        - Customer address
       summary: Delete a customer address
       description: >-
           
@@ -1024,7 +1024,7 @@ paths:
   /customers/{customerProfileId}/phones:
       post:
         tags:
-          - Customer
+          - Customer phoneNumber
         summary: Add a customer phonenumber
         description: >-
           
@@ -1063,7 +1063,7 @@ paths:
   /phones/{phoneId}:
     patch:
       tags:
-        - Customer
+        - Customer phoneNumber
       summary: Edit a customer phonenumber
       description: >-
           
@@ -1098,7 +1098,7 @@ paths:
       x-throttling-tier: Unlimited
     delete:
       tags:
-        - Customer
+        - Customer phoneNumber
       summary: Delete a customer phone
       description: >-
           
@@ -1578,6 +1578,45 @@ paths:
                     "updateTimestamp": "2024-03-22T08:55:00",
                   },
                 ]
+  /billingInformation/{billingInformationId}/directdebitmandates:
+      post:
+        tags:
+          - Mandates
+        summary: Add a customer direct debitmandate
+        description: >-
+          
+        parameters:
+          - name: billingInformationId
+            in: path
+            required: true  
+            schema:
+              type: integer
+              example: 1
+        requestBody:
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/mandateEntity"
+              examples:
+                customerDirectDebitMandatePrepared:
+                  value:
+                    directDebitMandate:
+                      directDebitMandateTypeId: 1 
+                      mandateAddressId: 1               
+                      mandateReference: HTM-mandate-001
+                      mandateState: PREPARED
+          required: true
+        responses:
+          201:
+            description: Successfully created a customer mandate
+            content:
+              application/json:
+                schema:
+                  $ref: "#/components/schemas/postDirectDebitMandateResponse"
+        security:
+          - default: []
+        x-auth-type: Application & Application User
+        x-throttling-tier: Unlimited
 components:
   securitySchemes:
     default:
@@ -1821,6 +1860,8 @@ components:
     ovPayTokenEntity:
       type: object
       properties:
+        ovPayTokenId:
+          type: integer
         tokenType: 
           type: object
           properties:
@@ -2036,12 +2077,9 @@ components:
         billingInformationId:
           type: integer
           example: 1
-    postCustomerProfileDirectDebitMandateResponse:
+    postDirectDebitMandateResponse:
       type: object
       properties:
-        customerNumber:
-          type: integer
-          example: 10000001
         directDebitMandateId:
           type: integer
           example: 1
@@ -2078,43 +2116,26 @@ components:
         customerLanguageId:
           type: integer
           example: 1
-    ovPayTokenGetEntity:
-      type: object
-      properties:
-        ovPayTokenId:
-          type: integer
-          example: 1
-        tokenTypeId:
-          type: integer
-          example: 1
-        xTat:
-          type: string
-          example: 0044831b-8e80c-4f82-r989a-8d85ee1996
-        xBot:
-          type: string
-          example: 0044831b-8e80c-4f82-r989a-8d85ee1996
-        lastDigits:
-          type: string
-          example: "0001"
-        ovpasNumber:
-          type: integer
-          example: 1
-        alias:
-          type: string
-          example: alias
-        tokenStatusId:
-          type: integer
-        expirationDate:
-          type: string
-        replacedByTokenId:
-          type: integer
     getCustomerProfileOvPayTokenResponse:
       type: object
       properties:
         ovPayToken:
           type: array
           items:
-            $ref: "#/components/schemas/ovPayTokenGetEntity"
+            $ref: "#/components/schemas/ovPayTokenEntity"
+    mandateEntity:
+      type: object
+      properties:
+        directDebitMandateId: 
+          type: integer
+        directDebitMandateTypeId: 
+          type: integer                     
+        mandateAddressId: 
+          type: integer                   
+        mandateReference: 
+          type: string
+        mandateState:
+          type: string
     postOvPayTokenResponse:
       type: object
       properties: