checkout_sdk 1.2.2 → 1.9.1

data/lib/checkout_sdk/sessions/device_information.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # Details of the device from which the authentication originated.
+    #
+    # @!attribute device_id
+    #   @return [String] The unique identifier for the device.
+    # @!attribute device_session_id
+    #   @return [String] Device session ID collected from the standalone Risk.js package.
+    #     Pattern: ^(dsid)_(\w{26})$
+    class DeviceInformation
+      attr_accessor :device_id,
+                    :device_session_id
+    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

data/lib/checkout_sdk/sessions/optimized_properties.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute field
+    #   @return [String]
+    # @!attribute original_value
+    #   @return [String]
+    # @!attribute optimized_value
+    #   @return [String]
+    class OptimizedProperties
+      attr_accessor :field,
+                    :original_value,
+                    :optimized_value
+    end
+  end
+end

data/lib/checkout_sdk/sessions/pre_order_purchase_indicator_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module PreOrderPurchaseIndicatorType
+      FUTURE_AVAILABILITY = 'future_availability'
+      MERCHANDISE_AVAILABLE = 'merchandise_available'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/recurring.rb

@@ -9,6 +9,11 @@ module CheckoutSdk
     class Recurring
       attr_accessor :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/reorder_items_indicator_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module ReorderItemsIndicatorType
+      FIRST_TIME_ORDERED = 'first_time_ordered'
+      REORDERED = 'reordered'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/session_request.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/sessions/authentication_type'
+require 'checkout_sdk/sessions/category'
+require 'checkout_sdk/sessions/transaction_type'
+require 'checkout_sdk/common/challenge_indicator'
+
 module CheckoutSdk
   module Sessions
     # @!attribute source
@@ -35,13 +40,17 @@ module CheckoutSdk
     # @!attribute shipping_address_matches_billing
     #   @return [TrueClass, FalseClass]
     # @!attribute completion
-    #   @return [CompletionInfo]
+    #   @return [Completion]
     # @!attribute channel_data
     #   @return [ChannelData]
     # @!attribute recurring
     #   @return [Recurring]
     # @!attribute installment
     #   @return [Installment]
+    # @!attribute optimization
+    #   @return [Optimization]
+    # @!attribute initial_transaction
+    #   @return [InitialTransaction]
     class SessionRequest
       attr_accessor :source,
                     :amount,
@@ -62,7 +71,22 @@ module CheckoutSdk
                     :completion,
                     :channel_data,
                     :recurring,
-                    :installment
+                    :installment,
+                    :optimization,
+                    :initial_transaction,
+                    :device_information
+
+      def initialize(source: CardSource.new,
+                     authentication_type: CheckoutSdk::Sessions::AuthenticationType::REGULAR,
+                     authentication_category: CheckoutSdk::Sessions::Category::PAYMENT,
+                     challenge_indicator: CheckoutSdk::Common::ChallengeIndicator::NO_PREFERENCE,
+                     transaction_type: CheckoutSdk::Sessions::TransactionType::GOODS_SERVICE)
+        @source = source
+        @authentication_type = authentication_type
+        @authentication_category = authentication_category
+        @challenge_indicator = challenge_indicator
+        @transaction_type = transaction_type
+      end
     end
   end
 end

data/lib/checkout_sdk/sessions/sessions.rb

@@ -5,6 +5,7 @@ require 'checkout_sdk/sessions/authentication_type'
 require 'checkout_sdk/sessions/card_holder_account_info'
 require 'checkout_sdk/sessions/category'
 require 'checkout_sdk/sessions/delivery_timeframe'
+require 'checkout_sdk/sessions/device_information'
 require 'checkout_sdk/sessions/installment'
 require 'checkout_sdk/sessions/merchant_risk_info'
 require 'checkout_sdk/sessions/recurring'
@@ -16,6 +17,13 @@ require 'checkout_sdk/sessions/sessions_billing_descriptor'
 require 'checkout_sdk/sessions/shipping_indicator'
 require 'checkout_sdk/sessions/transaction_type'
 require 'checkout_sdk/sessions/three_ds_method_completion_request'
