src/openapi/customers/SE-notifications.yaml

@@ -410,25 +410,47 @@ paths:
             schema:
               $ref: "#/components/schemas/unavailable"
             examples:
-              Create notificationSubscription anonymous:
+              Create notificationSubscription anonymous active:
                 value:
                   {
                     "emailAddress": "anonymous@mymailprovider.com",
-                    "notificationCategoryId": 1
+                    "notificationCategoryId": 1,
+                    "isActive": True,
+                  }
+              Create notificationSubscription anonymous inactive:
+                value:
+                  {
+                    "emailAddress": "anonymous@mymailprovider.com",
+                    "notificationCategoryId": 1,
+                    "isActive": False,
                   }
               Create notificationSubscription account active:
-                value: { "notificationCategoryId": 2 }
+                value: { "notificationCategoryId": 2, "isActive": True }
+              Create notificationSubscription account inactive:
+                value: { "notificationCategoryId": 2, "isActive": False }
       responses:
         "201":
           description: Created
           content:
             application/json:
               examples:
-                Create notificationSubscription anonymous:
+                Create notificationSubscription anonymous active:
-                  summary: Return the created notification for an anonymous user inactive by default.
+                  summary: Return the created notification for an anonymous user active
                   value:
                     {
                       "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
+                      "notificationCategory":
+                        {
+                          "notificationCategoryId": 2,
+                          "name": "Nieuwsbrief aanmelding",
+                        },
+                      "isActive": True,
+                    }
+                Create notificationSubscription anonymous inactive:
+                  summary: Return the created notification for an anonymous user inactive
+                  value:
+                    {
+                      "notificationSubscriptionId": "d51081fd-c48d-4111-8de4-ac5db7d47ecb",
                       "notificationCategory":
                         {
                           "notificationCategoryId": 2,
@@ -445,6 +467,15 @@ paths:
                         { "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
                       "isActive": True,
                     }
+                Create notificationSubscription account inactive:
+                  summary: Return the created notification for an anonymous user inactive
+                  value:
+                    {
+                      "notificationSubscriptionId": "0dfc0ac9-c221-4493-8828-9dfa79ad9061",
+                      "notificationCategory":
+                        { "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
+                      "isActive": False,
+                    }
         "405":
           description: Method not allowed, ook als een notificatie aangemaakt wordt voor een account maar op een anonieme manier benadert wordt.
           content:
@@ -469,9 +500,9 @@ paths:
     patch:
       tags:
         - Notification subscriptions
-      summary: Update a notificationSubscription for a customer.
+      summary: Update a notificationSubscription for a customer (account or private).
       description: |
-        Update a  notificationSubscription for a customer.
+        Update a  notificationSubscription for a customer (account or private).
       parameters:
         - name: X-HTM-JWT-AUTH-HEADER
           in: header
@@ -502,6 +533,14 @@ paths:
             example: e112f26e-37fa-4bde-8def-9977cd1d50ae
           required: true
           description: The id of the notificationSubscription you want to update
+        - name: emailAddress
+          in: query
+          schema:
+            type: string
+            format: email
+            example: john.doe@mymailprovider.com
+          required: false
+          description: The emailadress of the customer in the case of anonymous opt-ins
       requestBody:
         content:
           application/json:
@@ -542,26 +581,6 @@ paths:
                         },
                       "isActive": True,
                     }
-        "405":
-          description: Method not allowed,wanneer het account emailadres niet geverifieerd is.
-          content:
-            application/json:
-              example:
-                {
-                  "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
-                  "title": "Methode niet toegestaan",
-                  "detail": "",
-                  "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
-                  "errors":
-                    [
-                      {
-                        "code": "405",
-                        "detail": null,
-                        "path": null,
-                        "parameter": null,
-                      },
-                    ],
-                }
 components:
   schemas:
     unavailable: