checkout_sdk 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2a7e1557158e8381bfbf318e1cfef80519f8df0889b98e28b8a33ea220873a5
-  data.tar.gz: 93f1dbae3763bca6872f065d077e3ff113c9dec6e67f39071b5c8cbf05cfc037
+  metadata.gz: 14e68356d1de167bcf9ba9c5370aaf6ac81804e1b844474f6c2c573cdc41e96b
+  data.tar.gz: 8061066149def7f8b6288c94cbc6d2362ac4528b2741759dca3d1ad254160637
 SHA512:
-  metadata.gz: 1e7a17d7f19728b444b4b02689f178aa0fa3a6e66d07d6462f39f9766dae5da3aea839ed7c7ad0a571c87043fd42d69361a2a9afbfae4bdca4c68bfe81535af7
-  data.tar.gz: c5d72ac85ba9b18281912ffc445a116dc1435237526b8a2b8afe7a2d9283f8ec90d96bdf6316a6e24ccb5b8654614ae3dc127924da48632e22f73830291f7b59
+  metadata.gz: 33cad8c67ad6c941526a6edd897800d975a431da83ca6c0c661181b80943cd63bb417242ee581c523fc1225ae635cc8a0644521c0dfb5f9bc95b3ad78479a9bf
+  data.tar.gz: e707e11a320e4db4c3612643120a283b8b58de2ddc13b54999cf6ce7d155fc8441d6f584bb03e23f699801f14e413c292c6bc7af62fb542a0809349f4e673d68

data/lib/checkout_sdk/abstract_checkout_sdk_builder.rb

@@ -8,7 +8,9 @@ module CheckoutSdk
     #   @return [Faraday::Connection]
     # @!attribute multipart_http_client
     #   @return [Faraday::Connection]
-    attr_accessor :environment, :http_client, :multipart_http_client, :logger
+    # @!attribute environment_subdomain
+    #   @return [EnvironmentSubdomain, nil]
+    attr_accessor :environment, :http_client, :multipart_http_client, :logger, :environment_subdomain
 
     # @param [Environment] environment
     def with_environment(environment)
@@ -33,6 +35,12 @@ module CheckoutSdk
       self
     end
 
+    # @param [String, nil] subdomain
+    def with_environment_subdomain(subdomain)
+      @environment_subdomain = EnvironmentSubdomain.new(@environment, subdomain)
+      self
+    end
+
     def build
       with_environment(Environment.sandbox) if environment.nil?
       if http_client.nil?

data/lib/checkout_sdk/accounts/profile.rb

@@ -8,10 +8,13 @@ module CheckoutSdk
     #   @return [Array(String)]
     # @!attribute default_holding_currency
     #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute holding_currencies
+    #   @return [Array(CheckoutSdk::Common::Currency)]
     class Profile
       attr_accessor :urls,
                     :mccs,
-                    :default_holding_currency
+                    :default_holding_currency,
+                    :holding_currencies
     end
   end
 end

data/lib/checkout_sdk/checkout_api.rb

@@ -97,7 +97,12 @@ module CheckoutSdk
     # @param [CheckoutConfiguration] configuration
     # @return [ApiClient]
     def base_api_client(configuration)
-      ApiClient.new(configuration, configuration.environment.base_uri)
+      base_uri = configuration.environment.base_uri
+      subdomain = configuration.environment_subdomain
+
+      base_uri = subdomain.base_uri if subdomain&.base_uri
+
+      ApiClient.new(configuration, base_uri)
     end
 
     # @param [CheckoutConfiguration] configuration

data/lib/checkout_sdk/checkout_configuration.rb

@@ -7,19 +7,30 @@ module CheckoutSdk
   #   @return [Environment]
   # @!attribute http_client
   #   @return [Faraday::Connection]
+  # @!attribute multipart_http_client
+  #   @return [Faraday::Connection]
+  # @!attribute logger
+  #   @return [Logger]
+  # @!attribute environment_subdomain
+  #   @return [EnvironmentSubdomain, nil]
   class CheckoutConfiguration
-    attr_accessor :credentials, :environment, :http_client, :multipart_http_client, :logger
+    attr_accessor :credentials, :environment, :http_client, :multipart_http_client, :logger, :environment_subdomain
 
