checkout_sdk 1.2.2 → 1.3.0

data/lib/checkout_sdk/client.rb

@@ -11,7 +11,8 @@ module CheckoutSdk
     attr_reader :api_client,
                 :authorization_type,
                 :configuration
-    protected :api_client, :authorization_type, :configuration
+
+    protected
 
     # @param [CheckoutSdk::ApiClient] api_client
     # @param [CheckoutConfiguration] configuration
@@ -22,8 +23,6 @@ module CheckoutSdk
       @configuration = configuration
     end
 
-    protected
-
     # @param [Array] args
     def build_path(*args)
       args.join('/')

data/lib/checkout_sdk/common/account_change_indicator_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    class AccountChangeIndicatorType
+      THIS_TRANSACTION = 'this_transaction'
+      LESS_THAN_THIRTY_DAYS = 'less_than_thirty_days'
+      THIRTY_TO_SIXTY_DAYS = 'thirty_to_sixty_days'
+      MORE_THAN_SIXTY_DAYS = 'more_than_sixty_days'
+    end
+  end
+end

data/lib/checkout_sdk/common/account_holder.rb

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Common
     # @!attribute type
     #   @return [String] {AccountHolderType}
-    # @!attribute title
+    # @!attribute full_name
     #   @return [String]
     # @!attribute first_name
     #   @return [String]
@@ -12,6 +12,10 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute last_name
     #   @return [String]
+    # @!attribute email
+    #   @return [String]
+    # @!attribute gender
+    #   @return [String]
     # @!attribute company_name
     #   @return [String]
     # @!attribute tax_id
@@ -21,23 +25,23 @@ module CheckoutSdk
     # @!attribute country_of_birth
     #   @return [Country]
     # @!attribute residential_status
-    #   @return [String]
+    #   @return [String] {ResidentialStatusType}
     # @!attribute billing_address
     #   @return [Address]
     # @!attribute phone
     #   @return [Phone]
     # @!attribute identification
     #   @return [AccountHolderIdentification]
-    # @!attribute email
-    #   @return [String]
-    # @!attribute gender
-    #   @return [String]
+    # @!attribute account_name_inquiry
+    #   @return [Boolean]
     class AccountHolder
       attr_accessor :type,
-                    :title,
+                    :full_name,
                     :first_name,
                     :middle_name,
                     :last_name,
+                    :email,
+                    :gender,
                     :company_name,
                     :tax_id,
                     :date_of_birth,
@@ -46,8 +50,7 @@ module CheckoutSdk
                     :billing_address,
                     :phone,
                     :identification,
-                    :email,
-                    :gender
+                    :account_name_inquiry
     end
   end
 end

data/lib/checkout_sdk/common/account_password_change_indicator_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    class AccountPasswordChangeIndicatorType
+      NO_CHANGE = 'no_change'
+      THIS_TRANSACTION = 'this_transaction'
+      LESS_THAN_THIRTY_DAYS = 'less_than_thirty_days'
+      THIRTY_TO_SIXTY_DAYS = 'thirty_to_sixty_days'
+      MORE_THAN_SIXTY_DAYS = 'more_than_sixty_days'
+    end
+  end
+end

data/lib/checkout_sdk/common/account_type_card_product_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    class AccountTypeCardProductType
+      CREDIT = 'credit'
+      DEBIT = 'debit'
+      NOT_APPLICABLE = 'not_applicable'
+    end
+  end
+end

data/lib/checkout_sdk/common/cardholder_account_age_indicator_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    class CardholderAccountAgeIndicatorType
+      LESS_THAN_THIRTY_DAYS = 'less_than_thirty_days'
+      MORE_THAN_SIXTY_DAYS = 'more_than_sixty_days'
+      NO_ACCOUNT = 'no_account'
+      THIRTY_TO_SIXTY_DAYS = 'thirty_to_sixty_days'
+      THIS_TRANSACTION = 'this_transaction'
+    end
+  end
+end

data/lib/checkout_sdk/common/common.rb

@@ -23,3 +23,9 @@ require 'checkout_sdk/common/marketplace_data'
 require 'checkout_sdk/common/shipping_info'
 require 'checkout_sdk/common/product'
 require 'checkout_sdk/common/date_range_query_filter'
+require 'checkout_sdk/common/account_change_indicator_type'
+require 'checkout_sdk/common/account_password_change_indicator_type'
+require 'checkout_sdk/common/account_type_card_product_type'
+require 'checkout_sdk/common/cardholder_account_age_indicator_type'
+require 'checkout_sdk/common/customer_retry'
+require 'checkout_sdk/common/destination'

