diff --git a/src/openapi/customers/se-maileon.yaml b/src/openapi/customers/se-maileon.yaml index 9df569e..504f291 100644 --- a/src/openapi/customers/se-maileon.yaml +++ b/src/openapi/customers/se-maileon.yaml @@ -27,8 +27,16 @@ paths: schema: type: string example: 1 - required: false + 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 requestBody: @@ -359,35 +367,13 @@ paths: description: | Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it. 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 + - name: customerProfileId 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: 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 + description: The customerProfileId of a customer responses: "200": description: OK @@ -459,89 +445,6 @@ paths: "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "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: schemas: unavailable: