checkout_sdk 1.2.2 → 1.3.0

data/lib/checkout_sdk/payments/payments.rb

@@ -17,6 +17,7 @@ require 'checkout_sdk/payments/payment_instruction'
 require 'checkout_sdk/payments/payment_method_details'
 require 'checkout_sdk/payments/refund_request'
 require 'checkout_sdk/payments/product'
+require 'checkout_sdk/payments/refund_order'
 require 'checkout_sdk/payments/capture_type'
 require 'checkout_sdk/payments/payment_type'
 require 'checkout_sdk/payments/merchant_initiated_reason'
@@ -42,6 +43,11 @@ require 'checkout_sdk/payments/billing_plan'
 require 'checkout_sdk/payments/billing_plan_type'
 require 'checkout_sdk/payments/billing_information'
 require 'checkout_sdk/payments/payments_query_filter'
+require 'checkout_sdk/payments/payment_method_configuration'
+require 'checkout_sdk/payments/card'
+require 'checkout_sdk/payments/applepay'
+require 'checkout_sdk/payments/googlepay'
+require 'checkout_sdk/payments/locale_type'
 
 # Source
 require 'checkout_sdk/payments/source/payment_source'
@@ -82,7 +88,11 @@ require 'checkout_sdk/payments/source/apm/cv_connect_source'
 require 'checkout_sdk/payments/source/apm/trustly_source'
 require 'checkout_sdk/payments/source/apm/illicado_source'
 require 'checkout_sdk/payments/source/apm/sepa_source'
-
+require 'checkout_sdk/payments/source/apm/ach_source'
+require 'checkout_sdk/payments/source/apm/bizum_source'
+require 'checkout_sdk/payments/source/apm/octopus_source'
+require 'checkout_sdk/payments/source/apm/plaid_source'
+require 'checkout_sdk/payments/source/apm/sequra_source'
 # Sender
 require 'checkout_sdk/payments/sender/sender'
 require 'checkout_sdk/payments/sender/sender_type'
@@ -152,6 +162,8 @@ require 'checkout_sdk/payments/previous/payments_client'
 # Hosted Payments
 require 'checkout_sdk/payments/hosted/hosted_payments_session'
 require 'checkout_sdk/payments/hosted/hosted_payments_client'
+require 'checkout_sdk/payments/hosted/hosted_payment_instruction'
+require 'checkout_sdk/payments/hosted/payment_purpose_type'
 
 # Payment Links
 require 'checkout_sdk/payments/links/payment_link'
@@ -164,6 +176,4 @@ require 'checkout_sdk/payments/contexts/payment_contexts_client'
 require 'checkout_sdk/payments/sessions/payment_sessions_client'
 require 'checkout_sdk/payments/sessions/payment_sessions_request'
 require 'checkout_sdk/payments/sessions/payment_methods_type'
-require 'checkout_sdk/payments/sessions/payment_method_configuration'
-require 'checkout_sdk/payments/sessions/card'
 require 'checkout_sdk/payments/sessions/store_payment_details_type'

data/lib/checkout_sdk/payments/product.rb

@@ -18,6 +18,8 @@ module CheckoutSdk
     #   @return [Integer]
     # @!attribute tax_amount
     #   @return [Integer]
+    # @!attribute tax_rate
+    #   @return [Integer]
     # @!attribute discount_amount
     #   @return [Integer]
     # @!attribute wxpay_goods_id
@@ -37,6 +39,7 @@ module CheckoutSdk
                     :unit_of_measure,
                     :total_amount,
                     :tax_amount,
+                    :tax_rate,
                     :discount_amount,
                     :wxpay_goods_id,
                     :image_url,

data/lib/checkout_sdk/payments/refund_order.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute name
+    #   @return [String]
+    # @!attribute quantity
+    #   @return [Integer]
+    # @!attribute unit_price
+    #   @return [Integer]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute commodity_code
+    #   @return [String]
+    # @!attribute unit_of_measure
+    #   @return [String]
+    # @!attribute total_amount
+    #   @return [Integer]
+    # @!attribute tax_amount
+    #   @return [Integer]
+    # @!attribute tax_rate
+    #   @return [Integer]
+    # @!attribute discount_amount
+    #   @return [Integer]
+    # @!attribute wxpay_goods_id
+    #   @return [String]
+    # @!attribute image_url
+    #   @return [String]
+    # @!attribute url
+    #   @return [String]
+    # @!attribute sku
+    #   @return [String]
+    # @!attribute service_ends_on
+    #   @return [Time]
+    class RefundOrder
+      attr_accessor :name,
+                    :quantity,
+                    :unit_price,
+                    :reference,
+                    :commodity_code,
+                    :unit_of_measure,
+                    :total_amount,
+                    :tax_amount,
+                    :tax_rate,
+                    :discount_amount,
+                    :wxpay_goods_id,
+                    :image_url,
+                    :url,
+                    :sku,
+                    :service_ends_on
+    end
+  end
+end

data/lib/checkout_sdk/payments/refund_request.rb

@@ -9,12 +9,21 @@ module CheckoutSdk
     # @!attribute metadata
     #   @return [Hash{String => Object}]
     # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] - Not available on Previous.
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    # @!attribute capture_action_id
+    #   @return [String]
+    # @!attribute destination
+    #   @return [CheckoutSdk::Common::Destination]
+    # @!attribute items
+    #   @return [Array(CheckoutSdk::Payments::RefundOrder)]
     class RefundRequest
       attr_accessor :amount,
                     :reference,
                     :metadata,
-                    :amount_allocations
+                    :amount_allocations,
+                    :capture_action_id,
+                    :destination,
+                    :items
     end
   end
 end

data/lib/checkout_sdk/payments/sender/government_sender.rb

@@ -6,6 +6,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute address
     #   @return [CheckoutSdk::Common::Address]
+    # @!attribute reference
+    #   @return [String]
     # @!attribute reference_type
     #   @return [String]
     # @!attribute source_of_funds
@@ -15,6 +17,7 @@ module CheckoutSdk
     class GovernmentSender < Sender
       attr_accessor :company_name,
                     :address,
+                    :reference,
                     :reference_type,
                     :source_of_funds,
                     :identification

data/lib/checkout_sdk/payments/sender/individual_sender.rb

@@ -14,6 +14,8 @@ module CheckoutSdk
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute identification
     #   @return [CheckoutSdk::Common::AccountHolderIdentification]
+    # @!attribute reference
+    #   @return [String]
     # @!attribute reference_type
     #   @return [String]
     # @!attribute date_of_birth
@@ -31,6 +33,7 @@ module CheckoutSdk
                     :dob,
                     :address,
                     :identification,
+                    :reference,
                     :reference_type,
                     :date_of_birth,
                     :source_of_funds,

data/lib/checkout_sdk/payments/sessions/payment_sessions_request.rb

@@ -60,6 +60,8 @@ module CheckoutSdk
     #   @return [TrueClass, FalseClass]
     # @!attribute ip_address
     #   @return [String]
+    # @!attribute capture_on
+    #   @return [Time]
     # @!attribute tax_amount
     #   @return [Integer]
     class PaymentSessionsRequest
@@ -92,6 +94,7 @@ module CheckoutSdk
                     :sender,
                     :capture,
                     :ip_address,
+                    :capture_on,
                     :tax_amount
     end
   end

data/lib/checkout_sdk/payments/source/apm/ach_source.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_type
+    #   @return [CheckoutSdk::Common::AccountType]
+    # @!attribute country
+    #   @return [CheckoutSdk::Common::Country]
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute bank_code
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class AchSource < PaymentSource
+      attr_accessor :account_type,
+                    :country,
+                    :account_number,
+                    :bank_code,
+                    :account_holder
+
+      def initialize
+        super CheckoutSdk::Common::PaymentSourceType::ACH
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/bizum_source.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute mobile_number
+    #   @return [String]
+    class BizumSource < PaymentSource
+      attr_accessor :mobile_number
+
+      def initialize
+        super CheckoutSdk::Common::PaymentSourceType::BIZUM
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/octopus_source.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class OctopusSource < PaymentSource
+      def initialize
+        super CheckoutSdk::Common::PaymentSourceType::OCTOPUS
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/plaid_source.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute token
+    #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class PlaidSource < PaymentSource
+      attr_accessor :token, :account_holder
+
+      def initialize
+        super CheckoutSdk::Common::PaymentSourceType::PLAID
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/apm/sequra_source.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute billing_address
+    #   @return [CheckoutSdk::Common::Address]
+    class SequraSource < PaymentSource
+      attr_accessor :billing_address
+
+      def initialize
+        super CheckoutSdk::Common::PaymentSourceType::SEQURA
+      end
+    end
+  end
+end