+require 'checkout_sdk/sessions/three_ds_req_auth_method'
+require 'checkout_sdk/sessions/three_ds_requestor_authentication_info'
+require 'checkout_sdk/sessions/reorder_items_indicator_type'
+require 'checkout_sdk/sessions/pre_order_purchase_indicator_type'
+require 'checkout_sdk/sessions/optimized_properties'
+require 'checkout_sdk/sessions/optimization'
+require 'checkout_sdk/sessions/initial_transaction'
 
 # channel
 require 'checkout_sdk/sessions/channel/channel_data'
@@ -26,6 +34,8 @@ require 'checkout_sdk/sessions/channel/three_ds_method_completion'
 require 'checkout_sdk/sessions/channel/uie_elements'
 require 'checkout_sdk/sessions/channel/app_session'
 require 'checkout_sdk/sessions/channel/browser_session'
+require 'checkout_sdk/sessions/channel/request_type'
+require 'checkout_sdk/sessions/channel/merchant_initiated_session'
 
 # completion
 require 'checkout_sdk/sessions/completion/completion_info'

data/lib/checkout_sdk/sessions/sessions_client.rb

@@ -12,7 +12,7 @@ module CheckoutSdk
       # @param [ApiClient] api_client
       # @param [CheckoutConfiguration] configuration
       def initialize(api_client, configuration)
-        super api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH)
       end
 
       # @param [Hash, SessionRequest] session_request
@@ -55,7 +55,7 @@ module CheckoutSdk
         if session_secret.nil?
           sdk_authorization
         else
-          SessionSecretCredentials.new(session_secret) \
+          SessionSecretCredentials.new(session_secret)
                                   .get_authorization(AuthorizationType::CUSTOM)
         end
       end

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

@@ -22,8 +22,9 @@ module CheckoutSdk
                     :stored,
                     :store_for_future_use
 
-      def initialize
-        super SessionSourceType::CARD
+      def initialize(stored: false)
+        super(SessionSourceType::CARD)
+        @stored = stored
       end
     end
   end

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

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :id
 
       def initialize
-        super SessionSourceType::ID
+        super(SessionSourceType::ID)
       end
     end
   end

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

@@ -20,7 +20,7 @@ module CheckoutSdk
                     :stored
 
       def initialize
-        super SessionSourceType::NETWORK_TOKEN
+        super(SessionSourceType::NETWORK_TOKEN)
       end
     end
   end

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

@@ -11,7 +11,7 @@ module CheckoutSdk
                     :store_for_future_use
 
       def initialize
-        super SessionSourceType::TOKEN
+        super(SessionSourceType::TOKEN)
       end
     end
   end

data/lib/checkout_sdk/sessions/three_ds_method_completion_request.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require 'checkout_sdk/sessions/channel/three_ds_method_completion'
+
 module CheckoutSdk
   module Sessions
     # @!attribute three_ds_method_completion
-    #   @return [String] {ThreeDsMethodCompletion}
+    #   @return [String] {CheckoutSdk::Sessions::Channel::ThreeDsMethodCompletion}
     class ThreeDsMethodCompletionRequest
       attr_accessor :three_ds_method_completion
     end

data/lib/checkout_sdk/sessions/three_ds_req_auth_method.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    module ThreeDsReqAuthMethod
+      NO_THREEDS_REQUESTOR_AUTHENTICATION_OCCURRED = 'no_threeds_requestor_authentication_occurred'
+      THREE3DS_REQUESTOR_OWN_CREDENTIALS = 'three3ds_requestor_own_credentials'
+      FEDERATED_ID = 'federated_id'
+      ISSUER_CREDENTIALS = 'issuer_credentials'
+      THIRD_PARTY_AUTHENTICATION = 'third_party_authentication'
+      FIDO_AUTHENTICATOR = 'fido_authenticator'
+      FIDO_AUTHENTICATOR_FIDO_ASSURANCE_DATA_SIGNED = 'fido_authenticator_fido_assurance_data_signed'
+      SRC_ASSURANCE_DATA = 'src_assurance_data'
+    end
+  end
+end

data/lib/checkout_sdk/sessions/three_ds_requestor_authentication_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Sessions
+    # @!attribute three_ds_req_auth_method
+    #   @return [String] {ThreeDsReqAuthMethod}
+    # @!attribute three_ds_req_auth_timestamp
+    #   @return [Time]
+    # @!attribute three_ds_req_auth_data
+    #   @return [String]
+    class ThreeDsRequestorAuthenticationInfo
+      attr_accessor :three_ds_req_auth_method,
+                    :three_ds_req_auth_timestamp,
+                    :three_ds_req_auth_data
+    end
+  end
+end

