checkout_sdk 1.2.2 → 1.9.1

data/lib/checkout_sdk/api_client.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 module CheckoutSdk
   class ApiClient
     attr_accessor :client, :multipart_client, :log
 
-    # @param [CheckoutConfiguration] configuration
-    # @param [String] uri
     def initialize(configuration, uri)
       @client = configuration.http_client.clone
       @client.url_prefix = uri
@@ -14,54 +14,41 @@ module CheckoutSdk
       @log = configuration.logger
     end
 
-    # @param [String] path
-    # @param [SdkAuthorization] authorization
-    # @param [Object] params
-    def invoke_get(path,
-                   authorization,
-                   params = nil)
+    def invoke_get(path, authorization, params = nil)
       invoke(:get, path, authorization, params: params)
     end
 
-    def invoke_post(path,
-                    authorization,
-                    request = nil,
-                    idempotency_key = nil)
-      invoke(:post, path, authorization, request, idempotency_key)
+    def invoke_post(path, authorization, request = nil, idempotency_key = nil)
+      invoke(:post, path, authorization, request, idempotency_key, params: nil)
     end
 
-    def invoke_put(path,
-                   authorization,
-                   request)
-      invoke(:put, path, authorization, request)
+    def invoke_put(path, authorization, request, headers = nil)
+      invoke(:put, path, authorization, request, nil, params: nil, extra_headers: headers)
     end
 
-    def invoke_patch(path,
-                     authorization,
-                     request = nil)
-      invoke(:patch, path, authorization, request)
+    def invoke_patch(path, authorization, request = nil)
+      invoke(:patch, path, authorization, request, nil, params: nil)
     end
 
-    def invoke_delete(path,
-                      authorization)
+    def invoke_delete(path, authorization)
       invoke(:delete, path, authorization)
     end
 
-    def submit_file(path,
-                    authorization,
-                    request)
+    def submit_file(path, authorization, request)
       upload(path, authorization, request)
     end
 
     private
 
-    def invoke(method, path, authorization, body = nil, idempotency_key = nil, params: nil)
+    def invoke(method, path, authorization, body = nil, idempotency_key = nil, params: nil, extra_headers: nil)
       path = append_params(path, params) unless params.nil?
 
-      headers = get_default_headers authorization
+      headers = default_headers(authorization)
       headers[:'Content-Type'] = 'application/json'
       headers[:'Cko-Idempotency-Key'] = idempotency_key unless idempotency_key.nil?
 
+      apply_extra_headers(headers, extra_headers)
+
       json_body = CheckoutSdk::JsonSerializer.to_custom_hash(body).to_json
 
       begin
@@ -71,26 +58,33 @@ module CheckoutSdk
         raise CheckoutApiException, e.response
       end
 
-      parse_response response
+      parse_response(response)
     end
 
-    def get_default_headers(authorization)
-      {
-        'User-Agent': "checkout-sdk-ruby/#{VERSION}",
-        Accept: 'application/json',
-        Authorization: authorization.authorization_header
-      }
+    def default_headers(authorization)
+      { 'User-Agent': "checkout-sdk-ruby/#{VERSION}", Accept: 'application/json',
+        Authorization: authorization.authorization_header }
+    end
+
+    # Map a typed headers container (e.g. {CheckoutSdk::Common::Headers}) onto the underlying
+    # HTTP header hash. Each attribute that's set is emitted as the corresponding
+    # canonical HTTP header.
+    def apply_extra_headers(http_headers, extra_headers)
+      return if extra_headers.nil?
+      return unless extra_headers.respond_to?(:if_match) && extra_headers.if_match
+
+      http_headers[:'If-Match'] = extra_headers.if_match
     end
 
     def append_params(path, input_params)
       raise CheckoutArgumentException, 'Query parameters were not provided' if input_params.nil?
 
-      if input_params.is_a? String
-        params = input_params
-      else
-        hash = CheckoutSdk::JsonSerializer.to_custom_hash(input_params)
-        params = URI.encode_www_form(hash)
-      end
+      params = if input_params.is_a? String
+                 input_params
+               else
+                 hash = CheckoutSdk::JsonSerializer.to_custom_hash(input_params)
+                 URI.encode_www_form(hash)
+               end
 
       "#{path}?#{params}"
     end
@@ -103,48 +97,73 @@ module CheckoutSdk
           MIME::Types.type_for(file_request.file).first,
           File.basename(file_request.file)
         ),
-        :purpose => file_request.purpose
+        purpose: file_request.purpose
       }
     end
 
     def upload(path, authorization, file_request)
-      headers = get_default_headers authorization
+      headers = default_headers(authorization)
 