data/lib/checkout_sdk/payments/source/card_source.rb

@@ -20,6 +20,8 @@ module CheckoutSdk
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute phone
     #   @return [CheckoutSdk::Common::Phone]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     class CardSource < PaymentSource
       attr_accessor :number,
                     :expiry_month,
@@ -29,7 +31,8 @@ module CheckoutSdk
                     :stored,
                     :store_for_future_use,
                     :billing_address,
-                    :phone
+                    :phone,
+                    :account_holder
 
       def initialize
         super CheckoutSdk::Common::PaymentSourceType::CARD

data/lib/checkout_sdk/payments/source/customer_source.rb

@@ -4,8 +4,11 @@ module CheckoutSdk
   module Payments
     # @!attribute id
     #   @return [String]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     class CustomerSource < PaymentSource
-      attr_accessor :id
+      attr_accessor :id,
+                    :account_holder
 
       def initialize
         super CheckoutSdk::Common::PaymentSourceType::CUSTOMER

data/lib/checkout_sdk/payments/source/id_source.rb

@@ -12,12 +12,15 @@ module CheckoutSdk
     #   @return [TrueClass, FalseClass]
     # @!attribute store_for_future_use
     #   @return [TrueClass, FalseClass]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     class IdSource < PaymentSource
       attr_accessor :id,
                     :cvv,
                     :payment_method,
                     :stored,
-                    :store_for_future_use
+                    :store_for_future_use,
+                    :account_holder
 
       def initialize
         super CheckoutSdk::Common::PaymentSourceType::ID

data/lib/checkout_sdk/payments/source/network_token_source.rb

@@ -16,6 +16,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute stored
     #   @return [TrueClass, FalseClass]
+    # @!attribute store_for_future_use
+    #   @return [TrueClass, FalseClass]
     # @!attribute name
     #   @return [String]
     # @!attribute cvv
@@ -24,6 +26,8 @@ module CheckoutSdk
     #   @return [CheckoutSdk::Common::Address]
     # @!attribute phone
     #   @return [CheckoutSdk::Common::Phone]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     class NetworkTokenSource < PaymentSource
       attr_accessor :token,
                     :expiry_month,
@@ -32,10 +36,12 @@ module CheckoutSdk
                     :cryptogram,
                     :eci,
                     :stored,
+                    :store_for_future_use,
                     :name,
                     :cvv,
                     :billing_address,
-                    :phone
+                    :phone,
+                    :account_holder
 
       def initialize
         super CheckoutSdk::Common::PaymentSourceType::NETWORK_TOKEN

data/lib/checkout_sdk/payments/source/token_source.rb

@@ -12,12 +12,15 @@ module CheckoutSdk
     #   @return [TrueClass, FalseClass]
     # @!attribute store_for_future_use
     #   @return [TrueClass, FalseClass]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     class TokenSource < PaymentSource
       attr_accessor :token,
                     :billing_address,
                     :phone,
                     :stored,
-                    :store_for_future_use
+                    :store_for_future_use,
+                    :account_holder
 
       def initialize
         super CheckoutSdk::Common::PaymentSourceType::TOKEN

data/lib/checkout_sdk/sessions/authentication_method.rb

@@ -3,12 +3,12 @@
 module CheckoutSdk
   module Sessions
     module AuthenticationMethod
-      NO_AUTHENTICATION = 'no_authentication'
-      OWN_CREDENTIALS = 'own_credentials'
       FEDERATED_ID = 'federated_id'
+      FIDO = 'fido'
       ISSUER_CREDENTIALS = 'issuer_credentials'
