NotificationConfigurationDetails class abstract

NotificationConfigurationDetails

Properties:

  • active - Indicates whether the notification subscription is active.
  • apiVersion - The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.
  • description - A description of the notification subscription configuration.
  • eventConfigs - Contains objects that define event types and their subscription settings.
  • hmacSignatureKey - A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header HmacSignature and the hash protocol will be included under the notification header Protocol. A notification body along with its hmacSignatureKey and Protocol can be used to calculate a hash value; matching this hash value with the HmacSignature will ensure that the notification body has not been tampered with or corrupted. >Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. "b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27"). The omission of this field will preclude the provision of the HmacSignature and Protocol headers in notification(s).
  • notificationId - Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using /updateNotificationConfiguration.
  • notifyPassword - The password to use when accessing the notifyURL with the specified username.
  • notifyURL - The URL to which the notifications are to be sent.
  • notifyUsername - The username to use when accessing the notifyURL.
  • sslProtocol - The SSL protocol employed by the endpoint. >Permitted values: TLSv12, TLSv13.
Annotations
  • @BuiltValue.new()

Properties

active → bool?
Indicates whether the notification subscription is active.
no setter
apiVersion → int?
The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.
no setter
description → String?
A description of the notification subscription configuration.
no setter
eventConfigs → BuiltList<NotificationEventConfiguration>?
Contains objects that define event types and their subscription settings.
no setter
hashCode → int
The hash code for this object.
no setterinherited
hmacSignatureKey → String?
A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header HmacSignature and the hash protocol will be included under the notification header Protocol. A notification body along with its hmacSignatureKey and Protocol can be used to calculate a hash value; matching this hash value with the HmacSignature will ensure that the notification body has not been tampered with or corrupted. >Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. "b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27"). The omission of this field will preclude the provision of the HmacSignature and Protocol headers in notification(s).
no setter
notificationId → int?
Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using /updateNotificationConfiguration.
no setter
notifyPassword → String?
The password to use when accessing the notifyURL with the specified username.
no setter
notifyURL → String?
The URL to which the notifications are to be sent.
no setter
notifyUsername → String?
The username to use when accessing the notifyURL.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sslProtocol → NotificationConfigurationDetailsSslProtocolEnum?
The SSL protocol employed by the endpoint. >Permitted values: TLSv12, TLSv13.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(NotificationConfigurationDetailsBuilder)) → NotificationConfigurationDetails
Rebuilds the instance.
inherited
toBuilder() → NotificationConfigurationDetailsBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<NotificationConfigurationDetails>
no setter