Refactor: Aktualisierung von APIs und Anwendungsschichten zur Umsetzung von Änderungen im Bereich

EnvelopeGenerator.Application/Configurations/AuthenticatorParams.cs

@@ -1,19 +1,33 @@
-namespace EnvelopeGenerator.Application.Configurations
+namespace EnvelopeGenerator.Application.Configurations;
+
+/// <summary>
+/// 
+/// </summary>
+public class AuthenticatorParams
 {
-    public class AuthenticatorParams
-    {
-        public string CharPool { get; init; } = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz01234567890123456789012345678901234567890123456789";
+    /// <summary>
+    /// Default value is 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz01234567890123456789012345678901234567890123456789'
+    /// </summary>
+    public string CharPool { get; init; } = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz01234567890123456789012345678901234567890123456789";
 
-        //TODO: Increase the DefaultTotpSecretKeyLength (e.g. to 32) but make sure that the QR code is generated correctly and can be scanned by the authenticator.
-        public int DefaultTotpSecretKeyLength { get; init; } = 20;
+    //TODO: Increase the DefaultTotpSecretKeyLength (e.g. to 32) but make sure that the QR code is generated correctly and can be scanned by the authenticator.
+    /// <summary>
+    /// Default value is 20
+    /// </summary>
+    public int DefaultTotpSecretKeyLength { get; init; } = 20;
 
-        public string TotpIssuer { get; init; } = "signFlow";
+    /// <summary>
+    /// Default value is 
+    /// </summary>
+    public string TotpIssuer { get; init; } = "signFlow";
 
-        /// <summary>
-        /// 0 is user email, 1 is secret key and 2 is issuer.
-        /// </summary>
-        public string TotpUrlFormat { get; init; } = "otpauth://totp/{0}?secret={1}&issuer={2}";
+    /// <summary>
+    /// 0 is user email, 1 is secret key and 2 is issuer.
+    /// </summary>
+    public string TotpUrlFormat { get; init; } = "otpauth://totp/{0}?secret={1}&issuer={2}";
 
-        public int TotpQRPixelsPerModule { get; init; } = 20;
-    }
+    /// <summary>
+    /// Default value is 20.
+    /// </summary>
+    public int TotpQRPixelsPerModule { get; init; } = 20;
 }

EnvelopeGenerator.Application/Configurations/DbTriggerParams.cs

@@ -1,5 +1,8 @@
 namespace EnvelopeGenerator.Application.Configurations;
 
+/// <summary>
+/// 
+/// </summary>
 public class DbTriggerParams : Dictionary<string, IEnumerable<string>>
 {
-}
+}

EnvelopeGenerator.Application/Configurations/DispatcherParams.cs

@@ -1,12 +1,27 @@
 namespace EnvelopeGenerator.Application.Configurations;
 
+/// <summary>
+/// 
+/// </summary>
 public class DispatcherParams
 {
+    /// <summary>
+    /// Default value is 1
+    /// </summary>
     public int SendingProfile { get; init; } = 1;
 
+    /// <summary>
+    /// Defalt value is 'DDEnvelopGenerator'
+    /// </summary>
     public string AddedWho { get; init; } = "DDEnvelopGenerator";
 
+    /// <summary>
+    /// Default value is 202377
+    /// </summary>
     public int ReminderTypeId { get; init; } = 202377;
 
+    /// <summary>
+    /// Default value is string.Empty
+    /// </summary>
     public string EmailAttmt1 { get; init; } = string.Empty;
 }

EnvelopeGenerator.Application/Configurations/GtxMessagingParams.cs

@@ -6,15 +6,32 @@ namespace EnvelopeGenerator.Application.Configurations;
 /// </summary>
 public class GtxMessagingParams : IHttpClientOptions
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public required string Uri { get; init; }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public string? Path { get; init; }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public Dictionary<string, object>? Headers { get; init; }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public Dictionary<string, object?>? QueryParams { get; init; }
-
+    /// <summary>
+    /// Default value is 'to'
+    /// </summary>
     public string RecipientQueryParamName { get; init; } = "to";
 
+    /// <summary>
+    /// Default value is 'text'
+    /// </summary>
     public string MessageQueryParamName { get; init; } = "text";
 }

EnvelopeGenerator.Application/Configurations/MailParams.cs