+      NO_AUTHENTICATION = 'no_authentication'
+      OWN_CREDENTIALS = 'own_credentials'
       THIRD_PARTY_AUTHENTICATION = 'third_party_authentication'
-      FIDO = 'fido'
     end
   end
 end

data/lib/checkout_sdk/sessions/authentication_type.rb

@@ -3,11 +3,11 @@
 module CheckoutSdk
   module Sessions
     module AuthenticationType
-      REGULAR = 'regular'
-      RECURRING = 'recurring'
+      ADD_CARD = 'add_card'
       INSTALLMENT = 'installment'
       MAINTAIN_CARD = 'maintain_card'
-      ADD_CARD = 'add_card'
+      RECURRING = 'recurring'
+      REGULAR = 'regular'
     end
   end
 end

data/lib/checkout_sdk/sessions/card_holder_account_info.rb

@@ -17,8 +17,32 @@ module CheckoutSdk
     # @!attribute transactions_today
     #   @return [Integer]
     # @!attribute authentication_method
-    #   @return [String] {AuthenticationMethod}
-    class CardHolderAccountInfo
+    #   @return [AuthenticationMethod] @deprecated This property will be removed in the future, and should not be used.
+    # @!attribute cardholder_account_age_indicator
+    #   @return [CheckoutSdk::Common::CardholderAccountAgeIndicatorType]
+    # @!attribute account_change
+    #   @return [Time]
+    # @!attribute account_change_indicator
+    #   @return [CheckoutSdk::Common::AccountChangeIndicatorType]
+    # @!attribute account_date
+    #   @return [Time]
+    # @!attribute account_password_change
+    #   @return [String]
+    # @!attribute account_password_change_indicator
+    #   @return [CheckoutSdk::Common::AccountPasswordChangeIndicatorType]
+    # @!attribute transactions_per_year
+    #   @return [Integer]
+    # @!attribute payment_account_age
+    #   @return [Time]
+    # @!attribute shipping_address_usage
+    #   @return [Time]
+    # @!attribute account_type
+    #   @return [CheckoutSdk::Common::AccountTypeCardProductType]
+    # @!attribute account_id
+    #   @return [String]
+    # @!attribute three_ds_requestor_authentication_info
+    #   @return [ThreeDsRequestorAuthenticationInfo]
+    class CardholderAccountInfo
       attr_accessor :purchase_count,
                     :account_age,
                     :add_card_attempts,
@@ -26,7 +50,19 @@ module CheckoutSdk
                     :account_name_matches_shipping_name,
                     :suspicious_account_activity,
                     :transactions_today,
-                    :authentication_method
+                    :authentication_method, # @deprecated
+                    :cardholder_account_age_indicator,
+                    :account_change,
+                    :account_change_indicator,
+                    :account_date,
+                    :account_password_change,
+                    :account_password_change_indicator,
+                    :transactions_per_year,
+                    :payment_account_age,
+                    :shipping_address_usage,
+                    :account_type,
+                    :account_id,
+                    :three_ds_requestor_authentication_info
     end
   end
 end

data/lib/checkout_sdk/sessions/channel/browser_session.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/sessions/channel/three_ds_method_completion'
+
 module CheckoutSdk
   module Sessions
     # @!attribute three_ds_method_completion
@@ -37,8 +39,9 @@ module CheckoutSdk
                     :user_agent,
                     :ip_address
 
-      def initialize
+      def initialize(three_ds_method_completion: CheckoutSdk::Sessions::ThreeDsMethodCompletion::U)
         super ChannelDataType::BROWSER
+        @three_ds_method_completion = three_ds_method_completion
       end
     end
   end

data/lib/checkout_sdk/sessions/channel/channel_data_type.rb

@@ -5,6 +5,7 @@ module CheckoutSdk
     module ChannelDataType
       APP = 'app'
       BROWSER = 'browser'
+      MERCHANT_INITIATED = 'merchant_initiated'
     end
   end
 end

data/lib/checkout_sdk/sessions/channel/merchant_initiated_session.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute request_type
+    #   @return [RequestType]
+    class MerchantInitiatedSession < ChannelData
+      attr_accessor :request_type
+
+      def initialize
+        super ChannelDataType::MERCHANT_INITIATED
+      end
+    end
+  end
+end

