checkout_sdk 1.2.2 → 1.9.1

data/lib/checkout_sdk/accounts/{headers.rb → invitee.rb}

@@ -2,10 +2,10 @@
 
 module CheckoutSdk
   module Accounts
-    # @!attribute if_match
+    # @!attribute email
     #   @return [String]
-    class Headers
-      attr_accessor :if_match
+    class Invitee
+      attr_accessor :email
     end
   end
 end

data/lib/checkout_sdk/accounts/onboard_entity.rb

@@ -4,23 +4,40 @@ module CheckoutSdk
   module Accounts
     # @!attribute reference
     #   @return [String]
-    # @!attribute contact_details
-    #   @return [ContactDetails]
+    # @!attribute is_draft
+    #   @return [Boolean]
     # @!attribute profile
     #   @return [Profile]
+    # @!attribute contact_details
+    #   @return [ContactDetails]
     # @!attribute company
     #   @return [Company]
+    # @!attribute processing_details
+    #   @return [ProcessingDetails]
     # @!attribute individual
     #   @return [Individual]
     # @!attribute documents
     #   @return [OnboardSubEntityDocuments]
+    # @!attribute additional_info
+    #   @return [AdditionalInfo]
+    # @!attribute seller_category
+    #   @return [String] Identifier of a seller category configured on the platform
+    #     during onboarding. Used for US ISV onboarding variants.
+    # @!attribute submitter
+    #   @return [Submitter] Captures evidence of the end-user's consent to onboarding.
+    #     Used for US ISV onboarding variants.
     class OnboardEntity
       attr_accessor :reference,
-                    :contact_details,
+                    :is_draft,
                     :profile,
+                    :contact_details,
                     :company,
+                    :processing_details,
                     :individual,
-                    :documents
+                    :documents,
+                    :additional_info,
+                    :seller_category,
+                    :submitter
     end
   end
 end

data/lib/checkout_sdk/accounts/onboard_sub_entity_documents.rb

@@ -2,16 +2,43 @@
 
 module CheckoutSdk
   module Accounts
-    # @!attribute documents
-    #   @return [Document]
+    # @!attribute identity_verification
+    #   @return [EntityIdentificationDocument]
     # @!attribute company_verification
     #   @return [CompanyVerification]
+    # @!attribute articles_of_association
+    #   @return [ArticlesOfAssociationType]
+    # @!attribute bank_verification
+    #   @return [BankVerification]
+    # @!attribute shareholder_structure
+    #   @return [ShareholderStructure]
+    # @!attribute proof_of_legality
+    #   @return [ProofOfLegality]
+    # @!attribute proof_of_principal_address
+    #   @return [ProofOfPrincipalAddress]
+    # @!attribute additional_document1
+    #   @return [AdditionalDocument]
+    # @!attribute additional_document2
+    #   @return [AdditionalDocument]
+    # @!attribute additional_document3
+    #   @return [AdditionalDocument]
     # @!attribute tax_verification
     #   @return [TaxVerification]
+    # @!attribute financial_verification
+    #   @return [FinancialVerification]
     class OnboardSubEntityDocuments
-      attr_accessor :documents,
+      attr_accessor :identity_verification,
                     :company_verification,
-                    :tax_verification
+                    :articles_of_association,
+                    :bank_verification,
+                    :shareholder_structure,
+                    :proof_of_legality,
+                    :proof_of_principal_address,
+                    :additional_document1,
+                    :additional_document2,
+                    :additional_document3,
+                    :tax_verification,
+                    :financial_verification
     end
   end
 end

data/lib/checkout_sdk/accounts/processing_details.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute settlement_country
+    #   @return [String]
+    # @!attribute target_countries
+    #   @return [Array(String)]
+    # @!attribute annual_processing_volume
+    #   @return [Integer]
+    # @!attribute average_transaction_value
+    #   @return [Integer]
+    # @!attribute highest_transaction_value
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [CheckoutSdk::Common::Currency]
+    class ProcessingDetails
+      attr_accessor :settlement_country,
+                    :target_countries,
+                    :annual_processing_volume,
+                    :average_transaction_value,
+                    :highest_transaction_value,
+                    :currency
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_legality.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [ProofOfLegalityType]
+    # @!attribute front
+    #   @return [String]
+    class ProofOfLegality
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_legality_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ProofOfLegalityType
+      PROOF_OF_LEGALITY = 'proof_of_legality'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_principal_address.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [ProofOfPrincipalAddressType]
+    # @!attribute front
+    #   @return [String]
+    class ProofOfPrincipalAddress
+      attr_reader :type,
+                  :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/proof_of_principal_address_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ProofOfPrincipalAddressType
+      PROOF_OF_ADDRESS = 'proof_of_address'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/reserve_rule_create_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Request body for POST /accounts/entities/{id}/reserve-rules.
+    # Extends {ReserveRuleUpdateRequest} with `valid_from`.
+    #
+    # @!attribute valid_from
+    #   @return [String] ISO-8601 timestamp; must be at least 15 minutes in the future.
+    class ReserveRuleCreateRequest < ReserveRuleUpdateRequest
+      attr_accessor :valid_from
+    end
+  end
+end

data/lib/checkout_sdk/accounts/reserve_rule_holding_duration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # The length of time a rolling reserve collateral balance is held for.
+    #
+    # @!attribute weeks
+    #   @return [Integer] Min 2, max 104.
+    class ReserveRuleHoldingDuration
+      attr_accessor :weeks
+    end
+  end
+end

data/lib/checkout_sdk/accounts/reserve_rule_update_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Request body for PUT /accounts/entities/{entityId}/reserve-rules/{id}.
+    #
+    # @!attribute type
+    #   @return [String] Reserve rule type (e.g. "rolling").
+    # @!attribute rolling
+    #   @return [RollingReserveRule]
+    class ReserveRuleUpdateRequest
+      attr_accessor :type, :rolling
+    end
+  end
+end

data/lib/checkout_sdk/accounts/rolling_reserve_rule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Rolling reserve rule parameters.
+    #
+    # @!attribute percentage
+    #   @return [Float] Min 0, max 100.
+    # @!attribute holding_duration
+    #   @return [ReserveRuleHoldingDuration]
+    class RollingReserveRule
+      attr_accessor :percentage, :holding_duration
+    end
+  end
+end

data/lib/checkout_sdk/accounts/schedule_frequency_daily.rb

@@ -4,7 +4,7 @@ module CheckoutSdk
   module Accounts
     class ScheduleFrequencyDaily < ScheduleRequest
       def initialize
-        super ScheduleFrequencyType::DAILY
+        super(ScheduleFrequencyType::DAILY)
       end
     end
   end

data/lib/checkout_sdk/accounts/schedule_frequency_monthly.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :by_month_day
 
       def initialize
-        super ScheduleFrequencyType::MONTHLY
+        super(ScheduleFrequencyType::MONTHLY)
       end
     end
   end

data/lib/checkout_sdk/accounts/schedule_frequency_weekly.rb

@@ -8,7 +8,7 @@ module CheckoutSdk
       attr_accessor :by_day
 
       def initialize
-        super ScheduleFrequencyType::WEEKLY
+        super(ScheduleFrequencyType::WEEKLY)
       end
     end
   end

data/lib/checkout_sdk/accounts/shareholder_structure.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # @!attribute type
+    #   @return [ShareholderStructureType]
+    # @!attribute front
+    #   @return [String]
+    class ShareholderStructure
+      attr_accessor :type,
+                    :front
+    end
+  end
+end

data/lib/checkout_sdk/accounts/shareholder_structure_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    module ShareholderStructureType
+      CERTIFIED_SHAREHOLDER_STRUCTURE = 'certified_shareholder_structure'
+    end
+  end
+end

data/lib/checkout_sdk/accounts/submitter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Accounts
+    # Captures evidence of the end-user's consent to onboarding.
+    #
+    # @!attribute ip_address
+    #   @return [String] IP address of the end-user submitting the onboarding request.
+    class Submitter
+      attr_accessor :ip_address
+    end
+  end
+end

data/lib/checkout_sdk/agentic_commerce/agentic_commerce.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'checkout_sdk/agentic_commerce/delegated_payment_method_card'
+require 'checkout_sdk/agentic_commerce/delegated_payment_allowance'
+require 'checkout_sdk/agentic_commerce/delegated_payment_billing_address'
+require 'checkout_sdk/agentic_commerce/delegated_payment_risk_signal'
+require 'checkout_sdk/agentic_commerce/delegated_payment_request'
+require 'checkout_sdk/agentic_commerce/agentic_commerce_client'

data/lib/checkout_sdk/agentic_commerce/agentic_commerce_client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module AgenticCommerce
+    # Client for the Agentic Commerce Protocol API (Beta).
+    # Used by AI agents to create delegated payment tokens scoped to a single purchase.
+    class AgenticCommerceClient < Client
+      AGENTIC_COMMERCE = 'agentic_commerce'
+      DELEGATE_PAYMENT = 'delegate_payment'
+      private_constant :AGENTIC_COMMERCE, :DELEGATE_PAYMENT
+
+      # @param [ApiClient] api_client
+      # @param [CheckoutConfiguration] configuration
+      def initialize(api_client, configuration)
+        super(api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY)
+      end
+
+      # Create a delegated payment token.
+      # @param [Hash, DelegatedPaymentRequest] delegated_payment_request
+      # @param [String] idempotency_key Optional
+      def create_delegated_payment_token(delegated_payment_request, idempotency_key = nil)
+        api_client.invoke_post(
+          build_path(AGENTIC_COMMERCE, DELEGATE_PAYMENT),
+          sdk_authorization,
+          delegated_payment_request,
+          idempotency_key
+        )
+      end
+    end
+  end
+end

data/lib/checkout_sdk/agentic_commerce/delegated_payment_allowance.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module AgenticCommerce
+    # Spend-limit allowance attached to a delegated payment.
+    #
+    # @!attribute reason
+    #   @return [String] e.g. "purchase".
+    # @!attribute max_amount
+    #   @return [Integer] Maximum amount in the minor currency unit.
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute checkout_session_id
+    #   @return [String]
+    # @!attribute merchant_id
+    #   @return [String]
+    # @!attribute expires_at
+    #   @return [String] RFC 3339 timestamp.
+    class DelegatedPaymentAllowance
+      attr_accessor :reason,
+                    :max_amount,
+                    :currency,
+                    :checkout_session_id,
+                    :merchant_id,
+                    :expires_at
+    end
+  end
+end

data/lib/checkout_sdk/agentic_commerce/delegated_payment_billing_address.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module AgenticCommerce
+    # Billing address required for delegated payments. Mirrors swagger
+    # `DelegatedPaymentBillingAddress`. Required: `name`, `line_one`, `city`,
+    # `postal_code`, `country`.
+    #
+    # @!attribute name
+    #   @return [String] Full customer name. [Required]
+    # @!attribute line_one
+    #   @return [String] First line of the street address. [Required]
+    # @!attribute line_two
+    #   @return [String] Second line of the street address.
+    # @!attribute city
+    #   @return [String] [Required]
+    # @!attribute state
+    #   @return [String] State / region.
+    # @!attribute postal_code
+    #   @return [String] Postal/ZIP code. [Required]
+    # @!attribute country
+    #   @return [String] ISO 3166-1 alpha-2. [Required]
+    class DelegatedPaymentBillingAddress
+      attr_accessor :name,
+                    :line_one,
+                    :line_two,
+                    :city,
+                    :state,
+                    :postal_code,
+                    :country
+    end
+  end
+end