@@ -1,6 +1,12 @@
 namespace EnvelopeGenerator.Application.Configurations;
 
+/// <summary>
+/// 
+/// </summary>
 public class MailParams
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public required Dictionary<string, string> Placeholders { get; init; }
 }

EnvelopeGenerator.Application/Configurations/TotpSmsParams.cs

@@ -1,49 +1,81 @@
 using OtpNet;
 using System.Globalization;
 
-namespace EnvelopeGenerator.Application.Configurations
+namespace EnvelopeGenerator.Application.Configurations;
+
+/// <summary>
+/// 
+/// </summary>
+public class TotpSmsParams
 {
-    public class TotpSmsParams
+    /// <summary>
+    /// The unit is second.
+    /// </summary>
+    public int TotpStep { get; init; } = 90;
+
+    /// <summary>
+    /// Default value is 'Ihr 2FA-Passwort lautet {0}. Gültig bis {1}'
+    /// </summary>
+    public string Format { get; init; } = "Ihr 2FA-Passwort lautet {0}. Gültig bis {1}";
+    
+    /// <summary>
+    /// 
+    /// </summary>
+    public ExpirationHandler Expiration { get; init; } = new();
+
+    /// <summary>
+    /// Default value is VerificationWindow.RfcSpecifiedNetworkDelay
+    /// </summary>
+    public VerificationWindow? TotpVerificationWindow { get; private init; } = VerificationWindow.RfcSpecifiedNetworkDelay;
+
+    private IEnumerable<int>? _tvwParams;
+
+    /// <summary>
+    /// 
+    /// </summary>
+    public IEnumerable<int>? TotpVerificationWindowParams
     {
-        /// <summary>
-        /// The unit is second.
-        /// </summary>
-        public int TotpStep { get; init; } = 90;
-
-        public string Format { get; init; } = "Ihr 2FA-Passwort lautet {0}. Gültig bis {1}";
-        
-        public ExpirationHandler Expiration { get; init; } = new();
-
-        public VerificationWindow? TotpVerificationWindow { get; private init; } = VerificationWindow.RfcSpecifiedNetworkDelay;
-
-        private IEnumerable<int>? _tvwParams;
-
-        public IEnumerable<int>? TotpVerificationWindowParams
+        get => _tvwParams;
+        init
         {
-            get => _tvwParams;
-            init
-            {
-                _tvwParams = value;
-                if(_tvwParams is not null)
-                    TotpVerificationWindow = new(previous: _tvwParams.ElementAtOrDefault(0), future: _tvwParams.ElementAtOrDefault(0));
-            }
-        }
-
-        public class ExpirationHandler
-        {
-            public string CacheKeyFormat { get; init; } = "e{0}_r{1}_sms_code_expiration";
-
-            public string Format { get; init; } = "HH:mm:ss";
-
-            public string CultureName
-            {
-                get => _cultureInfo.Name;
-                init => _cultureInfo = new(value);
-            }
-
-            private CultureInfo _cultureInfo = new("de-DE");
-
-            public CultureInfo CultureInfo => _cultureInfo;
+            _tvwParams = value;
+            if(_tvwParams is not null)
+                TotpVerificationWindow = new(previous: _tvwParams.ElementAtOrDefault(0), future: _tvwParams.ElementAtOrDefault(0));
         }
     }
+
+    /// <summary>
+    /// 
+    /// </summary>
+    public class ExpirationHandler
+    {
+        /// <summary>
+        /// Default value is 'e{0}_r{1}_sms_code_expiration'
+        /// </summary>
+        public string CacheKeyFormat { get; init; } = "e{0}_r{1}_sms_code_expiration";
+
+        /// <summary>
+        /// Default value is HH:mm:ss
+        /// </summary>
+        public string Format { get; init; } = "HH:mm:ss";
+
+        /// <summary>
+        /// Default value is 'de-DE'
+        /// </summary>
+        public string CultureName
+        {
+            get => _cultureInfo.Name;
+            init => _cultureInfo = new(value);
+        }
+
+        /// <summary>
+        /// Default value is 'de-DE'
+        /// </summary>
+        private CultureInfo _cultureInfo = new("de-DE");
+
+        /// <summary>
+        /// Default value is 'de-DE'
+        /// </summary>
+        public CultureInfo CultureInfo => _cultureInfo;
+    }
 }