App Payment Setups Support

.github/workflows/codeql-analysis.yml

@@ -44,7 +44,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         queries: security-and-quality
@@ -56,7 +56,7 @@ jobs:
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

src/CheckoutSdk/CheckoutApi.cs

@@ -15,6 +15,7 @@
 using Checkout.Payments.Hosted;
 using Checkout.Payments.Links;
 using Checkout.Payments.Sessions;
+using Checkout.Payments.Setups;
 using Checkout.Reports;
 using Checkout.Risk;
 using Checkout.Tokens;
@@ -47,6 +48,7 @@ public class CheckoutApi : ICheckoutApi
         private readonly IPaymentSessionsClient _paymentSessionsClient;
         private readonly IForwardClient _forwardClient;
         private readonly INetworkTokensClient _networkTokensClient;
+        private readonly IPaymentSetupsClient _paymentSetupsClient;
 
         public CheckoutApi(CheckoutConfiguration configuration)
         {
@@ -78,6 +80,7 @@ public CheckoutApi(CheckoutConfiguration configuration)
             _paymentSessionsClient = new PaymentSessionsClient(baseApiClient, configuration);
             _forwardClient = new ForwardClient(baseApiClient, configuration);
             _networkTokensClient = new NetworkTokensClient(baseApiClient, configuration);
+            _paymentSetupsClient = new PaymentSetupsClient(baseApiClient, configuration);
         }
 
         private static ApiClient BaseApiClient(CheckoutConfiguration configuration)
@@ -220,6 +223,11 @@ public INetworkTokensClient NetworkTokensClient()
         {
             return _networkTokensClient;
         }
+
+        public IPaymentSetupsClient PaymentSetupsClient()
+        {
+            return _paymentSetupsClient;
+        }
 
     }
 }

src/CheckoutSdk/Common/Phone.cs

@@ -2,8 +2,16 @@ namespace Checkout.Common
 {
     public class Phone
     {
+        /// <summary>
+        /// The international country calling code: https://www.checkout.com/docs/resources/codes/country-codes
+        /// [ 1 .. 7 ] characters
+        /// </summary>
         public string CountryCode { get; set; }
 
+        /// <summary>
+        /// The phone number
+        /// [ 6 .. 25 ] characters
+        /// </summary>
         public string Number { get; set; }
     }
 }

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/Customer/Customer.cs

