Merge pull request #611 from nofrixion/feature/MOOV-1918-merchant-notifications

Feature/moov 1918 merchant notifications

Author: arifmatin

src/NoFrixion.MoneyMoov/Enums/NotificationMethodTypesEnum.cs

@@ -0,0 +1,32 @@
+// -----------------------------------------------------------------------------
+//  Filename: NotificationMethodTypesEnum.cs
+// 
+//  Description: Types of notification methods that can be used for merchant notifications.
+// 
+//  Author(s):
+//  Arif Matin ([email protected])
+// 
+//  History:
+//  11 Jul 2025  Arif Matin     Created, Carrick on Shannon, Lietrim, Ireland.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+namespace NoFrixion.MoneyMoov.Enums
+{
+    public enum NotificationMethodTypesEnum
+    {
+        None = 0,
+
+        /// <summary>
+        /// The notification will be sent via webhook.
+        /// </summary>
+        Webhook = 1,
+
+        /// <summary>
+        /// The notification will be sent via email.
+        /// </summary>
+        Email = 2,
+    }
+}

src/NoFrixion.MoneyMoov/Models/WebHook/Webhook.cs

@@ -12,6 +12,7 @@
 //  MIT.
 // -----------------------------------------------------------------------------
 
+using NoFrixion.MoneyMoov.Enums;
 using System.Security.Cryptography;
 using System.Text;
 
@@ -61,6 +62,11 @@ public WebhookResourceTypesEnum Type
     /// </summary>
     public Guid MerchantID { get; set; }
 
+    /// <summary>
+    /// The type of notification that will be sent.
+    /// </summary>
+    public NotificationMethodTypesEnum NotificationMethod { get; set; }
+
     public static string GetSignature(string secret, byte[] payloadBytes)
     {
         byte[] keyByte = Encoding.UTF8.GetBytes(secret);

src/NoFrixion.MoneyMoov/Models/WebHook/WebhookCreate.cs

@@ -14,6 +14,7 @@
 //-----------------------------------------------------------------------------
 
 using NoFrixion.MoneyMoov.Attributes;
+using NoFrixion.MoneyMoov.Enums;
 using System.ComponentModel.DataAnnotations;
 
 namespace NoFrixion.MoneyMoov.Models;
@@ -51,16 +52,26 @@ public WebhookResourceTypesEnum Type
     /// </summary>
     public List<WebhookResourceTypesEnum> ResourceTypes { get; set; } = new List<WebhookResourceTypesEnum>();
 
-    [Required]
+    /// <summary>
+    /// The destination URL for the webhook.
+    /// Required for webhook notifications.
+    /// </summary>
     public string? DestinationUrl { get; set; }
 
     public bool Retry { get; set; } = true;
 
-    [Required]
+    /// <summary>
+    /// The secret key required to authenticate webhook notifications.
+    /// Required for webhook notifications.
+    /// </summary>
     public string? Secret { get; set; }
 
     public bool IsActive { get; set; } = true;
 
+    /// <summary>
+    /// The recipient email address(es) for notifications. Multiple addresses can be separated by a comma, semicolon, or space.
+    /// Reruired for email notifications.
+    /// </summary>
     [EmailAddressMultiple(ErrorMessage = "One or more of the email addresses are invalid. Addresses can be separated by a comma, semi-colon or space.")]
     public string? EmailAddress { get; set; }
 
@@ -70,6 +81,12 @@ public WebhookResourceTypesEnum Type
     [EmailAddressMultiple(ErrorMessage = "One or more of the email addresses are invalid. Addresses can be separated by a comma, semi-colon or space.")]
     public string? FailedNotificationEmailAddress { get; set; }
 
+    /// <summary>
+    /// The type of notification that will be sent.
+    /// </summary>
+    [Required]
+    public NotificationMethodTypesEnum NotificationMethod { get; set; }
+
     public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
     {
         if (Secret?.Length > SECRET_MAX_LENGTH)
@@ -86,6 +103,23 @@ public IEnumerable<ValidationResult> Validate(ValidationContext validationContex
         {
             yield return new ValidationResult("Cannot create a webhook with a resource type of none.");
         }
+
+        if (NotificationMethod is NotificationMethodTypesEnum.None)
+        {
+            yield return new ValidationResult("Cannot create a webhook with a notification method type of none.");
+        }
+
+        if (NotificationMethod is NotificationMethodTypesEnum.Email
+            && string.IsNullOrWhiteSpace(EmailAddress))
+        {
+            yield return new ValidationResult("Email address is required for email notification method.");
+        }
+
+        if (NotificationMethod is NotificationMethodTypesEnum.Webhook
+            && (string.IsNullOrWhiteSpace(DestinationUrl) || string.IsNullOrWhiteSpace(Secret)))
+        {
+            yield return new ValidationResult("Destination URL and Secret are required for webhook notification method.");
+        }
     }
 
     public Dictionary<string, string> ToDictionary()
@@ -99,7 +133,8 @@ public Dictionary<string, string> ToDictionary()
             { nameof(Secret), Secret ?? string.Empty },
             { nameof(IsActive), IsActive.ToString() },
             { nameof(EmailAddress), EmailAddress ?? string.Empty },
-            { nameof(FailedNotificationEmailAddress), FailedNotificationEmailAddress ?? string.Empty }
+            { nameof(FailedNotificationEmailAddress), FailedNotificationEmailAddress ?? string.Empty },
+            { nameof(NotificationMethod), NotificationMethod.ToString() }
         };
 
         if (ResourceTypes?.Count() > 0)