Merge pull request #619 from nofrixion/feature/MOOV-4708-roleevents-2

MOOV-4708: Add Events to Roles

Author: agranillonf

src/NoFrixion.MoneyMoov/Enums/RoleEventTypeEnum.cs

@@ -0,0 +1,38 @@
+// -----------------------------------------------------------------------------
+//  Filename: RoleEventTypeEnum.cs
+// 
+//  Description: List of the types of events that can occur in a role:
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  17 07 2025  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+namespace NoFrixion.MoneyMoov.Enums;
+
+/// <summary>
+/// Events that can occur in a role.
+/// </summary>
+public enum RoleEventTypeEnum
+{
+    None = 0,
+
+    Created = 1,
+    
+    Edited = 2,
+    
+    Archived = 3,
+    
+    Unarchived = 4,
+    
+    AssignedToUser = 5,
+    
+    RemovedFromUser = 6,
+    
+    UpdatedUserAssignment = 7
+}

src/NoFrixion.MoneyMoov/Models/Roles/Role.cs

@@ -38,4 +38,6 @@ public class Role
     public List<RoleUser>? Users { get; set; }
 
     public bool IsSystemRole { get; set; }
+    
+    public List<RoleEvent> Events { get; set; } = null!;
 }

src/NoFrixion.MoneyMoov/Models/Roles/RoleEvent.cs

@@ -0,0 +1,84 @@
+// -----------------------------------------------------------------------------
+//  Filename: RoleEvent.cs
+// 
+//  Description: A model that represents an event produced by a MoneyMoov
+// Role execution.
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  18 07 2025  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+using NoFrixion.Common.Permissions;
+using NoFrixion.MoneyMoov.Enums;
+
+namespace NoFrixion.MoneyMoov.Models;
+
+/// <summary>
+/// A model that represents an event produced by a MoneyMoov Role execution.
+/// </summary>
+public class RoleEvent
+{
+    public Guid ID { get; set; }
+    
+    public Guid RoleID { get; set; }
+    
+    public string? Notes { get; set; }
+    
+    public RoleEventTypeEnum Type { get; set; }
+    
+    public DateTimeOffset Inserted { get; set; }
+    
+    public string? AuthoriserHash { get; set; }
+
+    /// <summary>
+    /// The name the role had at the time of the event.
+    /// </summary>
+    public string? Name { get; set; }
+
+    /// <summary>
+    /// The description the role had at the time of the event.
+    /// </summary>
+    public string? Description { get; set; }
+
+    /// <summary>
+    /// The merchant permissions the role had at the time of the event.
+    /// </summary>
+    public MerchantPermissions MerchantPermissions { get; set; }
+
+    /// <summary>
+    /// The account permissions the role had at the time of the event.
+    /// </summary>
+    public AccountPermissions AccountPermissions { get; set; }
+    
+    /// <summary>
+    /// The client session timeout seconds the role had at the time of the event.
+    /// </summary>
+    public int? ClientSessionTimeoutSeconds { get; set; }
+    
+    /// <summary>
+    /// For <see cref="RoleEventTypeEnum.AssignedToUser"/> and <see cref="RoleEventTypeEnum.RemovedFromUser"/> event types.
+    /// The user that was assigned to or removed from the role at the time of the event.
+    /// </summary>
+    public Guid? AssignationEventUserID { get; set; }
+
+    /// <summary>
+    /// The number of users assigned to the role at the time of the event.
+    /// </summary>
+    public int? AssignedUsers { get; set; }
+
+    /// <summary>
+    /// IDs of the accounts that were assigned to the role-user during the event.
+    /// </summary>
+    public Guid[]? AccountIDs { get; set; }
+    
+    /// <summary>
+    /// User that triggered the event.
+    /// </summary>
+    public User? User { get; set; }
+}