Merge pull request #327 from nofrixion/feature/MOOV-3134-statement-re…

…factor

MOOV-3134: Added transaction statement models

src/NoFrixion.MoneyMoov/Enums/StatementGenerationStatusEnum.cs

@@ -0,0 +1,23 @@
+// -----------------------------------------------------------------------------
+//  Filename: StatementGenerationStatusEnum.cs
+// 
+//  Description: Enum for the status of a transaction statement generation.
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  09 05 2024  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  Proprietary NoFrixion.
+// -----------------------------------------------------------------------------
+
+namespace NoFrixion.MoneyMoov.Enums;
+
+public enum StatementGenerationStatusEnum
+{
+    Unknown,
+    Generating,
+    Ready
+}

src/NoFrixion.MoneyMoov/Enums/TransactionStatementFormat.cs

@@ -0,0 +1,22 @@
+// -----------------------------------------------------------------------------
+//  Filename: TransactionStatementFormat.cs
+// 
+//  Description: Enum for the format of a transaction statement.
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  03 05 2024  Axel Granillo   Created, Mexico City, Mexico.
+// 
+//  License:
+//  Proprietary NoFrixion.
+// -----------------------------------------------------------------------------
+
+namespace NoFrixion.MoneyMoov.Enums;
+
+public enum TransactionStatementFormat
+{
+    Pdf,
+    Csv
+}

src/NoFrixion.MoneyMoov/Models/Statement/GenerateStatementRequest.cs

@@ -0,0 +1,44 @@
+// -----------------------------------------------------------------------------
+//  Filename: GenerateStatementRequest.cs
+// 
+//  Description: Model for generating a transaction statement.
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  03 05 2024  Axel Granillo   Created, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+using NoFrixion.MoneyMoov.Enums;
+
+namespace NoFrixion.MoneyMoov.Models;
+
+/// <summary>
+/// Model for generating a transaction statement.
+/// </summary>
+public class GenerateStatementRequest
+{
+    /// <summary>
+    /// ID of the account.
+    /// </summary>
+    public Guid AccountID { get; set; }
+
+    /// <summary>
+    /// Minimum transaction date for the statement.
+    /// </summary>
+    public DateTimeOffset FromDate { get; set; }
+
+    /// <summary>
+    /// Maximum transaction date for the statement.
+    /// </summary>
+    public DateTimeOffset ToDate { get; set; }
+
+    /// <summary>
+    /// File format to save the statement as. Defaults to PDF.
+    /// </summary>
+    public TransactionStatementFormat Format { get; set; } = TransactionStatementFormat.Pdf;
+}

src/NoFrixion.MoneyMoov/Models/Statement/GenerateStatementResponse.cs

@@ -0,0 +1,25 @@
+// -----------------------------------------------------------------------------
+//  Filename: GenerateStatementResponse.cs
+// 
+//  Description: Response model when generating a transaction statement.
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  03 05 2024  Axel Granillo   Created, Mexico City, Mexico.
+// 
+//  License:
+//  Proprietary NoFrixion.
+// -----------------------------------------------------------------------------
+
+using NoFrixion.MoneyMoov.Enums;
+
+namespace NoFrixion.MoneyMoov.Models;
+
+public class GenerateStatementResponse
+{
+    public Guid ID { get; set; }
+    public StatementGenerationStatusEnum Status { get; set; } = StatementGenerationStatusEnum.Unknown;
+    public string StatementUrl { get; set; } = "";
+}

src/NoFrixion.MoneyMoov/MoneyMoovUrlBuilder.cs

@@ -362,4 +362,14 @@ public static string BeneficiaryGroupsGetAllApiUrl(string moneyMoovBaseUrl, Guid
 
         return url;
     }
+
+    public static string StatementsApiUrl(string moneyMoovBaseUrl)
+    {
+        return $"{moneyMoovBaseUrl}/statements";
+    }
+
+    public static string BusinessHubUrl(string moneyMoovBaseUrl)
+    {
+        return $"{moneyMoovBaseUrl}/signalr/business";
+    } 
 }