-      file = File.open(file_request.file)
+      File.open(file_request.file) do |file|
+        form = build_multipart_request(file_request, file)
 
-      form = build_multipart_request file_request, file
+        begin
+          @log.info "post: /#{path}"
+          response = @multipart_client.run_request(:post, path, form, headers)
+        rescue Faraday::ClientError => e
+          raise CheckoutApiException, e.response
+        end
 
-      begin
-        @log.info "post: /#{path}"
-        response = @multipart_client.run_request(:post, path, form, headers)
-      rescue Faraday::ClientError => e
-        raise CheckoutApiException, e.response
-      ensure
-        file.close
+        parse_response(response)
       end
-
-      parse_response response
     end
 
     def parse_response(response)
       raise CheckoutApiException, response if response.status < 200 || response.status >= 400
 
       metadata = CheckoutUtils.map_to_http_metadata(response)
-      body = parse_json_or_contents(response)
-      body = OpenStruct.new if body.nil?
-      body = OpenStruct.new(items: body) if body.is_a? Array
-      body.http_metadata = metadata if body.is_a? OpenStruct
+      body = parse_body(response)
+
+      if body.is_a?(Array)
+        body = OpenStruct.new(items: body)
+      elsif !body.is_a?(OpenStruct)
+        body = OpenStruct.new(contents: body)
+      end
+
+      body.http_metadata = metadata if body.is_a?(OpenStruct)
+
       body
+    rescue JSON::ParserError => e
+      raise CheckoutApiException.new(response, "Error parsing JSON: #{e.message}")
+    rescue StandardError => e
+      @log&.error("Unexpected error occurred: #{e.message}")
+      raise
     end
 
-    def parse_json_or_contents(response)
-      return if response.body.nil? || response.body == ''
+    def parse_body(response)
+      content_type = response.headers['Content-Type']
+      return OpenStruct.new if response.body.nil? || response.body.empty?
 
-      if response.body.start_with?('{', '[')
-        JSON.parse(response.body, object_class: OpenStruct)
+      if content_type&.include?('application/json')
+        parsed_value = JSON.parse(response.body)
+        deep_convert_to_ostruct(parsed_value)
+      elsif content_type&.include?('text/csv')
+        csv_data = CSV.parse(response.body, headers: true)
+        OpenStruct.new(csv: csv_data)
       else
         OpenStruct.new(contents: response.body)
       end
     end
+
+    def deep_convert_to_ostruct(obj)
+      case obj
+      when Hash
+        OpenStruct.new(obj.transform_values { |value| deep_convert_to_ostruct(value) })
+      when Array
+        obj.map { |item| deep_convert_to_ostruct(item) }
+      else
+        obj
+      end
+    end
   end
 end

data/lib/checkout_sdk/apm/ideal/ideal_client.rb

@@ -10,7 +10,7 @@ module CheckoutSdk
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
       end
 
       def info

data/lib/checkout_sdk/apm/previous/klarna/klarna_client.rb

@@ -13,7 +13,7 @@ module CheckoutSdk
         # @param [ApiClient] api_client
         # @param [CheckoutConfiguration] configuration
         def initialize(api_client, configuration)
-          super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
         end
 
         # @param credit_session_request [Hash, CreditSessionRequest]

data/lib/checkout_sdk/apm/previous/sepa/sepa_client.rb

@@ -13,7 +13,7 @@ module CheckoutSdk
         # @param [ApiClient] api_client
         # @param [CheckoutConfiguration] configuration
         def initialize(api_client, configuration)
-          super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
+          super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
         end
 
         # @param mandate_id [String]

data/lib/checkout_sdk/balances/balance_values.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Balances
+    # Balance values returned per currency account (swagger schema: Balance).
+    #
+    # @!attribute pending
+    #   @return [Integer] Incoming funds that will be added to Available once cleared.
+    # @!attribute available
+    #   @return [Integer] Funds available for processing.
+    # @!attribute payable
+    #   @return [Integer] Funds reserved from Available for outgoing transactions not yet cleared.
+    # @!attribute collateral
+    #   @return [Integer] Funds held to cover potential liabilities.
+    # @!attribute operational
+    #   @return [Integer] Funds held for processing Payouts and Issuing payments when Available is insufficient.
+    # @!attribute collateral_breakdown
+    #   @return [CollateralBreakdown]
+    class BalanceValues
+      attr_accessor :pending,
+                    :available,
+                    :payable,
+                    :collateral,
+                    :operational,
+                    :collateral_breakdown
+    end
+  end
+end

data/lib/checkout_sdk/balances/balances.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/balances/balances_query'
+require 'checkout_sdk/balances/collateral_breakdown'
+require 'checkout_sdk/balances/balance_values'
+require 'checkout_sdk/balances/currency_account_balance'
 require 'checkout_sdk/balances/balances_client'