data/lib/checkout_sdk/common/customer_retry.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute max_attempts
+    #   @return [Integer]
+    class CustomerRetry
+      attr_accessor :max_attempts
+    end
+  end
+end

data/lib/checkout_sdk/common/destination.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Common
+    # @!attribute account_type
+    #   @return [AccountType]
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute bank_code
+    #   @return [String]
+    # @!attribute branch_code
+    #   @return [String]
+    # @!attribute iban
+    #   @return [String]
+    # @!attribute bban
+    #   @return [String]
+    # @!attribute swift_bic
+    #   @return [String]
+    # @!attribute country
+    #   @return [Country]
+    # @!attribute account_holder
+    #   @return [AccountHolder]
+    # @!attribute bank
+    #   @return [BankDetails]
+    class Destination
+      attr_accessor :account_type,
+                    :account_number,
+                    :bank_code,
+                    :branch_code,
+                    :iban,
+                    :bban,
+                    :swift_bic,
+                    :country,
+                    :account_holder,
+                    :bank
+    end
+  end
+end

data/lib/checkout_sdk/common/payment_source_type.rb

@@ -52,6 +52,14 @@ module CheckoutSdk
       TRUSTLY = 'trustly'
       ILLICADO = 'illicado'
       SEPA = 'sepa'
+      ACH = 'ach'
+      BIZUM = 'bizum'
+      OCTOPUS = 'octopus'
+      PLAID = 'plaid'
+      SEQURA = 'sequra'
+      TABBY = 'tabby'
+      APPLEPAY = 'applepay'
+      GOOGLEPAY = 'googlepay'
     end
   end
 end

data/lib/checkout_sdk/common/product.rb

@@ -8,10 +8,13 @@ module CheckoutSdk
     #   @return [Integer]
     # @!attribute price
     #   @return [Integer]
+    # @!attribute reference
+    #   @return [String]
     class Product
       attr_accessor :name,
                     :quantity,
-                    :price
+                    :price,
+                    :reference
     end
   end
 end

data/lib/checkout_sdk/error.rb

@@ -1,30 +1,46 @@
 # frozen_string_literal: true
 
 module CheckoutSdk
-  class CheckoutException < StandardError
-  end
+  class CheckoutException < StandardError; end
 
   class CheckoutArgumentException < CheckoutException; end
 
   class CheckoutAuthorizationException < CheckoutException
     def self.invalid_authorization(authorization_type)
-      CheckoutAuthorizationException.new("Operation requires #{authorization_type} authorization type")
+      new("Operation requires #{authorization_type} authorization type.")
     end
 
     def self.invalid_key(key_type)
-      CheckoutAuthorizationException.new("#{key_type} is required for this operation.")
+      new("#{key_type} is required for this operation.")
     end
   end
 
   class CheckoutApiException < CheckoutException
     attr_reader :http_metadata, :error_details
 
-    def initialize(response)
+    def initialize(response, message = nil)
       @http_metadata = CheckoutUtils.map_to_http_metadata(response)
-      if !http_metadata.body.nil? && http_metadata.body != ''
-        @error_details = JSON.parse(http_metadata.body, object_class: OpenStruct)
+      @error_details = parse_error_details(http_metadata.body)
+      super(message || build_error_message)
+    end
+
+    private
+
+    def parse_error_details(body)
+      return if body.nil? || body.empty?
+
+      JSON.parse(body, object_class: OpenStruct)
+    rescue JSON::ParserError
+      nil
+    end
+
+    def build_error_message
+      message = "The API response status code (#{http_metadata.status_code}) does not indicate success."
+      if @error_details && !@error_details.to_h.empty?
+        details = @error_details.to_h.map { |key, value| "#{key}: #{value}" }.join(', ')
+        message += " Details: #{details}."
       end
-      super("The API response status code (#{http_metadata.status_code}) does not indicate success.")
+      message
     end
   end
 end

data/lib/checkout_sdk/payments/applepay.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute store_payment_details
+    #   @return [String] {StorePaymentDetailsType}
+    class Applepay
+      attr_accessor :account_holder,
+                    :store_payment_details
+    end
+  end
+end

data/lib/checkout_sdk/payments/{sessions/card.rb → card.rb}

@@ -2,10 +2,13 @@
 
 module CheckoutSdk
   module Payments
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
     # @!attribute store_payment_details
     #   @return [String] {StorePaymentDetailsType}
     class Card
-      attr_accessor :store_payment_details
+      attr_accessor :account_holder,
+                    :store_payment_details
     end
   end
 end

data/lib/checkout_sdk/payments/exemption.rb

@@ -12,6 +12,8 @@ module CheckoutSdk
       OUT_OF_SCA_SCOPE = 'out_of_sca_scope'
       OTHER = 'other'
       LOW_RISK_PROGRAM = 'low_risk_program'