+    # Initializes the CheckoutConfiguration.
+    #
     # @param [SdkCredentials] credentials
     # @param [Environment] environment
     # @param [Faraday::Connection] http_client
     # @param [Faraday::Connection] multipart_http_client
-    def initialize(credentials, environment, http_client, multipart_http_client, logger)
+    # @param [Logger] logger
+    # @param [EnvironmentSubdomain, nil] environment_subdomain (optional, default: nil)
+    def initialize(credentials, environment, http_client, multipart_http_client, logger, environment_subdomain = nil)
       @credentials = credentials
       @environment = environment
       @http_client = http_client
       @multipart_http_client = multipart_http_client
       @logger = logger
+      @environment_subdomain = environment_subdomain
     end
   end
 end

data/lib/checkout_sdk/checkout_oauth_sdk_builder.rb

@@ -41,21 +41,23 @@ module CheckoutSdk
     # @return [CheckoutSdk::CheckoutApi]
     def build
       super
-      CheckoutSdk::CheckoutApi.new(
-        CheckoutConfiguration.new(
-          OAuthSdkCredentials.new(client_id,
-                                  client_secret,
-                                  scopes,
-                                  http_client,
-                                  environment,
-                                  logger,
-                                  authorization_uri),
-          environment,
-          http_client,
-          multipart_http_client,
-          logger
-        )
+      configuration = CheckoutConfiguration.new(
+        OAuthSdkCredentials.new(client_id,
+                                client_secret,
+                                scopes,
+                                http_client,
+                                environment,
+                                logger,
+                                authorization_uri),
+        environment,
+        http_client,
+        multipart_http_client,
+        logger
       )
+
+      configuration.environment_subdomain = environment_subdomain if environment_subdomain
+
+      CheckoutApi.new(configuration)
     end
   end
 end

data/lib/checkout_sdk/checkout_static_keys_sdk_builder.rb

@@ -11,15 +11,17 @@ module CheckoutSdk
       @secret_key_pattern = SECRET_KEY_PATTERN
       @public_key_pattern = PUBLIC_KEY_PATTERN
       super
-      CheckoutApi.new(
-        CheckoutConfiguration.new(
-          StaticKeysSdkCredentials.new(secret_key, public_key),
-          environment,
-          http_client,
-          multipart_http_client,
-          logger
-        )
+      configuration = CheckoutConfiguration.new(
+        StaticKeysSdkCredentials.new(secret_key, public_key),
+        environment,
+        http_client,
+        multipart_http_client,
+        logger
       )
+
+      configuration.environment_subdomain = environment_subdomain if environment_subdomain
+
+      CheckoutApi.new(configuration)
     end
   end
 end

data/lib/checkout_sdk/common/instrument_type.rb

@@ -6,6 +6,7 @@ module CheckoutSdk
       BANK_ACCOUNT = 'bank_account'
       TOKEN = 'token'
       CARD = 'card'
+      SEPA = 'sepa'
       CARD_TOKEN = 'card_token'
     end
   end

data/lib/checkout_sdk/environment_subdomain.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  # @!attribute environment
+  #   @return [Environment]
+  # @!attribute subdomain
+  #   @return [String]
+  class EnvironmentSubdomain
+    attr_reader :base_uri, :environment, :subdomain
+
+    # Initializes the EnvironmentSubdomain with the given environment and subdomain.
+    #
+    # @param environment [Environment] The environment object which should have a base_uri method.
+    # @param subdomain [String] The subdomain to add to the environment's API URL.
+    def initialize(environment, subdomain)
+      @environment = environment
+      @subdomain = subdomain
+      @base_uri = add_subdomain_to_api_url_environment(environment, subdomain)
+    end
+
+    private
+
+    # Adds the subdomain to the API URL of the given environment.
+    #
+    # @param environment [Environment] The environment object which should have a base_uri method.
+    # @param subdomain [String] The subdomain to add to the environment's API URL.
+    # @return [String] The new environment URL with the subdomain added.
+    def add_subdomain_to_api_url_environment(environment, subdomain)
+      api_url = environment.base_uri
+      new_environment = api_url
+
+      # Regex to match a subdomain consisting of 8 to 11 lowercase alphanumeric characters
+      if subdomain =~ /^[0-9a-z]{8,11}$/
+        url_parts = URI.parse(api_url)
+        new_host = "#{subdomain}.#{url_parts.host}"
+
+        port = url_parts.scheme == 'https' && url_parts.port == 443 ? nil : url_parts.port
+
+        new_url_parts = URI::Generic.build(
+          scheme: url_parts.scheme,
+          userinfo: url_parts.userinfo,
+          host: new_host,
+          port: port,
+          path: url_parts.path,
+          query: url_parts.query,
+          fragment: url_parts.fragment
+        )
+
+        new_environment = new_url_parts.to_s
+      end
+
+      new_environment
+    end
+  end
+end

data/lib/checkout_sdk/instruments/create/instrument_data.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute account_number
+    #   @return [String]
+    # @!attribute country
+    #   @return [String] {CheckoutSdk::Common::Country}
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute payment_type
+    #   @return [String] {CheckoutSdk::Payments::PaymentType}
+    # @!attribute mandate_id
+    #   @return [String]
+    # @!attribute date_of_signature
+    #   @return [DateTime]
+    class InstrumentData
+      attr_accessor :account_number,
+                    :country,
+                    :currency,
+                    :payment_type,
+                    :mandate_id,
+                    :date_of_signature
+    end
+  end
+end

data/lib/checkout_sdk/instruments/create/instrument_sepa.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Instruments
+    # @!attribute instrument_data
+    #   @return [InstrumentData]
+    # @!attribute account_holder
+    #   @return [CheckoutSdk::Common::AccountHolder]
+    class InstrumentSepa < Instrument
+      attr_accessor :instrument_data,
+                    :account_holder
+
+      def initialize
+        super CheckoutSdk::Common::InstrumentType::SEPA
+      end
+    end
+  end
+end

data/lib/checkout_sdk/instruments/instruments.rb

@@ -12,6 +12,8 @@ require 'checkout_sdk/instruments/get/bank_account_field_query'
 require 'checkout_sdk/instruments/create/instrument'
 require 'checkout_sdk/instruments/create/instrument_token'
 require 'checkout_sdk/instruments/create/instrument_bank_account'
+require 'checkout_sdk/instruments/create/instrument_sepa'
+require 'checkout_sdk/instruments/create/instrument_data'
 # Client
 require 'checkout_sdk/instruments/base_instruments_client'
 require 'checkout_sdk/instruments/instruments_client'

data/lib/checkout_sdk/payments/base_payments_client.rb

@@ -41,6 +41,16 @@ module CheckoutSdk
                                void_request,
                                idempotency_key)
       end
+
+      # @param [String] payment_id
+      # @param [Hash, ReverseRequest] reverse_request
+      # @param [String, nil] idempotency_key
+      def reverse_payment(payment_id, reverse_request = nil, idempotency_key = nil)
+        api_client.invoke_post(build_path(PAYMENTS_PATH, payment_id, 'reversals'),
+                               sdk_authorization,
+                               reverse_request,
+                               idempotency_key)
+      end
     end
   end
 end

data/lib/checkout_sdk/payments/payment_request.rb

@@ -63,6 +63,8 @@ module CheckoutSdk
     #   @return [PaymentRetryRequest]
     # @!attribute metadata
     #   @return [Hash{String => Object}]
+    # @!attribute instruction
+    #   @return [PaymentInstruction]
     class PaymentRequest
       attr_accessor :payment_context_id,
                     :source,
@@ -93,7 +95,8 @@ module CheckoutSdk
                     :processing,
                     :items,
                     :retry,
-                    :metadata
+                    :metadata,
+                    :instruction
     end
   end
 end

data/lib/checkout_sdk/payments/payments.rb

@@ -161,3 +161,8 @@ require 'checkout_sdk/payments/contexts/payment_contexts_client'
 
 # Payment Sessions
 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/reverse_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    class ReverseRequest
+      attr_accessor :reference,
+                    :metadata
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module PaymentMethodsType
+      APPLEPAY = 'applepay'
+      BANCONTACT = 'bancontact'
+      CARD = 'card'
+      EPS = 'eps'
+      GIROPAY = 'giropay'
+      GOOGLEPAY = 'googlepay'
+      IDEAL = 'ideal'
+      KNET = 'knet'
+      MULTIBANCO = 'multibanco'
+      PRZELEWY24 = 'p24'
+      PAYPAL = 'paypal'
+      SOFORT = 'sofort'
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module CheckoutSdk
         super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY
       end
 
-      # @param [Hash] payment_sessions
+      # @param [Hash, PaymentSessionsRequest] payment_sessions
       def create_payment_sessions(payment_sessions)
         api_client.invoke_post(PAYMENT_SESSIONS, sdk_authorization, payment_sessions)
       end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    # @!attribute amount
+    #   @return [Integer]
+    # @!attribute currency
+    #   @return [String] {CheckoutSdk::Common::Currency}
+    # @!attribute payment_type
+    #   @return [TrueClass, FalseClass]
+    # @!attribute billing
+    #   @return [BillingInformation]
+    # @!attribute billing_descriptor
+    #   @return [BillingDescriptor]
+    # @!attribute reference
+    #   @return [String]
+    # @!attribute description
+    #   @return [String]
+    # @!attribute customer
+    #   @return [CheckoutSdk::Common::CustomerRequest]
+    # @!attribute shipping
+    #   @return [ShippingDetails]
+    # @!attribute recipient
+    #   @return [PaymentRecipient]
+    # @!attribute processing
+    #   @return [ProcessingSettings]
+    # @!attribute processing_channel_id
+    #   @return [String]
+    # @!attribute expires_on
+    #   @return [Time]
+    # @!attribute payment_method_configuration
+    #   @return [PaymentMethodConfiguration]
+    # @!attribute enabled_payment_methods
+    #   @return [Array(PaymentMethodsType)]
+    # @!attribute disabled_payment_methods
+    #   @return [Array(PaymentMethodsType)]
+    # @!attribute items
+    #   @return [Array(Product)]
+    # @!attribute amount_allocations
+    #   @return [Array(CheckoutSdk::Common::AmountAllocations)]
+    # @!attribute risk
+    #   @return [RiskRequest]
+    # @!attribute retry
+    #   @return [PaymentRetryRequest]
+    # @!attribute display_name
+    #   @return [String]
+    # @!attribute success_url
+    #   @return [String]
+    # @!attribute failure_url
+    #   @return [String]
+    # @!attribute metadata
+    #   @return [Hash{String => Object}]
+    # @!attribute locale
+    #   @return [String]
+    # @!attribute three_ds
+    #   @return [ThreeDSRequest]
+    # @!attribute sender
+    #   @return [Sender]
+    # @!attribute capture
+    #   @return [TrueClass, FalseClass]
+    # @!attribute ip_address
+    #   @return [String]
+    # @!attribute tax_amount
+    #   @return [Integer]
+    class PaymentSessionsRequest
+      attr_accessor :amount,
+                    :currency,
+                    :payment_type,
+                    :billing,
+                    :billing_descriptor,
+                    :reference,
+                    :description,
+                    :customer,
+                    :shipping,
+                    :recipient,
+                    :processing,
+                    :processing_channel_id,
+                    :expires_on,
+                    :payment_method_configuration,
+                    :enabled_payment_methods,
+                    :disabled_payment_methods,
+                    :items,
+                    :amount_allocations,
+                    :risk,
+                    :retry,
+                    :display_name,
+                    :success_url,
+                    :failure_url,
+                    :metadata,
+                    :locale,
+                    :three_ds,
+                    :sender,
+                    :capture,
+                    :ip_address,
+                    :tax_amount
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CheckoutSdk
+  module Payments
+    module StorePaymentDetailsType
+      DISABLED = 'disabled'
+      ENABLED = 'enabled'
+    end
+  end
+end

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

@@ -2,15 +2,12 @@
 
 module CheckoutSdk
   module Payments
-    # @!attribute bic
-    #   @return [String]
     # @!attribute description
     #   @return [String]
     # @!attribute language
     #   @return [String]
     class IdealSource < PaymentSource
-      attr_accessor :bic,
-                    :description,
+      attr_accessor :description,
                     :language
 
       def initialize

data/lib/checkout_sdk/previous/checkout_previous_static_keys_sdk_builder.rb

@@ -11,15 +11,17 @@ module CheckoutSdk
         @secret_key_pattern = SECRET_KEY_PATTERN
         @public_key_pattern = PUBLIC_KEY_PATTERN
         super
-        CheckoutApi.new(
-          CheckoutConfiguration.new(
-            PreviousStaticKeysSdkCredentials.new(secret_key, public_key),
-            environment,
-            http_client,
-            multipart_http_client,
-            logger
-          )
+        configuration = CheckoutConfiguration.new(
+          PreviousStaticKeysSdkCredentials.new(secret_key, public_key),
+          environment,
+          http_client,
+          multipart_http_client,
+          logger
         )
+
+        configuration.environment_subdomain = environment_subdomain if environment_subdomain
+
+        CheckoutApi.new(configuration)
       end
     end
   end

data/lib/checkout_sdk/sessions/authentication_type.rb

@@ -5,6 +5,9 @@ module CheckoutSdk
     module AuthenticationType
       REGULAR = 'regular'
       RECURRING = 'recurring'
+      INSTALLMENT = 'installment'
+      MAINTAIN_CARD = 'maintain_card'
+      ADD_CARD = 'add_card'
     end
   end
 end

data/lib/checkout_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CheckoutSdk
-  VERSION = '1.1.7'
+  VERSION = '1.2.0'
 end

data/lib/checkout_sdk.rb

@@ -9,6 +9,7 @@ require 'faraday/net_http'
 require 'faraday/follow_redirects'
 require 'mime/types'
 require 'logger'
+require 'ostruct'
 
 # Version
 require 'checkout_sdk/version'
@@ -20,6 +21,7 @@ require 'checkout_sdk/http_metadata'
 require 'checkout_sdk/checkout_utils'
 require 'checkout_sdk/platform_type'
 require 'checkout_sdk/environment'
+require 'checkout_sdk/environment_subdomain'
 require 'checkout_sdk/sdk_credentials'
 require 'checkout_sdk/sdk_authorization'
 require 'checkout_sdk/static_keys_sdk_credentials'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkout_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Checkout
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -220,6 +220,7 @@ files:
 - lib/checkout_sdk/disputes/disputes_client.rb
 - lib/checkout_sdk/disputes/disputes_query_filter.rb
 - lib/checkout_sdk/environment.rb
+- lib/checkout_sdk/environment_subdomain.rb
 - lib/checkout_sdk/error.rb
 - lib/checkout_sdk/events/events.rb
 - lib/checkout_sdk/events/events_client.rb
@@ -236,6 +237,8 @@ files:
 - lib/checkout_sdk/instruments/base_instruments_client.rb
 - lib/checkout_sdk/instruments/create/instrument.rb
 - lib/checkout_sdk/instruments/create/instrument_bank_account.rb
+- lib/checkout_sdk/instruments/create/instrument_data.rb
+- lib/checkout_sdk/instruments/create/instrument_sepa.rb
 - lib/checkout_sdk/instruments/create/instrument_token.rb
 - lib/checkout_sdk/instruments/get/bank_account_field_query.rb
 - lib/checkout_sdk/instruments/get/payment_network.rb
@@ -350,6 +353,7 @@ files:
 - lib/checkout_sdk/payments/product.rb
 - lib/checkout_sdk/payments/product_type.rb
 - lib/checkout_sdk/payments/refund_request.rb
+- lib/checkout_sdk/payments/reverse_request.rb
 - lib/checkout_sdk/payments/risk_request.rb
 - lib/checkout_sdk/payments/sender/corporate_sender.rb
 - lib/checkout_sdk/payments/sender/government_sender.rb
@@ -360,7 +364,12 @@ files:
 - lib/checkout_sdk/payments/sender/sender_type.rb
 - lib/checkout_sdk/payments/sender/source_of_funds.rb
 - lib/checkout_sdk/payments/sender/ticket.rb
+- lib/checkout_sdk/payments/sessions/card.rb
+- lib/checkout_sdk/payments/sessions/payment_method_configuration.rb
+- lib/checkout_sdk/payments/sessions/payment_methods_type.rb
 - lib/checkout_sdk/payments/sessions/payment_sessions_client.rb
+- lib/checkout_sdk/payments/sessions/payment_sessions_request.rb
+- lib/checkout_sdk/payments/sessions/store_payment_details_type.rb
 - lib/checkout_sdk/payments/shipping_details.rb
 - lib/checkout_sdk/payments/shipping_preference.rb
 - lib/checkout_sdk/payments/source/apm/after_pay_source.rb