data/lib/checkout_sdk/balances/balances_query.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Balances
+    # Query parameters accepted by GET /balances/{id}.
+    #
+    # @!attribute query
+    #   @return [String] Search expression (e.g. "currency:EUR").
+    # @!attribute with_currency_account_id
+    #   @return [TrueClass, FalseClass] When true, the response includes the
+    #     `currency_account_id` on each {CurrencyAccountBalance}.
+    #   Serialised as `withCurrencyAccountId`.
+    # @!attribute balances_at
+    #   @return [String] A UTC datetime (RFC 3339) to retrieve historical
+    #     balances at a specific point in time. Must be in the past.
+    #   Serialised as `balancesAt`.
+    class BalancesQuery
+      attr_accessor :query,
+                    :with_currency_account_id,
+                    :balances_at
+
+      # Returns the params in the camelCase form expected by the API.
+      def to_h
+        {
+          query: query,
+          withCurrencyAccountId: with_currency_account_id,
+          balancesAt: balances_at
+        }.compact
+      end
+    end
+  end
+end

data/lib/checkout_sdk/balances/collateral_breakdown.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Balances
+    # Breakdown of the funds held in the `collateral` balance.
+    #
+    # @!attribute fixed_reserve
+    #   @return [Integer] (required) The portion of the `collateral` balance held as a fixed reserve.
+    # @!attribute rolling_reserve
+    #   @return [Integer] (required) The portion of the `collateral` balance held as a rolling reserve.
+    class CollateralBreakdown
+      attr_accessor :fixed_reserve,
+                    :rolling_reserve
+    end
+  end
+end

data/lib/checkout_sdk/balances/currency_account_balance.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Balances
+    # A single currency account's balance details (swagger: CurrencyAccountBalance).
+    #
+    # @!attribute currency_account_id
+    #   @return [String] The unique identifier of the currency account (sub-account).
+    #     Returned only when the request is made with `withCurrencyAccountId=true`.
+    # @!attribute descriptor
+    #   @return [String]
+    # @!attribute holding_currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute balances_as_of
+    #   @return [String] UTC datetime (RFC 3339) reflecting when balance values were fetched.
+    # @!attribute balances
+    #   @return [BalanceValues]
+    class CurrencyAccountBalance
+      attr_accessor :currency_account_id,
+                    :descriptor,
+                    :holding_currency,
+                    :balances_as_of,
+                    :balances
+    end
+  end
+end

data/lib/checkout_sdk/checkout_api.rb

@@ -43,6 +43,38 @@ module CheckoutSdk
   #   @return [CheckoutSdk::Payments::PaymentContextsClient]
   # @!attribute payment_sessions
   #   @return [CheckoutSdk::Payments::PaymentSessionsClient]
+  # @!attribute payments_setups
+  #   @return [CheckoutSdk::Payments::PaymentSetupsClient]
+  # @!attribute flow
+  #   @return [CheckoutSdk::Payments::FlowClient]
+  # @!attribute forward
+  #   @return [CheckoutSdk::Forward::ForwardClient]
+  # @!attribute onboarding_simulator
+  #   @return [CheckoutSdk::OnboardingSimulator::OnboardingSimulatorClient]
+  # @!attribute agentic_commerce
+  #   @return [CheckoutSdk::AgenticCommerce::AgenticCommerceClient]
+  # @!attribute compliance_requests
+  #   @return [CheckoutSdk::ComplianceRequests::ComplianceRequestsClient]
+  # @!attribute standalone_account_updater
+  #   @return [CheckoutSdk::StandaloneAccountUpdater::StandaloneAccountUpdaterClient]
+  # @!attribute network_tokens
+  #   @return [CheckoutSdk::NetworkTokens::NetworkTokensClient]
+  # @!attribute payment_methods
+  #   @return [CheckoutSdk::PaymentMethods::PaymentMethodsClient]
+  # @!attribute applicants
+  #   @return [CheckoutSdk::Identities::Applicants::ApplicantsClient]
+  # @!attribute aml_screening
+  #   @return [CheckoutSdk::Identities::AmlScreening::AmlScreeningClient]
+  # @!attribute id_document_verification
+  #   @return [CheckoutSdk::Identities::IdDocumentVerification::IdDocumentVerificationClient]
+  # @!attribute identity_verification
+  #   @return [CheckoutSdk::Identities::IdentityVerification::IdentityVerificationClient]
+  # @!attribute face_authentication
+  #   @return [CheckoutSdk::Identities::FaceAuthentication::FaceAuthenticationClient]
+  # @!attribute apple_pay
+  #   @return [CheckoutSdk::Payments::ApplePayClient]
+  # @!attribute google_pay
+  #   @return [CheckoutSdk::Payments::GooglePayClient]
   class CheckoutApi
     attr_reader :customers,
                 :disputes,