+      DATA_SHARE = 'data_share'
+      RECURRING_OPERATION = 'recurring_operation'
     end
   end
 end

data/lib/checkout_sdk/payments/googlepay.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    # @!attribute store_payment_details
+    #   @return [String] {StorePaymentDetailsType}
+    class Googlepay
+      attr_accessor :account_holder,
+                    :store_payment_details
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payment_instruction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute purpose
+    #   @return [String] {PaymentPurposeType}
+    class HostedPaymentInstruction
+      attr_accessor :purpose
+    end
+  end
+end

data/lib/checkout_sdk/payments/hosted/hosted_payments_session.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/payments/payment_type'
+
 module CheckoutSdk
   module Payments
-    # @!attribute amount
-    #   @return [Integer]
     # @!attribute currency
     #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute billing
+    #   @return [BillingInformation]
+    # @!attribute success_url
+    #   @return [String]
+    # @!attribute cancel_url
+    #   @return [String]
+    # @!attribute failure_url
+    #   @return [String]
+    # @!attribute amount
+    #   @return [Integer]
     # @!attribute payment_type
     #   @return [String] {PaymentType}
     # @!attribute payment_ip
@@ -16,12 +26,16 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute description
     #   @return [String]
+    # @!attribute display_name
+    #   @return [String]
+    # @!attribute processing_channel_id
+    #   @return [String]
+    # @!attribute amount_allocations
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
     # @!attribute customer
     #   @return [CheckoutSdk::Common::CustomerRequest]
     # @!attribute shipping
     #   @return [ShippingDetails]
-    # @!attribute billing
-    #   @return [BillingInformation]
     # @!attribute recipient
     #   @return [PaymentRecipient]
     # @!attribute processing
@@ -34,53 +48,60 @@ module CheckoutSdk
     #   @return [Array(CheckoutSdk::Common::Product)]
     # @!attribute risk
     #   @return [RiskRequest]
-    # @!attribute success_url
-    #   @return [String]
-    # @!attribute cancel_url
-    #   @return [String]
-    # @!attribute failure_url
-    #   @return [String]
+    # @!attribute customer_retry
+    #   @return [PaymentRetryRequest]
+    # @!attribute sender
+    #   @return [CheckoutSdk::Payments::Sender]
     # @!attribute metadata
     #   @return [Hash(String=>Object)]
     # @!attribute locale
-    #   @return [String]
+    #   @return [String] {LocaleType}
     # @!attribute three_ds
     #   @return [ThreeDSRequest]
     # @!attribute capture
     #   @return [TrueClass, FalseClass]
     # @!attribute capture_on
     #   @return [Time]
-    # @!attribute processing_channel_id
-    #   @return [String] - Not available on Previous.
-    # @!attribute amount_allocations
-    #   @return [Array(CheckoutSdk::Common::AmountAllocations)] - Not available on Previous.
+    # @!attribute instruction
+    #   @return [HostedPaymentInstruction]
+    # @!attribute payment_method_configuration
+    #   @return [PaymentMethodConfiguration]
     class HostedPaymentsSession
-      attr_accessor :amount,
-                    :currency,
+      attr_accessor :currency,
+                    :billing,
+                    :success_url,
+                    :cancel_url,
+                    :failure_url,
+                    :amount,
                     :payment_type,
                     :payment_ip,
                     :billing_descriptor,
                     :reference,
                     :description,
+                    :display_name,
+                    :processing_channel_id,
+                    :amount_allocations,
                     :customer,
                     :shipping,
-                    :billing,
                     :recipient,
                     :processing,
                     :allow_payment_methods,
                     :disabled_payment_methods,
                     :products,
                     :risk,
-                    :success_url,
-                    :cancel_url,
-                    :failure_url,
+                    :customer_retry,
+                    :sender,
                     :metadata,
                     :locale,
                     :three_ds,
                     :capture,
                     :capture_on,
-                    :processing_channel_id,
-                    :amount_allocations
+                    :instruction,
+                    :payment_method_configuration
+
+      def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
+        @payment_type = payment_type
+      end
     end
   end
 end

