Merge branch 'release/txm-1.8.20'

Author: sipsorcery

src/NoFrixion.MoneyMoov/ApiClients/AccountClient.cs

@@ -17,6 +17,7 @@
 using Microsoft.Extensions.Logging.Abstractions;
 using NoFrixion.MoneyMoov.Models;
 using System.Net;
+using System.Net.Http.Headers;
 
 namespace NoFrixion.MoneyMoov;
 
@@ -25,6 +26,10 @@ public interface IAccountClient
     Task<RestApiResponse<PaymentAccount>> GetAccountAsync(string userAccessToken, Guid accountID);
 
     Task<RestApiResponse<PaymentAccount>> CreateAccountAsync(string userAccessToken, PaymentAccountCreate accountCreate);
+    
+    Task<RestApiFileResponse> GetStatementAsync(string accessToken, Guid accountID, Guid statementID);
+    
+    Task<RestApiResponse> ClearStatementsAsync(string accessToken);
 }
 
 public class AccountClient : IAccountClient
@@ -81,4 +86,62 @@ public Task<RestApiResponse<PaymentAccount>> CreateAccountAsync(string userAcces
             _ => Task.FromResult(new RestApiResponse<PaymentAccount>(HttpStatusCode.PreconditionFailed, new Uri(url), prob))
         };
     }
+
+    /// <summary>
+    /// Calls the MoneyMoov statements endpoint to get a statement file.
+    /// </summary>
+    /// <param name="accessToken">A User or Merchant scoped JWT access token.</param>
+    /// <param name="accountID">The account ID</param>
+    /// <param name="statementID">The ID of the report to retrieve the result for.</param>
+    /// <returns>If successful, the statement result.</returns>
+    public async Task<RestApiFileResponse> GetStatementAsync(string accessToken, Guid accountID, Guid statementID)
+    {
+        var url = MoneyMoovUrlBuilder.AccountsApi.StatementsUrl(_apiClient.GetBaseUri().ToString(), accountID, statementID);
+        var prob = _apiClient.CheckAccessToken(accessToken, nameof(GetStatementAsync));
+
+        if (!prob.IsEmpty)
+        {
+            return new RestApiFileResponse(HttpStatusCode.PreconditionFailed, new Uri(url), prob);
+        }
+
+        using (var httpClient = new HttpClient())
+        {
+            httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
+            var response = await httpClient.GetAsync(url);
+
+            if (response.IsSuccessStatusCode)
+            {
+                var content = await response.Content.ReadAsByteArrayAsync();
+                var contentType = response.Content.Headers.ContentType?.ToString() ?? "application/pdf";
+                var fileName = response.Content.Headers.ContentDisposition?.FileName?.Trim('\"') ?? "downloaded_file";
+
+                return new RestApiFileResponse(HttpStatusCode.OK, new Uri(url), response.Headers, content, contentType, fileName);
+            }
+            else
+            {
+                return new RestApiFileResponse(
+                    response.StatusCode, 
+                    new Uri(url), 
+                    new NoFrixionProblem(response.ReasonPhrase ?? "File download failed.", (int)response.StatusCode));
+            }
+        }
+    }
+
+    /// <summary>
+    /// Calls the MoneyMoov Statements endpoint to clear the user's cached statements. This allows them to be re-generated, for example
+    /// if the statement was for the current month and the month has not yet completed.
+    /// </summary>
+    /// <param name="accessToken">The user token deleting the payout.</param>
+    public Task<RestApiResponse> ClearStatementsAsync(string accessToken)
+    {
+        var url = MoneyMoovUrlBuilder.AccountsApi.StatementsUrl(_apiClient.GetBaseUri().ToString());
+
+        var prob = _apiClient.CheckAccessToken(accessToken, nameof(ClearStatementsAsync));
+
+        return prob switch
+        {
+            var p when p.IsEmpty => _apiClient.DeleteAsync(url, accessToken),
+            _ => Task.FromResult(new RestApiResponse(HttpStatusCode.PreconditionFailed, new Uri(url), prob))
+        };
+    }
 }

src/NoFrixion.MoneyMoov/ApiClients/StatementClient.cs