@@ -51,6 +83,8 @@ module CheckoutSdk
                 :instruments,
                 :links,
                 :payments,
+                :payments_setups,
+                :flow,
                 :reports,
                 :sessions,
                 :tokens,
@@ -64,7 +98,21 @@ module CheckoutSdk
                 :financial,
                 :issuing,
                 :contexts,
-                :payment_sessions
+                :payment_sessions,
+                :forward,
+                :onboarding_simulator,
+                :agentic_commerce,
+                :compliance_requests,
+                :standalone_account_updater,
+                :network_tokens,
+                :payment_methods,
+                :applicants,
+                :aml_screening,
+                :id_document_verification,
+                :identity_verification,
+                :face_authentication,
+                :apple_pay,
+                :google_pay
 
     # @param [CheckoutConfiguration] configuration
     def initialize(configuration)
@@ -90,6 +138,26 @@ module CheckoutSdk
       @issuing = CheckoutSdk::Issuing::IssuingClient.new api_client, configuration
       @contexts = CheckoutSdk::Payments::PaymentContextsClient.new api_client, configuration
       @payment_sessions = CheckoutSdk::Payments::PaymentSessionsClient.new api_client, configuration
+      @payments_setups = CheckoutSdk::Payments::PaymentSetupsClient.new api_client, configuration
+      @flow = CheckoutSdk::Payments::FlowClient.new api_client, configuration
+      @forward = CheckoutSdk::Forward::ForwardClient.new(api_client, configuration)
+      @onboarding_simulator = CheckoutSdk::OnboardingSimulator::OnboardingSimulatorClient.new(api_client, configuration)
+      @agentic_commerce = CheckoutSdk::AgenticCommerce::AgenticCommerceClient.new(api_client, configuration)
+      @compliance_requests = CheckoutSdk::ComplianceRequests::ComplianceRequestsClient.new(api_client, configuration)
+      @standalone_account_updater =
+        CheckoutSdk::StandaloneAccountUpdater::StandaloneAccountUpdaterClient.new(api_client, configuration)
+      @network_tokens = CheckoutSdk::NetworkTokens::NetworkTokensClient.new(api_client, configuration)
+      @payment_methods = CheckoutSdk::PaymentMethods::PaymentMethodsClient.new(api_client, configuration)
+      @applicants = CheckoutSdk::Identities::Applicants::ApplicantsClient.new(api_client, configuration)
+      @aml_screening = CheckoutSdk::Identities::AmlScreening::AmlScreeningClient.new(api_client, configuration)
+      @id_document_verification =
+        CheckoutSdk::Identities::IdDocumentVerification::IdDocumentVerificationClient.new(api_client, configuration)
+      @identity_verification =
+        CheckoutSdk::Identities::IdentityVerification::IdentityVerificationClient.new(api_client, configuration)
+      @face_authentication =
+        CheckoutSdk::Identities::FaceAuthentication::FaceAuthenticationClient.new(api_client, configuration)
+      @apple_pay = CheckoutSdk::Payments::ApplePayClient.new(api_client, configuration)
+      @google_pay = CheckoutSdk::Payments::GooglePayClient.new(api_client, configuration)
     end
 
     private
@@ -122,5 +190,11 @@ module CheckoutSdk
     def transfers_client(configuration)
       ApiClient.new(configuration, configuration.environment.transfers_uri)
     end
+
+    # @param [CheckoutConfiguration] configuration
+    # @return [ApiClient]
+    def forward_client(configuration)
+      ApiClient.new(configuration, configuration.environment.forward_uri)
+    end
   end
 end

data/lib/checkout_sdk/checkout_oauth_sdk_builder.rb

@@ -41,6 +41,17 @@ module CheckoutSdk
     # @return [CheckoutSdk::CheckoutApi]
     def build
       super
+
+      # Determine authorization URI following Go logic
+      auth_uri = authorization_uri
+      if auth_uri.nil? || auth_uri.empty?
+        auth_uri = if environment_subdomain
+                     environment_subdomain.authorization_uri
+                   else
+                     environment.authorization_uri
+                   end
+      end
+
       configuration = CheckoutConfiguration.new(
         OAuthSdkCredentials.new(client_id,
                                 client_secret,
@@ -48,7 +59,7 @@ module CheckoutSdk
                                 http_client,
                                 environment,
                                 logger,
-                                authorization_uri),
+                                auth_uri),
         environment,
         http_client,
         multipart_http_client,

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,10 @@ 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'
+require 'checkout_sdk/common/headers'

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