@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Notification Configuration API
@base https://cal-test.adyen.com/cal/services/Notification/v6
@version 6
@auth ApiKey X-API-Key in header | Bearer basic
@endpoints 6
@toc createNotificationConfiguration(1), deleteNotificationConfigurations(1), getNotificationConfiguration(1), getNotificationConfigurationList(1), testNotificationConfiguration(1), updateNotificationConfiguration(1)

@group createNotificationConfiguration
@endpoint POST /createNotificationConfiguration
@required {configurationDetails: map{active: bool, apiVersion: int(int32), description: str, eventConfigs: [map], hmacSignatureKey: str, notificationId: int(int64), notifyPassword: str, notifyURL: str, notifyUsername: str, sslProtocol: str}}
@returns(200) {configurationDetails: map{active: bool, apiVersion: int(int32), description: str, eventConfigs: [map], hmacSignatureKey: str, notificationId: int(int64), notifyPassword: str, notifyURL: str, notifyUsername: str, sslProtocol: str}, invalidFields: [map], pspReference: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@group deleteNotificationConfigurations
@endpoint POST /deleteNotificationConfigurations
@required {notificationIds: [int(int64)]}
@returns(200) {invalidFields: [map], pspReference: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@group getNotificationConfiguration
@endpoint POST /getNotificationConfiguration
@required {notificationId: int(int64)}
@returns(200) {configurationDetails: map{active: bool, apiVersion: int(int32), description: str, eventConfigs: [map], hmacSignatureKey: str, notificationId: int(int64), notifyPassword: str, notifyURL: str, notifyUsername: str, sslProtocol: str}, invalidFields: [map], pspReference: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@group getNotificationConfigurationList
@endpoint POST /getNotificationConfigurationList
@returns(200) {configurations: [map], invalidFields: [map], pspReference: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@group testNotificationConfiguration
@endpoint POST /testNotificationConfiguration
@required {notificationId: int(int64)}
@optional {eventTypes: [str]}
@returns(200) {errorMessages: [str], eventTypes: [str], exchangeMessages: [map], invalidFields: [map], notificationId: int(int64), okMessages: [str], pspReference: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@group updateNotificationConfiguration
@endpoint POST /updateNotificationConfiguration
@required {configurationDetails: map{active: bool, apiVersion: int(int32), description: str, eventConfigs: [map], hmacSignatureKey: str, notificationId: int(int64), notifyPassword: str, notifyURL: str, notifyUsername: str, sslProtocol: str}}
@returns(200) {configurationDetails: map{active: bool, apiVersion: int(int32), description: str, eventConfigs: [map], hmacSignatureKey: str, notificationId: int(int64), notifyPassword: str, notifyURL: str, notifyUsername: str, sslProtocol: str}, invalidFields: [map], pspReference: str, resultCode: str}
@errors {400, 401, 403, 422, 500}

@endgroup

@end