data/lib/checkout_sdk/agentic_commerce/delegated_payment_method_card.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module AgenticCommerce
+    # Card payment-method block used inside a {DelegatedPaymentRequest}.
+    # Mirrors swagger `DelegatedPaymentMethodCard`. Required fields per spec:
+    # `type`, `card_number_type`, `number`, `metadata`.
+    #
+    # @!attribute type
+    #   @return [String] Always "card".
+    # @!attribute card_number_type
+    #   @return [String] Either "fpan" or "network_token".
+    # @!attribute number
+    #   @return [String] The full card number.
+    # @!attribute exp_month
+    #   @return [String] Two-digit expiry month (MM).
+    # @!attribute exp_year
+    #   @return [String] Four-digit expiry year (YYYY).
+    # @!attribute name
+    #   @return [String] Cardholder name.
+    # @!attribute cvc
+    #   @return [String] Card verification code.
+    # @!attribute cryptogram
+    #   @return [String] Cryptogram for network-token transactions.
+    # @!attribute eci_value
+    #   @return [String] ECI / Security Level Indicator value.
+    # @!attribute checks_performed
+    #   @return [Array<String>] Verification checks performed on the card.
+    # @!attribute iin
+    #   @return [String] Issuer Identification Number (BIN).
+    # @!attribute display_card_funding_type
+    #   @return [String] "credit", "debit", or "prepaid".
+    # @!attribute display_wallet_type
+    #   @return [String] Wallet type for display.
+    # @!attribute display_brand
+    #   @return [String] Card brand for display (e.g. "Visa").
+    # @!attribute display_last4
+    #   @return [String] Last four digits for display.
+    # @!attribute metadata
+    #   @return [Hash{String => String}] Key-value pairs; required per swagger.
+    class DelegatedPaymentMethodCard
+      attr_accessor :type,
+                    :card_number_type,
+                    :number,
+                    :exp_month,
+                    :exp_year,
+                    :name,
+                    :cvc,
+                    :cryptogram,
+                    :eci_value,
+                    :checks_performed,
+                    :iin,
+                    :display_card_funding_type,
+                    :display_wallet_type,
+                    :display_brand,
+                    :display_last4,
+                    :metadata
+
+      def initialize
+        @type = 'card'
+      end
+    end
+  end
+end

data/lib/checkout_sdk/agentic_commerce/delegated_payment_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module AgenticCommerce
+    # Request body for POST /agentic_commerce/delegate_payment.
+    #
+    # @!attribute payment_method
+    #   @return [DelegatedPaymentMethodCard]
+    # @!attribute allowance
+    #   @return [DelegatedPaymentAllowance]
+    # @!attribute billing_address
+    #   @return [DelegatedPaymentBillingAddress]
+    # @!attribute risk_signals
+    #   @return [Array<DelegatedPaymentRiskSignal>]
+    # @!attribute metadata
+    #   @return [Hash{String => String}] Free-form key/value metadata.
+    class DelegatedPaymentRequest
+      attr_accessor :payment_method,
+                    :allowance,
+                    :billing_address,
+                    :risk_signals,
+                    :metadata
+    end
+  end
+end

data/lib/checkout_sdk/agentic_commerce/delegated_payment_risk_signal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module AgenticCommerce
+    # Risk signal attached to a delegated payment request. Mirrors swagger
+    # `DelegatedPaymentRiskSignal`. All three fields are required per spec.
+    #
+    # @!attribute type
+    #   @return [String] Risk signal type. [Required]
+    # @!attribute score
+    #   @return [Integer] Risk score. [Required]
+    # @!attribute action
+    #   @return [String] Action taken based on the risk assessment. [Required]
+    class DelegatedPaymentRiskSignal
+      attr_accessor :type,
+                    :score,
+                    :action
+    end
+  end
+end