data/lib/checkout_sdk/sessions/transaction_type.rb

@@ -3,11 +3,11 @@
 module CheckoutSdk
   module Sessions
     module TransactionType
-      GOODS_SERVICE = 'goods_service'
-      CHECK_ACCEPTANCE = 'check_acceptance'
       ACCOUNT_FUNDING = 'account_funding'
-      QUASHI_CARD_TRANSACTION = 'quashi_card_transaction'
+      CHECK_ACCEPTANCE = 'check_acceptance'
+      GOODS_SERVICE = 'goods_service'
       PREPAID_ACTIVATION_AND_LOAD = 'prepaid_activation_and_load'
+      QUASHI_CARD_TRANSACTION = 'quashi_card_transaction'
     end
   end
 end

data/lib/checkout_sdk/sources/sepa_source_request.rb

@@ -12,7 +12,7 @@ module CheckoutSdk
                       :source_data
 
         def initialize
-          super CheckoutSdk::Previous::Sources::SourceType::SEPA
+          super(CheckoutSdk::Previous::Sources::SourceType::SEPA)
         end
       end
     end

data/lib/checkout_sdk/sources/sources_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
 
         # @param [Hash, SepaSourceRequest] sepa_source_request

data/lib/checkout_sdk/standalone_account_updater/account_updater_card.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module StandaloneAccountUpdater
+    # Card details for the standalone Account Updater request.
+    #
+    # @!attribute number
+    #   @return [String] The card number.
+    # @!attribute expiry_month
+    #   @return [Integer]
+    # @!attribute expiry_year
+    #   @return [Integer] Four-digit expiry year.
+    class AccountUpdaterCard
+      attr_accessor :number, :expiry_month, :expiry_year
+    end
+  end
+end

data/lib/checkout_sdk/standalone_account_updater/account_updater_instrument.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module StandaloneAccountUpdater
+    # Instrument reference for the standalone Account Updater request.
+    #
+    # @!attribute id
+    #   @return [String] Unique instrument identifier (e.g. "src_...").
+    class AccountUpdaterInstrument
+      attr_accessor :id
+    end
+  end
+end

data/lib/checkout_sdk/standalone_account_updater/account_updater_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module StandaloneAccountUpdater
+    # Request body for POST /account-updater/cards.
+    #
+    # @!attribute source_options
+    #   @return [AccountUpdaterSourceOptions]
+    class AccountUpdaterRequest
+      attr_accessor :source_options
+    end
+  end
+end

data/lib/checkout_sdk/standalone_account_updater/account_updater_source_options.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module StandaloneAccountUpdater
+    # The source to update. Provide either `card` or `instrument`, but not both.
+    #
+    # @!attribute card
+    #   @return [AccountUpdaterCard]
+    # @!attribute instrument
+    #   @return [AccountUpdaterInstrument]
+    class AccountUpdaterSourceOptions
+      attr_accessor :card, :instrument
+    end
+  end
+end

data/lib/checkout_sdk/standalone_account_updater/standalone_account_updater.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/standalone_account_updater/account_updater_card'
+require 'checkout_sdk/standalone_account_updater/account_updater_instrument'
+require 'checkout_sdk/standalone_account_updater/account_updater_source_options'
+require 'checkout_sdk/standalone_account_updater/account_updater_request'
+require 'checkout_sdk/standalone_account_updater/standalone_account_updater_client'

data/lib/checkout_sdk/standalone_account_updater/standalone_account_updater_client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module StandaloneAccountUpdater
+    # Client for the Standalone Account Updater API.
+    # Uses OAuth with the `vault:real-time-account-updater` scope.
+    class StandaloneAccountUpdaterClient < Client
+      ACCOUNT_UPDATER = 'account-updater'
+      CARDS = 'cards'
+      private_constant :ACCOUNT_UPDATER, :CARDS
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::OAUTH)
+      end
+
+      # Get updated card credentials.
+      # @param [Hash, AccountUpdaterRequest] account_updater_request
+      def update_card(account_updater_request)
+        api_client.invoke_post(
+          build_path(ACCOUNT_UPDATER, CARDS),
+          sdk_authorization,
+          account_updater_request
+        )
+      end
+    end
+  end
+end

data/lib/checkout_sdk/tokens/apple_pay_token_request.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :token_data
 
       def initialize