data/lib/checkout_sdk/sessions/channel/request_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module RequestType
+      ACCOUNT_VERIFICATION = 'account_verification'
+      ADD_CARD = 'add_card'
+      INSTALLMENT_TRANSACTION = 'installment_transaction'
+      MAIL_ORDER = 'mail_order'
+      MAINTAIN_CARD_INFORMATION = 'maintain_card_information'
+      OTHER_PAYMENT = 'other_payment'
+      RECURRING_TRANSACTION = 'recurring_transaction'
+      SPLIT_OR_DELAYED_SHIPMENT = 'split_or_delayed_shipment'
+      TELEPHONE_ORDER = 'telephone_order'
+      TOP_UP = 'top_up'
+      WHITELIST_STATUS_CHECK = 'whitelist_status_check'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/channel/sdk_interface_type.rb

@@ -3,9 +3,9 @@
 module CheckoutSdk
   module Sessions
     module SdkInterfaceType
-      NATIVE = 'native'
-      HTML = 'html'
       BOTH = 'both'
+      HTML = 'html'
+      NATIVE = 'native'
     end
   end
 end

data/lib/checkout_sdk/sessions/initial_transaction.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute acs_transaction_id
+    #   @return [String]
+    # @!attribute authentication_method
+    #   @return [String]
+    # @!attribute authentication_timestamp
+    #   @return [String]
+    # @!attribute authentication_data
+    #   @return [String]
+    # @!attribute initial_session_id
+    #   @return [String]
+    class InitialTransaction
+      attr_accessor :acs_transaction_id,
+                    :authentication_method,
+                    :authentication_timestamp,
+                    :authentication_data,
+                    :initial_session_id
+    end
+  end
+end

data/lib/checkout_sdk/sessions/installment.rb

@@ -12,6 +12,11 @@ module CheckoutSdk
       attr_accessor :number_of_payments,
                     :days_between_payments,
                     :expiry
+
+      def initialize(days_between_payments: 1, expiry: '99991231')
+        @days_between_payments = days_between_payments
+        @expiry = expiry
+      end
     end
   end
 end

data/lib/checkout_sdk/sessions/merchant_risk_info.rb

@@ -5,19 +5,37 @@ module CheckoutSdk
     # @!attribute delivery_email
     #   @return [String]
     # @!attribute delivery_timeframe
-    #   @return [String] {DeliveryTimeframe}
+    #   @return [String] {}DeliveryTimeframe}
     # @!attribute is_preorder
     #   @return [TrueClass, FalseClass]
     # @!attribute is_reorder
     #   @return [TrueClass, FalseClass]
     # @!attribute shipping_indicator
     #   @return [String] {ShippingIndicator}
+    # @!attribute reorder_items_indicator
+    #   @return [String] {ReorderItemsIndicatorType}
+    # @!attribute pre_order_purchase_indicator
+    #   @return [String] {PreOrderPurchaseIndicatorType}
+    # @!attribute pre_order_date
+    #   @return [Time]
+    # @!attribute gift_card_amount
+    #   @return [String]
+    # @!attribute gift_card_currency
+    #   @return [String]
+    # @!attribute gift_card_count
+    #   @return [String]
     class MerchantRiskInfo
       attr_accessor :delivery_email,
                     :delivery_timeframe,
                     :is_preorder,
                     :is_reorder,
-                    :shipping_indicator
+                    :shipping_indicator,
+                    :reorder_items_indicator,
+                    :pre_order_purchase_indicator,
+                    :pre_order_date,
+                    :gift_card_amount,
+                    :gift_card_currency,
+                    :gift_card_count
     end
   end
 end

data/lib/checkout_sdk/sessions/optimization.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/sessions/optimized_properties'
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute optimized
+    #   @return [TrueClass, FalseClass]
+    # @!attribute framework
+    #   @return [String]
+    # @!attribute optimized_properties
+    #   @return [Array(OptimizedProperties)]
+    class Optimization
+      attr_accessor :optimized,
+                    :framework,
+                    :optimized_properties
+    end
+  end
+end