@@ -50,6 +50,7 @@ public StatementClient(IRestApiClient apiClient, ILogger<StatementClient> logger
     /// <param name="accessToken">A User or Merchant scoped JWT access token.</param>
     /// <param name="statementID">The ID of the report to retrieve the result for.</param>
     /// <returns>If successful, the statement result.</returns>
+    [Obsolete("Use AccountClient.GetStatementAsync instead.")]
     public async Task<RestApiFileResponse> GetStatementAsync(string accessToken, Guid statementID)
     {
         var url = MoneyMoovUrlBuilder.StatementsApi.StatementsUrl(_apiClient.GetBaseUri().ToString(), statementID);
@@ -88,6 +89,7 @@ public async Task<RestApiFileResponse> GetStatementAsync(string accessToken, Gui
     /// if the statement was for the current month and the month has not yet completed.
     /// </summary>
     /// <param name="accessToken">The user token deleting the payout.</param>
+    [Obsolete("Use AccountClient.ClearStatementsAsync instead.")]
     public Task<RestApiResponse> ClearStatementsAsync(string accessToken)
     {
         var url = MoneyMoovUrlBuilder.StatementsApi.StatementsUrl(_apiClient.GetBaseUri().ToString());

src/NoFrixion.MoneyMoov/Enums/XeroBankFeedConnectionStatusEnum.cs

@@ -0,0 +1,48 @@
+// -----------------------------------------------------------------------------
+//  Filename: XeroBankFeedConnectionStatusEnum.cs
+// 
+//  Description: Defines all the possible statuses for a Xero bank feed connection.
+// 
+//  Author(s):
+//  Axel Granillo ([email protected])
+// 
+//  History:
+//  09 09 2024  Axel Granillo   Created, Remote, Mexico City, Mexico.
+// 
+//  License:
+//  MIT.
+// -----------------------------------------------------------------------------
+
+namespace NoFrixion.MoneyMoov.Enums;
+
+/// <summary>
+/// Defines all the possible statuses for a Xero bank feed connection.
+/// </summary>
+public enum XeroBankFeedConnectionStatusEnum
+{
+    /// <summary>
+    /// Default status. No status has been set.
+    /// </summary>
+    None,
+    
+    /// <summary>
+    /// The bank feed connection has been queued for processing.
+    /// </summary>
+    Pending,
+    
+    /// <summary>
+    /// The bank feed connection is fully operational.
+    /// </summary>
+    Active,
+    
+    /// <summary>
+    /// This means that the respective account on Xero has been Archived/Deleted.
+    /// This status will be used when the Xero bank feed connection ID can no longer be found on Xero.
+    /// </summary>
+    Inactive,
+    
+    /// <summary>
+    /// The bank feed had a failure during the connection process.
+    /// </summary>
+    Failed
+}

src/NoFrixion.MoneyMoov/Models/Account/PaymentAccount.cs

@@ -165,8 +165,14 @@ public string Summary
     /// <summary>
     /// Indicates if the payment account is connected to a Xero bank feed.
     /// </summary>
+    [Obsolete("Please use the XeroBankFeedConnectionStatus property.")]
     public bool IsXeroBankFeed { get; set; }
 
+    /// <summary>
+    /// States the status of the Xero bank feed connection, if applicable.
+    /// </summary>
+    public XeroBankFeedConnectionStatusEnum? XeroBankFeedConnectionStatus { get; set; }
+    
     public XeroBankFeedSyncStatusEnum XeroBankFeedSyncStatus { get; set; }
 
     public DateTimeOffset? XeroBankFeedLastSyncedAt { get; set; }
@@ -184,6 +190,7 @@ public string Summary
     /// Indicates that the bank feed connection can no longer be found in Xero.
     /// This can mean that the respective account was archived/deleted in Xero.
     /// </summary>
+    [Obsolete("Please use the XeroBankFeedConnectionStatus property.")]
     public bool XeroBankFeedConnectionInactive { get; set; }
 
     /// <summary>

src/NoFrixion.MoneyMoov/MoneyMoovUrlBuilder.cs

@@ -76,6 +76,15 @@ public static string AccountsUrl(string moneyMoovBaseUrl)
 
         public static string AccountPayoutsUrl(string moneyMoovBaseUrl, Guid accountID)
             => $"{moneyMoovBaseUrl}/{MoneyMoovResources.accounts}/{accountID}/{MoneyMoovResources.payouts}";
+        
+        public static string StatementsUrl(string moneyMoovBaseUrl)
+            => $"{moneyMoovBaseUrl}/{MoneyMoovResources.accounts}/{MoneyMoovResources.statements}";
+
+        public static string StatementsUrlWithAccountPlaceholder(string moneyMoovBaseUrl)
+            => $"{moneyMoovBaseUrl}/{MoneyMoovResources.accounts}/##account##/{MoneyMoovResources.statements}";
+        
+        public static string StatementsUrl(string moneyMoovBaseUrl, Guid accountID, Guid statementID)
+            => $"{moneyMoovBaseUrl}/{MoneyMoovResources.accounts}/{accountID}/{MoneyMoovResources.statements}/{statementID}";
     }
 
     /// <summary>

src/NoFrixion.MoneyMoov/Permissions/Permissions.cs

@@ -83,35 +83,33 @@ public enum MerchantPermissions : ulong
 
     // Users
     CanViewUsers = 1L << 18,
-    CanViewUserInvites = 1L << 19,
-    CanEditUsers = 1L << 20,
 
     // Webhooks
-    CanViewWebhooks = 1L << 21,
-    CanCreateWebhooks = 1L << 22,
-    CanDeleteWebhooks = 1L << 23,
+    CanViewWebhooks = 1L << 19,
+    CanCreateWebhooks = 1L << 20,
+    CanDeleteWebhooks = 1L << 21,
 
     // Merchants
-    CanViewMerchant = 1L << 24,
-    CanUpdateMerchant = 1L << 25,
+    CanViewMerchant = 1L << 22,
+    CanUpdateMerchant = 1L << 23,
 
     // Payment requests
-    CanCreatePaymentRequests = 1L << 26,
-    CanViewPaymentRequests = 1L << 27,
-    CanUpdatePaymentRequests = 1L << 28,
+    CanCreatePaymentRequests = 1L << 24,
+    CanViewPaymentRequests = 1L << 25,
+    CanUpdatePaymentRequests = 1L << 26,
 
     // Mandates
-    CanViewMandates = 1L << 29,
-    CanCreateMandates = 1L << 30,
+    CanViewMandates = 1L << 27,
+    CanCreateMandates = 1L << 28,
 
     // Permissions
-    CanViewRoles = 1L << 31,
-    CanCreateRoles = 1L << 32, 
-    CanEditRoles = 1L << 33,  
+    CanViewRoles = 1L << 29,
+    CanCreateRoles = 1L << 30, 
+    CanEditRoles = 1L << 31,  
 
     // Reports
-    CanCreateReports = 1L << 34,
-    CanViewReports = 1L << 35,
+    CanCreateReports = 1L << 32,
+    CanViewReports = 1L << 33,
 }
 
 public static class ClaimTypePrefixes