data/lib/checkout_sdk/payments/hosted/payment_purpose_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    class PaymentPurposeType
+      DONATIONS = 'donations'
+      EDUCATION = 'education'
+      EMERGENCY_NEED = 'emergency_need'
+      EXPATRIATION = 'expatriation'
+      FAMILY_SUPPORT = 'family_support'
+      FINANCIAL_SERVICES = 'financial_services'
+      GIFTS = 'gifts'
+      INCOME = 'income'
+      INSURANCE = 'insurance'
+      INVESTMENT = 'investment'
+      IT_SERVICES = 'it_services'
+      LEISURE = 'leisure'
+      LOAN_PAYMENT = 'loan_payment'
+      MEDICAL_TREATMENT = 'medical_treatment'
+      OTHER = 'other'
+      PENSION = 'pension'
+      ROYALTIES = 'royalties'
+      SAVINGS = 'savings'
+      TRAVEL_AND_TOURISM = 'travel_and_tourism'
+    end
+  end
+end

data/lib/checkout_sdk/payments/links/payment_link.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/payments/payment_type'
+
 module CheckoutSdk
   module Payments
     # @!attribute amount
@@ -16,6 +18,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute description
     #   @return [String]
+    # @!attribute display_name
+    #   @return [String]
     # @!attribute processing_channel_id
     #   @return [String] - Not available on Previous.
     # @!attribute amount_allocations
@@ -34,6 +38,8 @@ module CheckoutSdk
     #   @return [ProcessingSettings]
     # @!attribute allow_payment_methods
     #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
+    # @!attribute disabled_payment_methods
+    #   @return [Array(CheckoutSdk::Common::PaymentSourceType)]
     # @!attribute products
     #   @return [Array(CheckoutSdk::Common::Product)]
     # @!attribute metadata
@@ -42,6 +48,10 @@ module CheckoutSdk
     #   @return [ThreeDSRequest]
     # @!attribute risk
     #   @return [RiskRequest]
+    # @!attribute customer_retry
+    #   @return [CheckoutSdk::Common::CustomerRetry]
+    # @!attribute sender
+    #   @return [CheckoutSdk::Payments::Sender]
     # @!attribute return_url
     #   @return [String]
     # @!attribute locale
@@ -58,6 +68,7 @@ module CheckoutSdk
                     :billing_descriptor,
                     :reference,
                     :description,
+                    :display_name,
                     :processing_channel_id,
                     :amount_allocations,
                     :expires_in,
@@ -67,14 +78,21 @@ module CheckoutSdk
                     :recipient,
                     :processing,
                     :allow_payment_methods,
+                    :disabled_payment_methods,
                     :products,
                     :metadata,
                     :three_ds,
                     :risk,
+                    :customer_retry,
+                    :sender,
                     :return_url,
                     :locale,
                     :capture,
                     :capture_on
+
+      def initialize(payment_type: CheckoutSdk::Payments::PaymentType::REGULAR)
+        @payment_type = payment_type
+      end
     end
   end
 end

data/lib/checkout_sdk/payments/locale_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module LocaleType
+      AR = 'ar'
+      DA_DK = 'da-DK'
+      DE_DE = 'de-DE'
+      EL = 'el'
+      EN_GB = 'en-GB'
+      ES_ES = 'es-ES'
+      FI_FI = 'fi-FI'
+      FIL_PH = 'fil-PH'
+      FR_FR = 'fr-FR'
+      HI_IN = 'hi-IN'
+      ID_ID = 'id-ID'
+      IT_IT = 'it-IT'
+      JA_JP = 'ja-JP'
+      MS_MY = 'ms-MY'
+      NB_NO = 'nb-NO'
+      NL_NL = 'nl-NL'
+      PT_PT = 'pt-PT'
+      SV_SE = 'sv-SE'
+      TH_TH = 'th-TH'
+      VI_VN = 'vi-VN'
+      ZH_CN = 'zh-CN'
+      ZH_HK = 'zh-HK'
+      ZH_TW = 'zh-TW'
+    end
+  end
+end

data/lib/checkout_sdk/payments/partial_authorization.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute enabled
+    #   @return [TrueClass, FalseClass]
+    class PartialAuthorization
+      attr_accessor :enabled
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_method_configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute applepay
+    #   @return [Applepay]
+    # @!attribute card
+    #   @return [Card]
+    # @!attribute googlepay
+    #   @return [Googlepay]
+    class PaymentMethodConfiguration
+      attr_accessor :applepay,
+                    :card,
+                    :googlepay
+    end
+  end
+end

data/lib/checkout_sdk/payments/payment_request.rb

@@ -18,6 +18,8 @@ module CheckoutSdk
     #   @return [String]
     # @!attribute description
     #   @return [String]
+    # @!attribute partial_authorization
+    #   @return [PartialAuthorization]
     # @!attribute authorization_type
     #   @return [String] {AuthorizationType}
     # @!attribute capture
@@ -74,6 +76,7 @@ module CheckoutSdk
                     :merchant_initiated,
                     :reference,
                     :description,
+                    :partial_authorization,
                     :authorization_type,
                     :capture,
                     :capture_on,