From 61332e38c6b645e8d8461e8ad0238930598ca68a Mon Sep 17 00:00:00 2001 From: Mirjam Herald Date: Mon, 17 Nov 2025 15:16:26 +0100 Subject: [PATCH] small fixes preference and status Id's --- src/openapi/customers/customers-crud-v2.yaml | 41 +- src/openapi/customers/se-maileon.yaml | 468 ------------------- 2 files changed, 27 insertions(+), 482 deletions(-) delete mode 100644 src/openapi/customers/se-maileon.yaml diff --git a/src/openapi/customers/customers-crud-v2.yaml b/src/openapi/customers/customers-crud-v2.yaml index fd27b1a..f00e496 100644 --- a/src/openapi/customers/customers-crud-v2.yaml +++ b/src/openapi/customers/customers-crud-v2.yaml @@ -224,13 +224,15 @@ paths: name: Inactive vasCustomerNumber: CST005 customerPreference: + customerPreferenceId: 1 language: languageId: 1 name: Dutch ietfCode: nl-NL iso639Code: nl customerStatusInstances: - - customerStatus: + - customerStatusInstanceId: 1 + customerStatus: name: Active customerStatusId: 2 fromInclusive: "2022-08-04 15:01:00.000" @@ -346,24 +348,28 @@ paths: debtorStatusId: 1 name: Inactive vasCustomerNumber: CST005 - customerPreference: + customerPreference: + customerPreferenceId: 2 language: languageId: 1 name: Dutch ietfCode: nl-NL iso639Code: nl - customerStatusInstances: - - customerStatus: + customerStatusInstances: + - customerStatusInstanceId: 1 + customerStatus: name: Active customerStatusId: 2 fromInclusive: "2022-08-04 15:01:00.000" toInclusive: "2022-08-05 15:01:00.000" - - customerStatus: + - customerStatusInstanceId: 4 + customerStatus: name: Blocked customerStatusId: 3 fromInclusive: "2022-08-05 15:01:00.000" toInclusive: "2023-08-05 15:01:00.000" - - customerStatus: + - customerStatusInstanceId: 9 + customerStatus: name: Active customerStatusId: 2 fromInclusive: "2023-08-05 15:01:00.000" @@ -504,14 +510,16 @@ paths: debtorStatusId: 1 name: Inactive vasCustomerNumber: CST005 - customerPreference: + customerPreference: + customerPreferenceId: 1 language: languageId: 1 name: Dutch ietfCode: nl-NL iso639Code: nl customerStatusInstances: - - customerStatus: + - customerStatusInstanceId: 1 + customerStatus: name: Active customerStatusId: 2 fromInclusive: "2022-08-04 15:01:00.000" @@ -641,19 +649,22 @@ paths: debtorStatusId: 2 name: Active vasCustomerNumber: CST005 - customerPreference: + customerPreference: + customerPreferenceId: 5 language: languageId: 1 name: Dutch ietfCode: nl-NL iso639Code: nl customerStatusInstances: - - customerStatus: + - customerStatusInstanceId: 1 + customerStatus: name: Active customerStatusId: 2 fromInclusive: "2022-08-04 15:01:00.000" toInclusive: "2022-08-05 15:01:00.000" - - customerStatus: + - customerStatusInstanceId: 2 + customerStatus: name: Blocked customerStatusId: 3 fromInclusive: "2022-08-05 15:01:00.000" @@ -2362,9 +2373,11 @@ components: format: date alias: type: string - getCustomerStatusInstance: + getCustomerStatusInstanceId: type: object - properties: + properties: + customerStatusInstanceId: + type: integer customerStatus: $ref: "#/components/schemas/getCustomerStatus" fromInclusive: @@ -2710,7 +2723,7 @@ components: postCustomerStatusResponse: type: object properties: - customerPreferenceId: + customerStatusInstanceId: type: integer example: 1 postCustomerPreferencesResponse: diff --git a/src/openapi/customers/se-maileon.yaml b/src/openapi/customers/se-maileon.yaml deleted file mode 100644 index 5b9b38d..0000000 --- a/src/openapi/customers/se-maileon.yaml +++ /dev/null @@ -1,468 +0,0 @@ -openapi: 3.0.1 -info: - title: Service Engine APIs for maileon - description: >- - Service Engine APIs for maileon. These are NOT the CRUD APIs to access raw data in the database. - version: "1.0" -servers: - - url: https://services.acc.api.htm.nl/abt/maileon/1.0 -tags: - - name: Customers - description: >- - Service Engine API's for maileon to update the customer profile. Only field isEmailVerified. - - name: Notification categories - description: >- - Service Engine APIs for all HTM Notifications metadata. To build content only. - - name: Notification subscriptions - description: >- - Service Engine APIs for the HTM Notification subscriptions for a user. Contains the subscriptions on category level. -paths: - /customers: - patch: - tags: - - Customers - parameters: - - name: customerProfileId - in: header - schema: - type: string - example: 1 - required: true - description: The customerProfileId of a customer - - name: emailAddress - in: header - schema: - type: string - format: email - example: john.doe@mymailprovider.com - required: true - description: The emailadress of the customer - summary: Update a customer profile - description: Update a customer profile based on the customerProfileId and emailAddress - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/unavailable" - examples: - patchCustomer: - value: - { - "person": { - "isEmailVerified": True - } - } - responses: - "202": - description: OK - /notificationcategories: - get: - tags: - - Notification categories - summary: Get notification categories and optins for that category that a touchpoint can show. - description: | - Get notification categories that a touchpoint can show and optins ( eventTypes) and channels (eventType_channels) for the optin for that category - parameters: - - name: expand - in: query - schema: - type: string - enum: [none, eventType, eventTypeChannel] - default: none - responses: - "200": - description: OK - content: - application/json: - examples: - getNotifactionCategories?expand=evenTypeChannel: - summary: Return all the notification categories with their nested attributes - value: - { - "notificationCategories":[ - { - "notificationCategoryId": 1, - "name": "Nieuwsbrief", - "eventTypes": [ - { - "eventTypeId": 1, - "eventOrigin": { - "eventOriginId": 6, - "name": "Maileon" - }, - "name": "HTM nieuwsbrief", - "subName": "", - "prettyName": "HTM nieuwsbrief", - "optinRequired": False, - "eventTypeChannels":[ - { - "eventTypeChannelId": "447a1116-6cd7-4645-8c3d-43237b6186cd", - "channel":{ - "channelId": 2, - "name": "email" - }, - "isDefault": True, - "isMandatory": False - } - ] - } - ] - }, - { - "notificationCategoryId": 2, - "name": "Mijn Reizen", - "eventTypes": [ - { - "eventTypeId": 2, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, TRAVEL_SCHEME", - "subName": "CI", - "prettyName": "Check In", - "optinRequired": False, - "eventTypeChannels":[ - { - "eventTypeChannelId": "ccc8c025-06b5-4928-a632-23e1c55cd173", - "channel":{ - "channelId": 1, - "name": "push" - }, - "isDefault": True, - "isMandatory": False - }, - { - "eventTypeChannelId": "da2deb4c-ce77-4b5f-aecc-ddebfd14349d", - "channel":{ - "channelId": 2, - "name": "email" - }, - "isDefault": False, - "isMandatory": False - } - ] - }, - { - "eventTypeId": 3, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, PAD", - "subName": null, - "prettyName": "Profielgegevens op de pas", - "optinRequired": False, - "eventTypeChannels":[ - { - "eventTypeChannelId": "8e7df8f1-7e50-482f-8301-d399e75fd432", - "channel":{ - "channelId": 1, - "name": "push" - }, - "isDefault": True, - "isMandatory": False - }, - { - "eventTypeChannelId": "72960a92-1855-469f-9cfd-5d72f57106f2", - "channel":{ - "channelId": 2, - "name": "email" - }, - "isDefault": False, - "isMandatory": False - } - ] - } - ] - }, - { - "notificationCategoryId": 3, - "name": "Mijn Passen", - "eventTypes": [ - { - "eventTypeId": 4, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, CARD", - "subName": null, - "prettyName": "Mijn passen", - "optinRequired": False, - "eventTypeChannels":[ - { - "eventTypeChannelId": "be07c7bb-714b-4637-acf5-a67025ad8e60", - "channel":{ - "channelId": 1, - "name": "push" - }, - "isDefault": True, - "isMandatory": False - }, - { - "eventTypeChannelId": "0c797b5a-ed34-494b-8c64-0a832830d392", - "channel":{ - "channelId": 2, - "name": "email" - }, - "isDefault": False, - "isMandatory": False - } - ] - }, - { - "eventTypeId": 5, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, PAD", - "subName": null, - "prettyName": "Profielgegevens op de pas", - "optinRequired": False, - "eventTypeChannels":[ - { - "eventTypeChannelId": "b910368f-c045-4e8e-b01d-bcbc78708bac", - "channel":{ - "channelId": 1, - "name": "push" - }, - "isDefault": True, - "isMandatory": False - }, - { - "eventTypeChannelId": "93e773da-ba3b-48da-9a0e-ee478eaa752f", - "channel":{ - "channelId": 2, - "name": "email" - }, - "isDefault": False, - "isMandatory": False - } - ] - } - ] - } - ] - } - getNotifactionCategories?expand=eventType: - summary: Return all the notification categories with nested eventTypes - value: - { - "notificationCategories":[ - { - "notificationCategoryId": 1, - "name": "Nieuwsbrief", - "eventTypes": [ - { - "eventTypeId": 1, - "eventOrigin": { - "eventOriginId": 6, - "name": "Maileon" - }, - "name": "HTM nieuwsbrief", - "subName": "", - "prettyName": "HTM nieuwsbrief", - "optinRequired": False - } - ] - }, - { - "notificationCategoryId": 2, - "name": "Mijn Reizen", - "eventTypes": [ - { - "eventTypeId": 2, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, TRAVEL_SCHEME", - "subName": "CI", - "prettyName": "Check In", - "optinRequired": False - }, - { - "eventTypeId": 3, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, PAD", - "subName": null, - "prettyName": "Profielgegevens op de pas", - "optinRequired": False - } - ] - }, - { - "notificationCategoryId": 3, - "name": "Mijn Passen", - "eventTypes": [ - { - "eventTypeId": 4, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, CARD", - "subName": null, - "prettyName": "Mijn passen", - "optinRequired": False - }, - { - "eventTypeId": 5, - "eventOrigin": { - "eventOriginId": 1, - "name": "GBO" - }, - "name": "ALERTS, PAD", - "subName": null, - "prettyName": "Profielgegevens op de pas", - "optinRequired": False - } - ] - } - ] - } - getNotifactionCategories?expand=none: - summary: Return all the notification categories - value: - { - "notificationCategories":[ - { - "notificationCategoryId": 1, - "name": "Nieuwsbrief" - }, - { - "notificationCategoryId": 2, - "name": "Mijn Reizen" - }, - { - "notificationCategoryId": 3, - "name": "Mijn Passen" - } - ] - } - "404": - description: No notification category found - content: - application/json: - example: - { - "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", - "title": "Niet gevonden", - "detail": "Notificatiecategorie niet gevonden", - "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", - "errors": [ - { - "code": "404", - "detail": null, - "path": null, - "parameter": null - } - ], - } - /notificationsubscriptions: - get: - tags: - - Notification subscriptions - summary: Get all possible notificationSubscriptions for a customer (account or private). - description: | - Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it. - parameters: - - name: customerProfileId - in: header - schema: - type: integer - example: 12361 - required: true - description: The customerProfileId of a customer - responses: - "200": - description: OK - content: - application/json: - examples: - getNotifactionSubscriptionsAll: - summary: Return all the notification subscriptions where for each category the client has actively opted in or out - All - value: - { - "notificationSubscriptions":[ - { - "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903", - "notificationCategoryId": 1, - "isActive": true - }, - { - "notificationSubscriptionId": "571388cd-8903-40d5-89e6-9191cb8d656e", - "notificationCategoryId": 2, - "isActive": true - }, - { - "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b", - "notificationCategoryId": 3, - "isActive": false - } - ] - } - getNotifactionSubscriptionsSome: - summary: Return all the notification subscriptions where for each category the client has actively opted in or out - Some - value: - { - "notificationSubscriptions": [ - { - "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903", - "notificationCategoryId": 1, - "isActive": true - }, - { - "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b", - "notificationCategoryId": 3, - "isActive": false - } - ] - } - "403": - description: Forbidden // Als geverifieerd profiel gevonden wordt, maar niet op een geverifieerde manier benaderd wordt - content: - application/json: - example: - { - "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", - "title": "Verboden", - "detail": "Niet toegestaan", - "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", - "errors": [ - { - "code": "403", - "detail": null, - "path": null, - "parameter": null - } - ], - } - "404": - description: No notification subscriptions found - content: - application/json: - example: - { - "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", - "title": "Niet gevonden", - "detail": "Notificaties niet gevonden", - "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", - "errors": [ - { - "code": "404", - "detail": null, - "path": null, - "parameter": null - } - ], - } -components: - schemas: - unavailable: - type: object \ No newline at end of file