@@ -0,0 +1,54 @@
+using Checkout.Common;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class Customer
+    {
+        /// <summary>
+        /// Details of the customer's email
+        /// </summary>
+        public CustomerEmail Email { get; set; }
+
+        /// <summary>
+        /// The customer's full name
+        /// &lt;= 100 characters
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The customer's phone number
+        /// </summary>
+        public Phone Phone { get; set; }
+
+        /// <summary>
+        /// The customer's device details
+        /// </summary>
+        public CustomerDevice Device { get; set; }
+
+        /// <summary>
+        /// Details of the account the customer holds with the merchant
+        /// </summary>
+        public MerchantAccount MerchantAccount { get; set; }
+    }
+
+    public class CustomerEmail
+    {
+        /// <summary>
+        /// The customer's email address
+        /// </summary>
+        public string Address { get; set; }
+
+        /// <summary>
+        /// Specifies whether the customer's email address is verified
+        /// </summary>
+        public bool? Verified { get; set; }
+    }
+
+    public class CustomerDevice
+    {
+        /// <summary>
+        /// The device's locale, as an ISO 639-2 language code
+        /// </summary>
+        public string Locale { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/Customer/MerchantAccount.cs

@@ -0,0 +1,47 @@
+using System;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class MerchantAccount
+    {
+        /// <summary>
+        /// The merchant's unique identifier for the customer's account
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// The date the customer registered their account with the merchant
+        /// </summary>
+        public DateTime? RegistrationDate { get; set; }
+
+        /// <summary>
+        /// The date the customer's account with the merchant was last modified
+        /// </summary>
+        public DateTime? LastModified { get; set; }
+
+        /// <summary>
+        /// Specifies if the customer is a returning customer
+        /// </summary>
+        public bool? ReturningCustomer { get; set; }
+
+        /// <summary>
+        /// The date of the customer's first transaction
+        /// </summary>
+        public DateTime? FirstTransactionDate { get; set; }
+
+        /// <summary>
+        /// The date of the customer's most recent transaction
+        /// </summary>
+        public DateTime? LastTransactionDate { get; set; }
+
+        /// <summary>
+        /// The total number of orders made by the customer
+        /// </summary>
+        public int? TotalOrderCount { get; set; }
+
+        /// <summary>
+        /// The payment amount of the customer's most recent transaction
+        /// </summary>
+        public long? LastPaymentAmount { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/Industry/AirlineData.cs

@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+using Checkout.Payments.Contexts;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class AirlineData
+    {
+        /// <summary>
+        /// Details about the airline ticket
+        /// </summary>
+        public PaymentContextsTicket Ticket { get; set; }
+
+        /// <summary>
+        /// Details about the flight passenger(s)
+        /// </summary>
+        public IList<PaymentContextsPassenger> Passengers { get; set; }
+
+        /// <summary>
+        /// Details about the flight leg(s) booked by the customer
+        /// </summary>
+        public IList<PaymentContextsFlightLegDetails> FlightLegDetails { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/Industry/Industry.cs

@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class Industry
+    {
+        /// <summary>
+        /// Details about the airline ticket and flights the customer booked
+        /// </summary>
+        public AirlineData AirlineData { get; set; }
+
+        /// <summary>
+        /// Contains information about the accommodation booked by the customer
+        /// </summary>
+        public IList<AccommodationData> AccommodationData { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/Order/Order.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using Checkout.Common;
+using Checkout.Payments.Contexts;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class Order
+    {
+        /// <summary>
+        /// A list of items in the order
+        /// </summary>
+        public IList<PaymentContextsItems> Items { get; set; }
+
+        /// <summary>
+        /// The customer's shipping details
+        /// </summary>
+        public ShippingDetails Shipping { get; set; }
+
+        /// <summary>
+        /// The sub-merchants' details
+        /// </summary>
+        public IList<OrderSubMerchant> SubMerchants { get; set; }
+
+        /// <summary>
+        /// The discount amount the merchant applied to the transaction
+        /// &gt;= 0
+        /// </summary>
+        public long? DiscountAmount { get; set; }
+    }
+}
+
+
+

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/Order/OrderSubMerchant.cs

@@ -0,0 +1,27 @@
+using System;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class OrderSubMerchant
+    {
+        /// <summary>
+        /// The unique identifier of the sub-merchant
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// The sub-merchant's product category
+        /// </summary>
+        public string ProductCategory { get; set; }
+
+        /// <summary>
+        /// The number of orders the sub-merchant has processed
+        /// </summary>
+        public int? NumberOfTrades { get; set; }
+
+        /// <summary>
+        /// The sub-merchant's registration date
+        /// </summary>
+        public DateTime? RegistrationDate { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/PaymentMethods/Bizum/Bizum.cs

@@ -0,0 +1,10 @@
+namespace Checkout.Payments.Setups.Entities
+{
+    public class Bizum : PaymentMethodBase
+    {
+        /// <summary>
+        /// Payment method options specific to Bizum
+        /// </summary>
+        public PaymentMethodOptions PaymentMethodOptions { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/PaymentMethods/Common/PaymentMethodAction.cs

@@ -0,0 +1,20 @@
+namespace Checkout.Payments.Setups.Entities
+{
+    public class PaymentMethodAction
+    {
+        /// <summary>
+        /// The type of action to be performed with the payment method
+        /// </summary>
+        public string Type { get; set; }
+
+        /// <summary>
+        /// The client token for payment method authentication
+        /// </summary>
+        public string ClientToken { get; set; }
+
+        /// <summary>
+        /// The session identifier for the payment method session
+        /// </summary>
+        public string SessionId { get; set; }
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/PaymentMethods/Common/PaymentMethodBase.cs

@@ -0,0 +1,28 @@
+using System.Collections.Generic;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    /// <summary>
+    /// Base class for all payment methods with common properties
+    /// </summary>
+    public abstract class PaymentMethodBase
+    {
+        /// <summary>
+        /// The payment method's status
+        /// </summary>
+        public PaymentMethodStatus? Status { get; set; }
+
+        /// <summary>
+        /// Configuration flags for the payment method
+        /// </summary>
+        public IList<string> Flags { get; set; }
+
+        /// <summary>
+        /// Default: "disabled"
+        /// The initialization state of the payment method.
+        /// When you create a Payment Setup, this defaults to disabled.
+        /// Enum: "disabled" "enabled"
+        /// </summary>
+        public PaymentMethodInitialization Initialization { get; set; } = PaymentMethodInitialization.Disabled;
+    }
+}

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/PaymentMethods/Common/PaymentMethodInitialization.cs

@@ -0,0 +1,11 @@
+
+    using System.Runtime.Serialization;
+
+    public enum PaymentMethodInitialization
+    {
+        [EnumMember(Value = "disabled")]
+        Disabled,
+
+        [EnumMember(Value = "enabled")]
+        Enabled
+    }

src/CheckoutSdk/HandlePaymentsAndPayouts/PaymentSetups/Entities/PaymentMethods/Common/PaymentMethodOption.cs

@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+
+namespace Checkout.Payments.Setups.Entities
+{
+    public class PaymentMethodOption
+    {
+        /// <summary>
+        /// The unique identifier for the payment method option
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// The status of the payment method option
+        /// </summary>
+        public string Status { get; set; }
+
+        /// <summary>
+        /// Configuration flags for the payment method option
+        /// </summary>
+        public IList<string> Flags { get; set; }
+
+        /// <summary>
+        /// The action configuration for STC Pay full payment
+        /// </summary>
+        public PaymentMethodAction Action { get; set; }
+    }
+}