HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 4 Actions Packages Projects Releases 1 Wiki Activity

features/TP-notifications #34

Merged
MirjamHTM merged 16 commits from features/TP-notifications into develop 2025-11-06 09:18:20 +00:00
Conversation 0 Commits 16 Files Changed 3 +11 -108
1 changed files with 11 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 4202bb03f1 - Show all commits

119
src/openapi/customers/se-maileon.yaml
View File

@ -27,8 +27,16 @@ paths:
schema: schema:
type: string type: string
example: 1 example: 1
required: false required: true
description: The customerProfileId of a customer 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 summary: Update a customer profile
description: Update a customer profile based on the customerProfileId description: Update a customer profile based on the customerProfileId
requestBody: requestBody:
@ -359,35 +367,13 @@ paths:
description: | description: |
Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it. Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it.
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: customerProfileId
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 in: header
schema: schema:
type: string type: string
MirjamHTM marked this conversation as resolved
bboterm commented 2025-11-04 11:35:31 +00:00
Review
Copy Link

CustomerProfileId is een integer.

CustomerProfileId is een integer.
example: feaaef83-a551-4283-8419-340b1ada3b55 example: feaaef83-a551-4283-8419-340b1ada3b55
required: false required: false
description: The customerProfileId of a customer in the case of the SMP description: The customerProfileId of a customer
- 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
- 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
responses: responses:
"200": "200":
description: OK description: OK
@ -459,89 +445,6 @@ paths:
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [{ "subApiErrorCode": "0017" }], "errors": [{ "subApiErrorCode": "0017" }],
} }
/notificationsubscriptions/{notificationSubscriptionId}:
patch:
tags:
- Notification subscriptions
summary: Update a notificationSubscription for a customer (account or private).
description: |
Update a notificationSubscription for a customer (account or private).
parameters:
- 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: string
example: feaaef83-a551-4283-8419-340b1ada3b55
required: false
description: The customerProfileId of a customer in the case of the SMP
- 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
- name: notificationSubscriptionId
in: path
schema:
type: string
format: uuid
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:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Update a notificationSubscription to inactive:
value:
{
"isActive": False
}
Update a notificationSubscription to active:
value:
{
"isActive": True
}
responses:
"200":
description: OK
content:
application/json:
examples:
Update a notificationSubscription to inactive:
summary: Return the updated notification
value:
{
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
"notificationCategoryId": 1,
"isActive": False
}
Update a notificationSubscription to active:
summary: Return the updated notification
value:
{
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
"notificationCategoryId": 1,
"isActive": True
}
components: components:
schemas: schemas:
unavailable: unavailable: