From 038332e1e02cf9d075444250dc6b78c0e18a7012 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Mon, 23 Oct 2023 09:28:00 +0200 Subject: [PATCH] spec release --- json/ManagementNotificationService-v3.json | 94 ++++++++++++++------- json/ManagementService-v3.json | 98 ++++++++++++++++++++++ yaml/ManagementNotificationService-v3.yaml | 80 ++++++++++++------ yaml/ManagementService-v3.yaml | 64 ++++++++++++++ 4 files changed, 280 insertions(+), 56 deletions(-) diff --git a/json/ManagementNotificationService-v3.json b/json/ManagementNotificationService-v3.json index 428e33d..2eefb93 100644 --- a/json/ManagementNotificationService-v3.json +++ b/json/ManagementNotificationService-v3.json @@ -211,7 +211,7 @@ } }, "schema" : { - "$ref" : "#/components/schemas/NotificationDataMessage" + "$ref" : "#/components/schemas/PaymentMethodRequestRemovedNotificationRequest" } } } @@ -262,7 +262,7 @@ } }, "schema" : { - "$ref" : "#/components/schemas/NotificationDataMessage" + "$ref" : "#/components/schemas/PaymentMethodScheduledForRemovalNotificationRequest" } } } @@ -596,34 +596,6 @@ ], "type" : "object" }, - "NotificationDataMessage" : { - "properties" : { - "createdAt" : { - "description" : "Timestamp for when the webhook was created.", - "format" : "date-time", - "type" : "string" - }, - "data" : { - "description" : "Contains event details.", - "$ref" : "#/components/schemas/MidServiceNotificationData" - }, - "environment" : { - "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", - "type" : "string" - }, - "type" : { - "description" : "Type of notification.", - "type" : "string" - } - }, - "required" : [ - "type", - "environment", - "createdAt", - "data" - ], - "type" : "object" - }, "PaymentMethodCreatedNotificationRequest" : { "properties" : { "createdAt" : { @@ -664,6 +636,68 @@ }, "type" : "object" }, + "PaymentMethodRequestRemovedNotificationRequest" : { + "properties" : { + "createdAt" : { + "description" : "Timestamp for when the webhook was created.", + "format" : "date-time", + "type" : "string" + }, + "data" : { + "description" : "Contains event details.", + "$ref" : "#/components/schemas/MidServiceNotificationData" + }, + "environment" : { + "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "Type of notification.", + "enum" : [ + "paymentMethod.requestRemoved" + ], + "type" : "string" + } + }, + "required" : [ + "environment", + "createdAt", + "data", + "type" + ], + "type" : "object" + }, + "PaymentMethodScheduledForRemovalNotificationRequest" : { + "properties" : { + "createdAt" : { + "description" : "Timestamp for when the webhook was created.", + "format" : "date-time", + "type" : "string" + }, + "data" : { + "description" : "Contains event details.", + "$ref" : "#/components/schemas/MidServiceNotificationData" + }, + "environment" : { + "description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.", + "type" : "string" + }, + "type" : { + "description" : "Type of notification.", + "enum" : [ + "paymentMethod.requestScheduledForRemoval" + ], + "type" : "string" + } + }, + "required" : [ + "environment", + "createdAt", + "data", + "type" + ], + "type" : "object" + }, "RemediatingAction" : { "properties" : { "code" : { diff --git a/json/ManagementService-v3.json b/json/ManagementService-v3.json index f317c24..66e2d49 100644 --- a/json/ManagementService-v3.json +++ b/json/ManagementService-v3.json @@ -5653,6 +5653,91 @@ } } }, + "/me/generateClientKey" : { + "post" : { + "tags" : [ + "My API credential" + ], + "summary" : "Generate new client key for self", + "description" : "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works) for the caller - API Credential or OAuth Access Token. You can use the new client key a few minutes after generating it. The old client key stops working 24 hours after generating a new one.To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n* Management API—API credentials read and write", + "operationId" : "post-me-generateClientKey", + "x-groupName" : "My API credential", + "x-sortIndex" : 0, + "x-methodName" : "generateNewClientKeyForSelf", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenerateClientKeyResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RestServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/merchants" : { "get" : { "tags" : [ @@ -17393,6 +17478,15 @@ ], "type" : "object" }, + "Localization" : { + "properties" : { + "language" : { + "description" : "Language of the terminal.", + "type" : "string" + } + }, + "type" : "object" + }, "Logo" : { "properties" : { "data" : { @@ -19710,6 +19804,10 @@ "description" : "Settings for terminal hardware features.", "$ref" : "#/components/schemas/Hardware" }, + "localization" : { + "description" : "Settings for localization.", + "$ref" : "#/components/schemas/Localization" + }, "nexo" : { "description" : "Settings for a Terminal API integration.", "$ref" : "#/components/schemas/Nexo" diff --git a/yaml/ManagementNotificationService-v3.yaml b/yaml/ManagementNotificationService-v3.yaml index acc967b..7828feb 100644 --- a/yaml/ManagementNotificationService-v3.yaml +++ b/yaml/ManagementNotificationService-v3.yaml @@ -148,7 +148,7 @@ webhooks: paymentMethod.requestRemoved: $ref: '#/components/examples/post-paymentMethod.requestRemoved-paymentMethod.requestRemoved' schema: - $ref: '#/components/schemas/NotificationDataMessage' + $ref: '#/components/schemas/PaymentMethodRequestRemovedNotificationRequest' responses: '200': content: @@ -181,7 +181,7 @@ webhooks: paymentMethod.requestScheduledForRemoval: $ref: '#/components/examples/post-paymentMethod.requestScheduledForRemoval-paymentMethod.requestScheduledForRemoval' schema: - $ref: '#/components/schemas/NotificationDataMessage' + $ref: '#/components/schemas/PaymentMethodScheduledForRemovalNotificationRequest' responses: '200': content: @@ -545,30 +545,6 @@ components: - id - type type: object - NotificationDataMessage: - properties: - createdAt: - description: Timestamp for when the webhook was created. - format: date-time - type: string - data: - description: Contains event details. - $ref: '#/components/schemas/MidServiceNotificationData' - environment: - description: 'The environment from which the webhook originated. - - - Possible values: **test**, **live**.' - type: string - type: - description: Type of notification. - type: string - required: - - type - - environment - - createdAt - - data - type: object PaymentMethodCreatedNotificationRequest: properties: createdAt: @@ -602,6 +578,58 @@ components: body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). type: string type: object + PaymentMethodRequestRemovedNotificationRequest: + properties: + createdAt: + description: Timestamp for when the webhook was created. + format: date-time + type: string + data: + description: Contains event details. + $ref: '#/components/schemas/MidServiceNotificationData' + environment: + description: 'The environment from which the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: Type of notification. + enum: + - paymentMethod.requestRemoved + type: string + required: + - environment + - createdAt + - data + - type + type: object + PaymentMethodScheduledForRemovalNotificationRequest: + properties: + createdAt: + description: Timestamp for when the webhook was created. + format: date-time + type: string + data: + description: Contains event details. + $ref: '#/components/schemas/MidServiceNotificationData' + environment: + description: 'The environment from which the webhook originated. + + + Possible values: **test**, **live**.' + type: string + type: + description: Type of notification. + enum: + - paymentMethod.requestScheduledForRemoval + type: string + required: + - environment + - createdAt + - data + - type + type: object RemediatingAction: properties: code: diff --git a/yaml/ManagementService-v3.yaml b/yaml/ManagementService-v3.yaml index 392a4cf..2527b17 100644 --- a/yaml/ManagementService-v3.yaml +++ b/yaml/ManagementService-v3.yaml @@ -3711,6 +3711,61 @@ paths: schema: $ref: '#/components/schemas/RestServiceError' description: Internal Server Error - the server could not process the request. + /me/generateClientKey: + post: + tags: + - My API credential + summary: Generate new client key for self + description: "Returns a new [client key](https://docs.adyen.com/development-resources/client-side-authentication#how-it-works)\ + \ for the caller - API Credential or OAuth Access Token. You can use the new\ + \ client key a few minutes after generating it. The old client key stops working\ + \ 24 hours after generating a new one.To make this request, your API credential\ + \ must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions):\n\ + * Management API\u2014API credentials read and write" + operationId: post-me-generateClientKey + x-groupName: My API credential + x-sortIndex: 0 + x-methodName: generateNewClientKeyForSelf + security: + - BasicAuth: [] + - ApiKeyAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GenerateClientKeyResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/RestServiceError' + description: Internal Server Error - the server could not process the request. /merchants: get: tags: @@ -11946,6 +12001,12 @@ components: - itemsTotal - pagesTotal type: object + Localization: + properties: + language: + description: Language of the terminal. + type: string + type: object Logo: properties: data: @@ -14089,6 +14150,9 @@ components: hardware: description: Settings for terminal hardware features. $ref: '#/components/schemas/Hardware' + localization: + description: Settings for localization. + $ref: '#/components/schemas/Localization' nexo: description: Settings for a Terminal API integration. $ref: '#/components/schemas/Nexo'