diff --git a/src/openapi/customers/SE-customers-v2.yaml b/src/openapi/customers/SE-customers-v2.yaml index d0258e4..b943409 100644 --- a/src/openapi/customers/SE-customers-v2.yaml +++ b/src/openapi/customers/SE-customers-v2.yaml @@ -1977,7 +1977,7 @@ paths: type: integer example: 1 required: true - summary: Replace an OVpay token with another (+ transfer products) - V1 (for touch point) + summary: Replace an OVpay token with another (+ transfer products) - V2 (for touch point) description: | Transfer products from one OVpay token to another, and replace the tokens in the database. This endpoint is for touch point usage and will be replaced by `/customers/tokens/{ovpayTokenId}/transfer`. @@ -3881,6 +3881,87 @@ paths: ], } /customers/devices: + get: + summary: Retrieve devices for a customer profile. + description: Retrieve devices for a customer profile. + tags: + - Devices + 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: integer + example: 323 + required: false + description: The id of the customer Profile + - 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: deviceId + in: query + schema: + type: string + format: uuid + example: 3fc3e1d2-cbca-4c67-9210-77601301fd75 + - name: externalDeviceId + in: query + schema: + type: string + example: dsafdefaere5435255 + - name: customerProfileId + in: query + schema: + type: integer + example: 1 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + One device found: + value: + { + "devices": + [ + { + "customerProfileId": 1, + "deviceId": "0f0981bf-6d60-4b06-bc55-de1ba325f366", + "externalDeviceId": "dee7d80e-9288-4508-a3ed-c067e619179f", + "alias": "My iPhone 13" + } + ] + } + Multiple devices found: + value: + { + "devices": + [ + { + "deviceId": "5bedce29-af0c-4f3c-b182-2caa8a1f9377", + "externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848", + "alias": "iPhone prive", + }, + { + "deviceId": "d7683e89-b2ad-4e79-85b3-dbb42aad0325", + "externalDeviceId": "7122a988-a00a-417d-a5b4-da2d91354976", + "alias": "iPhone zakelijk", + } + ] + } post: summary: Add a new device to a customer profile. description: Add a new device to a customer profile.