Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed May 6, 2024
1 parent f53e1a7 commit af350a1
Show file tree
Hide file tree
Showing 8 changed files with 434 additions and 2 deletions.
123 changes: 123 additions & 0 deletions json/ManagementNotificationService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
},
{
"name" : "Payment method"
},
{
"name" : "Terminal management"
}
],
"x-staticResponse" : "response.json",
Expand Down Expand Up @@ -158,6 +161,46 @@
}
}
}
},
"terminalSettings.modified" : {
"post" : {
"tags" : [
"Terminal management"
],
"summary" : "Terminal settings updated",
"description" : "A request to [update terminal settings](https://docs.adyen.com/api-explorer/Management/latest/patch/terminals/(terminalId)/terminalSettings) was completed.",
"x-addedInVersion" : "1",
"operationId" : "post-terminalSettings.modified",
"x-sortIndex" : 1,
"x-methodName" : "terminalSettingsUpdated",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalSettingsNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalSettingsNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
}
},
"components" : {
Expand Down Expand Up @@ -536,6 +579,86 @@
},
"type" : "object"
},
"TerminalSettingsData" : {
"additionalProperties" : false,
"properties" : {
"companyId" : {
"description" : "The unique identifier of the company account.",
"type" : "string"
},
"merchantId" : {
"description" : "The unique identifier of the merchant account.",
"type" : "string"
},
"storeId" : {
"description" : "The unique identifier of the store.",
"type" : "string"
},
"terminalId" : {
"description" : "The unique identifier of the terminal.",
"type" : "string"
},
"updateSource" : {
"description" : "Indicates whether the terminal settings were updated using the Customer Area or the Management API.",
"enum" : [
"Customer Area",
"Management Api"
],
"type" : "string"
},
"user" : {
"description" : "The user that updated the terminal settings. Can be Adyen or your API credential username.",
"type" : "string"
}
},
"required" : [
"user",
"updateSource"
],
"type" : "object"
},
"TerminalSettingsNotificationRequest" : {
"additionalProperties" : false,
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/TerminalSettingsData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"terminalSettings.modified"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"TerminalSettingsNotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
"type" : "object"
},
"VerificationError" : {
"additionalProperties" : false,
"properties" : {
Expand Down
123 changes: 123 additions & 0 deletions json/ManagementNotificationService-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
},
{
"name" : "Payment method"
},
{
"name" : "Terminal management"
}
],
"x-staticResponse" : "response.json",
Expand Down Expand Up @@ -248,6 +251,46 @@
}
}
}
},
"terminalSettings.modified" : {
"post" : {
"tags" : [
"Terminal management"
],
"summary" : "Terminal settings updated",
"description" : "A request to [update terminal settings](https://docs.adyen.com/api-explorer/Management/latest/patch/terminals/(terminalId)/terminalSettings) was completed.",
"x-addedInVersion" : "1",
"operationId" : "post-terminalSettings.modified",
"x-sortIndex" : 1,
"x-methodName" : "terminalSettingsUpdated",
"security" : [
{
"BasicAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalSettingsNotificationRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminalSettingsNotificationResponse"
}
}
},
"description" : "OK - the request has succeeded."
}
}
}
}
},
"components" : {
Expand Down Expand Up @@ -694,6 +737,86 @@
},
"type" : "object"
},
"TerminalSettingsData" : {
"additionalProperties" : false,
"properties" : {
"companyId" : {
"description" : "The unique identifier of the company account.",
"type" : "string"
},
"merchantId" : {
"description" : "The unique identifier of the merchant account.",
"type" : "string"
},
"storeId" : {
"description" : "The unique identifier of the store.",
"type" : "string"
},
"terminalId" : {
"description" : "The unique identifier of the terminal.",
"type" : "string"
},
"updateSource" : {
"description" : "Indicates whether the terminal settings were updated using the Customer Area or the Management API.",
"enum" : [
"Customer Area",
"Management Api"
],
"type" : "string"
},
"user" : {
"description" : "The user that updated the terminal settings. Can be Adyen or your API credential username.",
"type" : "string"
}
},
"required" : [
"user",
"updateSource"
],
"type" : "object"
},
"TerminalSettingsNotificationRequest" : {
"additionalProperties" : false,
"properties" : {
"createdAt" : {
"description" : "Timestamp for when the webhook was created.",
"format" : "date-time",
"type" : "string"
},
"data" : {
"description" : "Contains event details.",
"$ref" : "#/components/schemas/TerminalSettingsData"
},
"environment" : {
"description" : "The environment from which the webhook originated.\n\nPossible values: **test**, **live**.",
"type" : "string"
},
"type" : {
"description" : "Type of notification.",
"enum" : [
"terminalSettings.modified"
],
"type" : "string"
}
},
"required" : [
"environment",
"createdAt",
"data",
"type"
],
"type" : "object"
},
"TerminalSettingsNotificationResponse" : {
"additionalProperties" : false,
"properties" : {
"notificationResponse" : {
"description" : "Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications).",
"type" : "string"
}
},
"type" : "object"
},
"VerificationError" : {
"additionalProperties" : false,
"properties" : {
Expand Down
2 changes: 1 addition & 1 deletion json/ManagementService-v1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20856,7 +20856,7 @@
"type" : "string"
},
"type" : {
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
Expand Down
2 changes: 1 addition & 1 deletion json/ManagementService-v3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21270,7 +21270,7 @@
"type" : "boolean"
},
"type" : {
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"description" : "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n- **terminal-settings**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
"type" : "string"
},
"url" : {
Expand Down
Loading

0 comments on commit af350a1

Please sign in to comment.