Refactor documentation comments and add device and network classes for enhanced risk assessment (#478)

Author: armando-rodriguez-cko

src/CheckoutSdk/Forward/Requests/DestinationRequest.cs

@@ -2,8 +2,7 @@ namespace Checkout.Forward.Requests
 {
     public class DestinationRequest
     {
-        /// <summary>
-        ///     The URL to forward the request to (Required, max 1024 characters) </summary>
+        /// <summary> The URL to forward the request to (Required, max 1024 characters) </summary>
         public string Url { get; set; }
 
         /// <summary> The HTTP method to use for the forward request (Required) </summary>
@@ -15,7 +14,8 @@ public class DestinationRequest
         /// <summary>
         ///     The HTTP message body to include in the forward request. If you provide source.id or source.token, you can specify
         ///     placeholder values in the body. The request will be enriched with the respective payment details from the token or
-        ///     payment instrument you specified. For example, {{card_number}} (Required, max 16384 characters) </summary>
+        ///     payment instrument you specified. For example, {{card_number}} (Required, max 16384 characters)
+        /// </summary>
         public string Body { get; set; }
     }
 }

src/CheckoutSdk/Forward/Requests/ForwardRequest.cs

@@ -14,8 +14,7 @@ public class ForwardRequest
         /// <summary> The parameters of the forward request (Required) </summary>
         public DestinationRequest DestinationRequest { get; set; }
 
-        /// <summary>
-        ///     The unique reference for the forward request (Optional, max 80 characters) </summary>
+        /// <summary> The unique reference for the forward request (Optional, max 80 characters) </summary>
         public string Reference { get; set; }
 
         /// <summary>

src/CheckoutSdk/Forward/Requests/Headers.cs

@@ -4,13 +4,13 @@ namespace Checkout.Forward.Requests
 {
     public class Headers
     {
-        /// <summary>
-        ///     The raw headers to include in the forward request (Required, max 16 characters) </summary>
+        /// <summary> The raw headers to include in the forward request (Required, max 16 characters) </summary>
         public IDictionary<string, string> Raw { get; set; } = new Dictionary<string, string>();
 
         /// <summary>
-        ///     The encrypted headers to include in the forward request, as a JSON object with string values encrypted with JSON
-        ///     Web Encryption (JWE) (Optional, max 8192 characters) </summary>
+        ///     The encrypted headers to include in the forward request, as a JSON object with string values encrypted
+        ///     with JSON Web Encryption (JWE) (Optional, max 8192 characters)
+        /// </summary>
         public string Encrypted { get; set; }
     }
 }

src/CheckoutSdk/Forward/Requests/Sources/IdSource.cs

@@ -2,7 +2,7 @@ namespace Checkout.Forward.Requests.Sources
 {
     public class IdSource : AbstractSource
     {
-        /// <summary>Initializes a new instance of the IdSource class.</summary>
+        /// <summary> Initializes a new instance of the IdSource class. </summary>
         public IdSource() : base(SourceType.Id) { }
 
         /// <summary> The unique identifier of the payment instrument (Required, pattern ^(src)_(\w{26})$) </summary>

src/CheckoutSdk/Forward/Requests/Sources/TokenSource.cs

@@ -2,7 +2,7 @@ namespace Checkout.Forward.Requests.Sources
 {
     public class TokenSource : AbstractSource
     {
-        /// <summary>Initializes a new instance of the TokenSource class.</summary>
+        /// <summary> Initializes a new instance of the TokenSource class. </summary>
         public TokenSource() : base(SourceType.Token) { }
 
         /// <summary> The unique Checkout.com token (Required, pattern ^(tok)_(\w{26})$) </summary>

src/CheckoutSdk/Forward/Responses/GetForwardResponse.cs

@@ -13,9 +13,7 @@ public class GetForwardResponse : HttpMetadata
         /// <summary> The parameters of the HTTP request forwarded to the destination (Required) </summary>
         public DestinationRequest DestinationRequest { get; set; }
 
-        /// <summary>
-        ///     The date and time the forward request was created, in UTC (Required)
-        /// </summary>
+        /// <summary> The date and time the forward request was created, in UTC (Required) </summary>
         public DateTime? CreatedOn { get; set; }
 
         /// <summary> The unique reference for the forward request (Optional) </summary>

src/CheckoutSdk/Payments/Contexts/PaymentContextsProcessing.cs

@@ -22,7 +22,7 @@ public class PaymentContextsProcessing
 
         public UserAction? UserAction { get; set; }
 
-        public PartnerCustomerRiskData PartnerCustomerRiskData { get; set; }
+        public IList<PartnerCustomerRiskData> PartnerCustomerRiskData { get; set; }
 
         public IList<string> CustomPaymentMethodIds { get; set; }
 

src/CheckoutSdk/Payments/Request/Device.cs

@@ -0,0 +1,60 @@
+namespace Checkout.Payments.Request
+{
+    public class Device
+    {
+        /// <summary> The contents of the HTTP User-Agent request header. This field is required to process the device
+        /// with the risk engine (Optional, max 2048 characters) </summary>
+        public string UserAgent { get; set; }
+
+        /// <summary> Details of the device network. Either ipv4 or ipv6 is required field (Optional) </summary>
+        public Network Network { get; set; }
+
+        /// <summary> Details of the device ID provider (Optional) </summary>
+        public Provider Provider { get; set; }
+
+        /// <summary> The UTC date and time the payment was performed as reported by the device. Format – ISO 8601 code
+        /// This field is required to process the device with the risk engine (Optional) </summary>
+        public string Timestamp { get; set; }
+
+        /// <summary> The time difference between UTC time and the local time reported by the browser, in minutes. This
+        /// field is required to process the device with the risk engine (Optional, [ 1 .. 5 ] characters </summary>
+        public string Timezone { get; set; }
+
+        /// <summary> Specifies if the device is running in a virtual machine (Optional) </summary>
+        public bool? VirtualMachine { get; set; }
+
+        /// <summary> Specifies if the browser is in incognito mode (Optional) </summary>
+        public bool? Incognito { get; set; }
+
+        /// <summary> Specifies if the device is jailbroken (Optional) </summary>
+        public bool? Jailbroken { get; set; }
+
+        /// <summary> Specifies if the device is rooted (Optional) </summary>
+        public bool? Rooted { get; set; }
+
+        /// <summary> Specifies if the browser has the ability to execute Java, as reported by the browser's
+        /// navigator.javaEnabled property (Optional) </summary>
+        public bool? JavaEnabled { get; set; }
+
+        /// <summary> Specifies if the browser has the ability to execute Javascript, as reported by the browser's
+        /// navigator.javascriptEnabled property. Only required for 3D Secure authentications processed with 3DS 2.2. If
+        /// the payment is processed with an older 3DS version, this field is ignored (Optional) </summary>
+        public bool? JavascriptEnabled { get; set; }
+
+        /// <summary> The browser language, as reported by the browser's navigator.language property. Format – IETF
+        /// BCP47 language tag (Optional, [ 1 .. 12 ] characters) </summary>
+        public string Language { get; set; }
+
+        /// <summary> The bit depth of the color palette for displaying images in bits per pixel, as reported by the
+        /// browser's screen.colorDepth property (Optional, [ 2 .. 1 ] characters) </summary>
+        public string ColorDepth { get; set; }
+
+        /// <summary> The total height of the device screen in pixels, as reported by the browser's screen.height
+        /// property (Optional, [ 1 .. 6 ] characters, [ 1 .. 6 ]) </summary>
+        public string ScreenHeight { get; set; }
+
+        /// <summary> The total width of the device screen in pixels, as reported by the browser's screen.width property
+        /// (Optional, [ 1 .. 6 ] characters) </summary>
+        public string ScreenWidth { get; set; }
+    }
+}

src/CheckoutSdk/Payments/Request/Network.cs

@@ -0,0 +1,21 @@
+namespace Checkout.Payments.Request
+{
+    public class Network
+    {
+        /// <summary> The device's IPV4 address. Not required if you provide the ipv6 field (Optional) </summary>
+        public string Ipv4 { get; set; }
+
+        /// <summary> The device's IPV6 address. Not required if you provide the ipv4 field (Optional) </summary>
+        public string Ipv6 { get; set; }
+
+        /// <summary> Specifies if the Tor network was used in the browser session (Optional) </summary>
+        public bool? Tor { get; set; }
+
+        /// <summary> Specifies if a virtual private network (VPN) was used in the browser session (Optional) </summary>
+        public bool? Vpn { get; set; }
+
+        /// <summary> Specifies if a proxy was used in the browser session (Optional) </summary>
+        public bool? Proxy { get; set; }
+
+    }
+}

src/CheckoutSdk/Payments/Request/Provider.cs

@@ -0,0 +1,12 @@
+namespace Checkout.Payments.Request
+{
+    public class Provider
+    {
+        /// <summary> The unique identifier for the device (Optional) </summary>
+        public string Id { get; set; }
+
+        /// <summary> The name of the provider that generated the device identifier (Optional) </summary>
+        public string Name { get; set; }
+
+    }
+}