-        super CheckoutSdk::Tokens::TokenType::APPLE_PAY
+        super(CheckoutSdk::Tokens::TokenType::APPLE_PAY)
       end
     end
   end

data/lib/checkout_sdk/tokens/google_pay_token_request.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :token_data
 
       def initialize
-        super CheckoutSdk::Tokens::TokenType::GOOGLE_PAY
+        super(CheckoutSdk::Tokens::TokenType::GOOGLE_PAY)
       end
     end
   end

data/lib/checkout_sdk/tokens/token_metadata_billing_address.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Tokens
+    # Partial billing address (city + country) returned by GET /tokens/{tokenId}/metadata.
+    #
+    # @!attribute city
+    #   @return [String]
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    class TokenMetadataBillingAddress
+      attr_accessor :city,
+                    :country
+    end
+  end
+end

data/lib/checkout_sdk/tokens/token_metadata_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Tokens
+    # Response from GET /tokens/{tokenId}/metadata.
+    #
+    # @!attribute token
+    #   @return [String]
+    # @!attribute type
+    #   @return [String]
+    # @!attribute expires_on
+    #   @return [String] RFC 3339 timestamp.
+    # @!attribute expiry_month
+    #   @return [Integer]
+    # @!attribute expiry_year
+    #   @return [Integer]
+    # @!attribute scheme
+    #   @return [String]
+    # @!attribute last4
+    #   @return [String]
+    # @!attribute bin
+    #   @return [String]
+    # @!attribute card_type
+    #   @return [String] One of CREDIT/DEBIT/PREPAID/CHARGE/"DEFERRED DEBIT".
+    # @!attribute card_category
+    #   @return [String] One of CONSUMER/COMMERCIAL.
+    # @!attribute issuer
+    #   @return [String]
+    # @!attribute issuer_country
+    #   @return [String] ISO 3166-1 alpha-2.
+    # @!attribute product_id
+    #   @return [String]
+    # @!attribute product_type
+    #   @return [String]
+    # @!attribute billing_address
+    #   @return [TokenMetadataBillingAddress]
+    class TokenMetadataResponse
+      attr_accessor :token,
+                    :type,
+                    :expires_on,
+                    :expiry_month,
+                    :expiry_year,
+                    :scheme,
+                    :last4,
+                    :bin,
+                    :card_type,
+                    :card_category,
+                    :issuer,
+                    :issuer_country,
+                    :product_id,
+                    :product_type,
+                    :billing_address
+    end
+  end
+end

data/lib/checkout_sdk/tokens/tokens.rb

@@ -8,3 +8,5 @@ require 'checkout_sdk/tokens/apple_pay_token_request'
 require 'checkout_sdk/tokens/google_pay_token_request'
 require 'checkout_sdk/tokens/apple_pay_token_data'
 require 'checkout_sdk/tokens/card_token_request'
+require 'checkout_sdk/tokens/token_metadata_billing_address'
+require 'checkout_sdk/tokens/token_metadata_response'

data/lib/checkout_sdk/tokens/tokens_client.rb

@@ -16,6 +16,17 @@ module CheckoutSdk
       def request_token(token_request)
         api_client.invoke_post(TOKENS, sdk_authorization, token_request)
       end
+
+      # Returns the details for an active token without consuming it.
+      # The token remains usable after this call.
+      # Requires SecretKey or OAuth (not PublicKey).
+      # @param [String] token_id Pattern: ^(tok)_(\w{26})$
+      def get_token_metadata(token_id)
+        api_client.invoke_get(
+          build_path(TOKENS, token_id, 'metadata'),
+          sdk_authorization(CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH)
+        )
+      end
     end
   end
 end

data/lib/checkout_sdk/transfers/create_transfer.rb

@@ -2,19 +2,19 @@
 
 module CheckoutSdk
   module Transfers
-    # @!attribute reference
-    #   @return [String]
     # @!attribute transfer_type
     #   @return [String] {TransferType}
     # @!attribute source
     #   @return [TransferSource]
     # @!attribute destination
     #   @return [TransferDestination]
+    # @!attribute reference
+    #   @return [String]
     class CreateTransfer
-      attr_accessor :reference,
-                    :transfer_type,
+      attr_accessor :transfer_type,
                     :source,
-                    :destination
+                    :destination,
+                    :reference
     end
   end
 end