connect-sdk-ruby 2.45.0 → 2.46.0

data/examples/merchant/sessions/create_session_example.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/factory'
 require 'ingenico/connect/sdk/domain/sessions/session_request'

data/examples/merchant/tokens/approve_sepa_direct_debit_token_example.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/factory'
 require 'ingenico/connect/sdk/domain/token/approve_token_request'

data/examples/merchant/tokens/create_token_example.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/factory'
 require 'ingenico/connect/sdk/domain/definitions/address'

data/examples/merchant/tokens/delete_token_example.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/factory'
 require 'ingenico/connect/sdk/merchant/tokens/delete_token_params'

data/examples/merchant/tokens/get_token_example.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/factory'
 

data/examples/merchant/tokens/update_token_example.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/factory'
 require 'ingenico/connect/sdk/domain/definitions/address'

data/lib/ingenico/connect/sdk/api_exception.rb

@@ -1,50 +1,53 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Base class for many exceptions raised by the SDK.
+      # It is raised when an error response is received from the Ingenico ePayments platform.
+      # It contains data about the returned response.
+      #
+      # @attr_reader [Integer] status_code   HTTP status code of the returned response.
+      # @attr_reader [String]  response_body Message body of the returned response.
+      # @attr_reader [String]  error_id      An error id corresponding to the error that occurred, if available.
+      # @attr_reader [Array<Ingenico::Connect::SDK::Domain::Errors::APIError>] errors A list of errors received from the Ingenico ePayments platform;
+      #              may be empty but never _nil_
+      class ApiException < RuntimeError
 
-  # Base class for many exceptions raised by the SDK.
-  # It is raised when an error response is received from the Ingenico ePayments platform.
-  # It contains data about the returned response.
-  #
-  # @attr_reader [Integer] status_code   HTTP status code of the returned response.
-  # @attr_reader [String]  response_body Message body of the returned response.
-  # @attr_reader [String]  error_id      An error id corresponding to the error that occurred, if available.
-  # @attr_reader [Array<Ingenico::Connect::SDK::Domain::Errors::APIError>] errors A list of errors received from the Ingenico ePayments platform;
-  #              may be empty but never _nil_
-  class ApiException < RuntimeError
+        # Creates a new ApiException that reports an error response from the Ingenico ePayments platform.
+        #
+        # @param status_code   (Integer) HTTP status code the response
+        # @param response_body (String) HTTP response body
+        # @param error_id      (String) error id of the error, may be _nil_
+        # @param errors        (Array<Ingenico::Connect::SDK::Domain::Errors::APIError>) a list of errors that occurred, may be empty
+        # @param message       (String) error message to include
+        def initialize(status_code, response_body, error_id, errors,
+                       message = 'the Ingenico ePayments platform returned an error response')
+          super(message)
+          @status_code = status_code
+          @response_body = response_body
+          @error_id = error_id
+          if errors.nil?
+            @errors = [].freeze
+          else
+            @errors = errors
+          end
+        end
 
-    # Creates a new ApiException that reports an error response from the Ingenico ePayments platform.
-    #
-    # @param status_code   (Integer) HTTP status code the response
-    # @param response_body (String) HTTP response body
-    # @param error_id      (String) error id of the error, may be _nil_
-    # @param errors        (Array<Ingenico::Connect::SDK::Domain::Errors::APIError>) a list of errors that occurred, may be empty
-    # @param message       (String) error message to include
-    def initialize(status_code, response_body, error_id, errors,
-                   message='the Ingenico ePayments platform returned an error response')
-      super(message)
-      @status_code = status_code
-      @response_body = response_body
-      @error_id = error_id
-      if errors.nil?
-        @errors = [].freeze
-      else
-        @errors = errors
-      end
-    end
+        attr_reader :status_code
+        attr_reader :response_body
+        attr_reader :error_id
+        attr_reader :errors
 
-    attr_reader :status_code
-    attr_reader :response_body
-    attr_reader :error_id
-    attr_reader :errors
-
-    def to_s
-      str = super.to_s
-      if @status_code > 0
-        str += '; status_code=' + @status_code.to_s
-      end
-      if !@response_body.nil? && @response_body.length > 0
-        str += "; response_body='" + @response_body + "'"
+        def to_s
+          str = super.to_s
+          if @status_code > 0
+            str += '; status_code=' + @status_code.to_s
+          end
+          if !@response_body.nil? && @response_body.length > 0
+            str += "; response_body='" + @response_body + "'"
+          end
+          str.to_s
+        end
       end
-      str.to_s
     end
   end
 end

data/lib/ingenico/connect/sdk/api_resource.rb

@@ -1,127 +1,144 @@
+require 'ingenico/connect/sdk/api_exception'
+require 'ingenico/connect/sdk/authorization_exception'
+require 'ingenico/connect/sdk/declined_payment_exception'
+require 'ingenico/connect/sdk/declined_payout_exception'
+require 'ingenico/connect/sdk/declined_refund_exception'
 require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/payment/payment_error_response'
+require 'ingenico/connect/sdk/domain/payout/payout_error_response'
+require 'ingenico/connect/sdk/domain/refund/refund_error_response'
+require 'ingenico/connect/sdk/global_collect_exception'
+require 'ingenico/connect/sdk/idempotence_exception'
+require 'ingenico/connect/sdk/reference_exception'
+require 'ingenico/connect/sdk/request_header'
+require 'ingenico/connect/sdk/validation_exception'
 
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Base class of all Ingenico ePayments platform API resources.
+      # Provides shared functionality to facilitate communication with the Ingenico ePayments platform.
+      #
+      # @attr_reader [Ingenico::Connect::SDK::Communicator] communicator Communicator instance that provides communication with the Ingenico ePayments platform.
+      # @attr_reader [String] client_meta_info JSON string containing client info specific to the current client.
+      class ApiResource
 
-  # Base class of all Ingenico ePayments platform API resources.
-  # Provides shared functionality to facilitate communication with the Ingenico ePayments platform.
-  #
-  # @attr_reader [Ingenico::Connect::SDK::Communicator] communicator Communicator instance that provides communication with the Ingenico ePayments platform.
-  # @attr_reader [String] client_meta_info JSON string containing client info specific to the current client.
-  class ApiResource
-
-    # Creates a new ApiResource.
-    #
-    # @param arg              [Ingenico::Connect::SDK::ApiResource, Ingenico::Connect::SDK::Communicator] parent class or Communicator instance.
-    #                         If a parent class is given its communicator will be used for communication.
-    # @param path_context     [Hash] hash that contains substitutions for generic locations in the URL path.
-    #                         This hash will be used to instantiate a concrete URL used to access specific resources.
-    #                         For example in the URL https://eu.sandbox.api-ingenico.com/!{version}/!{merchantId}/payments
-    #                         !{version} and !{merchantId} can be instantiated using the hash
-    #                         !{'version' => 'v1', 'merchantId' => '1234'}. The final URL in this case will be
-    #                         https://eu.sandbox.api-ingenico.com/v1/1234/payments.
-    # @param client_meta_info [String] JSON string containing the meta data for the client.
-    def initialize(arg, path_context, client_meta_info=false)
-      if client_meta_info == false
-        if arg.nil?
-          raise ArgumentError.new('parent is required')
-        end
-        @parent = arg
-        @communicator = arg.communicator
-        @path_context = path_context
-        @client_meta_info = arg.client_meta_info
-      else
-        if arg.nil?
-          raise ArgumentError.new('communicator is required')
+        # Creates a new ApiResource.
+        #
+        # @param arg              [Ingenico::Connect::SDK::ApiResource, Ingenico::Connect::SDK::Communicator] parent class or Communicator instance.
+        #                         If a parent class is given its communicator will be used for communication.
+        # @param path_context     [Hash] hash that contains substitutions for generic locations in the URL path.
+        #                         This hash will be used to instantiate a concrete URL used to access specific resources.
+        #                         For example in the URL https://eu.sandbox.api-ingenico.com/!{version}/!{merchantId}/payments
+        #                         !{version} and !{merchantId} can be instantiated using the hash
+        #                         !{'version' => 'v1', 'merchantId' => '1234'}. The final URL in this case will be
+        #                         https://eu.sandbox.api-ingenico.com/v1/1234/payments.
+        # @param client_meta_info [String] JSON string containing the meta data for the client.
+        def initialize(arg, path_context, client_meta_info = false)
+          if client_meta_info == false
+            if arg.nil?
+              raise ArgumentError.new('parent is required')
+            end
+            @parent = arg
+            @communicator = arg.communicator
+            @path_context = path_context
+            @client_meta_info = arg.client_meta_info
+          else
+            if arg.nil?
+              raise ArgumentError.new('communicator is required')
+            end
+            @parent = nil
+            @communicator = arg
+            @path_context = path_context
+            @client_meta_info = client_meta_info
+          end
         end
-        @parent = nil
-        @communicator = arg
-        @path_context = path_context
-        @client_meta_info = client_meta_info
-      end
-    end
 
-    attr_reader :communicator
-    attr_reader :client_meta_info
+        attr_reader :communicator
+        attr_reader :client_meta_info
 
-    protected
+        protected
 
-    # @return [String] the X-GCS-ClientMetaInfo header as an [Array<Ingenico::Connect::SDK::RequestHeader>]
-    def client_headers
-      if @client_meta_info.nil?
-        nil
-      else
-        [RequestHeader.new('X-GCS-ClientMetaInfo', @client_meta_info)]
-      end
-    end
+        # @return [Array<Ingenico::Connect::SDK::RequestHeader>, nil] the client headers,
+        #         including the X-GCS-ClientMetaInfo header if meta data for the client is available
+        def client_headers
+          if @client_meta_info.nil?
+            nil
+          else
+            [RequestHeader.new('X-GCS-ClientMetaInfo', @client_meta_info)]
+          end
+        end
 
-    def instantiate_uri(uri, path_context=false)
-      if path_context == false
-        uri = replace_all(uri, @path_context)
-        unless @parent.nil?
-          uri = @parent.instantiate_uri(uri)
+        def instantiate_uri(uri, path_context = false)
+          if path_context == false
+            uri = replace_all(uri, @path_context)
+            unless @parent.nil?
+              uri = @parent.instantiate_uri(uri)
+            end
+            uri
+          else
+            uri = replace_all(uri, path_context)
+            instantiate_uri(uri)
+          end
         end
-        uri
-      else
-        uri = replace_all(uri, path_context)
-        instantiate_uri(uri)
-      end
-    end
 
-    def create_exception(status_code, response_body, error_object, context)
-      if error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) && !error_object.payment_result.nil?
-        return DeclinedPaymentException.new(status_code, response_body, error_object)
-      elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) && !error_object.payout_result.nil?
-        return DeclinedPayoutException.new(status_code, response_body, error_object)
-      elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) && !error_object.refund_result.nil?
-        return DeclinedRefundException.new(status_code, response_body, error_object)
-      end
-      if !(error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) ||
-        error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) ||
-        error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) ||
-        error_object.is_a?(Ingenico::Connect::SDK::Domain::Errors::ErrorResponse))
-        raise ArgumentError.new("unsupported error object type: " + error_object.class.name)
-      else
-        error_id = error_object.error_id
-        errors = error_object.errors
-      end
-      case status_code
-        when 400
-           return ValidationException.new(status_code, response_body, error_id, errors)
-        when 403
-          return AuthorizationException.new(status_code, response_body, error_id, errors)
-        when 404, 410
-          return ReferenceException.new(status_code, response_body, error_id, errors)
-        when 409
-          if is_idempotence_error(errors, context)
-            idempotence_key = context.idempotence_key
-            idempotence_request_timestamp = context.idempotence_request_timestamp
-            return IdempotenceException.new(status_code, response_body, error_id,
-                                            errors, idempotence_key,
-                                            idempotence_request_timestamp)
+        def create_exception(status_code, response_body, error_object, context)
+          if error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) && !error_object.payment_result.nil?
+            return DeclinedPaymentException.new(status_code, response_body, error_object)
+          elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) && !error_object.payout_result.nil?
+            return DeclinedPayoutException.new(status_code, response_body, error_object)
+          elsif error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) && !error_object.refund_result.nil?
+            return DeclinedRefundException.new(status_code, response_body, error_object)
+          end
+          if !(error_object.is_a?(Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse) ||
+            error_object.is_a?(Ingenico::Connect::SDK::Domain::Payout::PayoutErrorResponse) ||
+            error_object.is_a?(Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse) ||
+            error_object.is_a?(Ingenico::Connect::SDK::Domain::Errors::ErrorResponse))
+            raise ArgumentError.new("unsupported error object type: " + error_object.class.name)
           else
+            error_id = error_object.error_id
+            errors = error_object.errors
+          end
+          case status_code
+          when 400
+            return ValidationException.new(status_code, response_body, error_id, errors)
+          when 403
+            return AuthorizationException.new(status_code, response_body, error_id, errors)
+          when 404, 410
             return ReferenceException.new(status_code, response_body, error_id, errors)
+          when 409
+            if is_idempotence_error(errors, context)
+              idempotence_key = context.idempotence_key
+              idempotence_request_timestamp = context.idempotence_request_timestamp
+              return IdempotenceException.new(status_code, response_body, error_id,
+                                              errors, idempotence_key,
+                                              idempotence_request_timestamp)
+            else
+              return ReferenceException.new(status_code, response_body, error_id, errors)
+            end
+          when 500, 502, 503
+            return GlobalCollectException.new(status_code, response_body, error_id, errors)
+          else
+            return ApiException.new(status_code, response_body, error_id, errors)
           end
-        when 500, 502, 503
-          return GlobalCollectException.new(status_code, response_body, error_id, errors)
-        else
-          return ApiException.new(status_code, response_body, error_id, errors)
-      end
-    end
+        end
 
-    private
+        private
 
-    def replace_all(uri, path_context)
-      unless path_context.nil?
-        path_context.each do |key, value|
-          uri = uri.gsub('{' + key + '}', value)
+        def replace_all(uri, path_context)
+          unless path_context.nil?
+            path_context.each do |key, value|
+              uri = uri.gsub('{' + key + '}', value)
+            end
+          end
+          uri
         end
-      end
-      uri
-    end
 
-    def is_idempotence_error(errors, context)
-      !context.nil? && !context.idempotence_key.nil? && errors.length == 1 &&
-          errors[0].code == '1409'
+        def is_idempotence_error(errors, context)
+          !context.nil? && !context.idempotence_key.nil? && errors.length == 1 &&
+            errors[0].code == '1409'
+        end
+      end
     end
   end
 end

data/lib/ingenico/connect/sdk/authenticator.rb

@@ -1,16 +1,19 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Abstract class that is responsible for authenticating requests sent to the Ingenico ePayments platform.
+      class Authenticator
 
-  # Abstract class that is responsible for authenticating requests sent to the Ingenico ePayments platform.
-  class Authenticator
-
-    # Creates a signature to authenticate a request.
-    #
-    # @param http_method     [String] 'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
-    # @param resource_uri    [URI::HTTP] URI object that includes #path and #query of the URL that will be used, #query may be *nil*
-    # @param request_headers [Array<Ingenico::Connect::SDK::RequestHeader>] all headers used by the request
-    # @return [String] the created signature
-    def create_simple_authentication_signature(http_method, resource_uri, request_headers)
-      raise NotImplementedError
+        # Creates a signature to authenticate a request.
+        #
+        # @param http_method     [String] 'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
+        # @param resource_uri    [URI::HTTP] URI object that includes #path and #query of the URL that will be used, #query may be *nil*
+        # @param request_headers [Array<Ingenico::Connect::SDK::RequestHeader>] all headers used by the request
+        # @return [String] the created signature
+        def create_simple_authentication_signature(http_method, resource_uri, request_headers)
+          raise NotImplementedError
+        end
+      end
     end
   end
 end

data/lib/ingenico/connect/sdk/authorization_exception.rb

@@ -1,13 +1,18 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/api_exception'
 
-  # This exception is thrown when a request sent to the Ingenico ePayments platform is not correctly authenticated.
-  # Corresponds to a HTTP status code of 403.
-  # @see ApiException#initialize
-  class AuthorizationException < ApiException
+module Ingenico
+  module Connect
+    module SDK
+      # This exception is thrown when a request sent to the Ingenico ePayments platform is not correctly authenticated.
+      # Corresponds to a HTTP status code of 403.
+      # @see ApiException#initialize
+      class AuthorizationException < ApiException
 
-    def initialize(status_code, response_body, error_id, errors,
-                   message='the Ingenico ePayments platform returned an authorization error response')
-      super(status_code, response_body, error_id, errors, message)
+        def initialize(status_code, response_body, error_id, errors,
+                       message = 'the Ingenico ePayments platform returned an authorization error response')
+          super(status_code, response_body, error_id, errors, message)
+        end
+      end
     end
   end
 end

data/lib/ingenico/connect/sdk/call_context.rb

@@ -1,26 +1,29 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # A CallContext is used to identify requests and manage idempotent requests.
+      # A CallContext contains the following:
+      #
+      # idempotence_key::               A randomly generated key used to identify requests
+      # idempotence_request_timestamp:: If a previous request arrived with the same idempotence key,
+      #                                 this value will be set to a timestamp of that request.
+      #
+      # @attr_reader [String] idempotence_key The idempotence key used to identify this request.
+      #              If two requests share the same _idempotence_key_, they are considered to be the same request
+      #              and only the first request will be processed.
+      # @attr        [Integer] idempotence_request_timestamp If two or more requests arrive at the Ingenico ePayments platform with the same _idempotence_key_,
+      #              the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
+      class CallContext
+        @idempotence_request_timestamp = nil
+        @idempotence_key = nil
 
-  # A CallContext is used to identify requests and manage idempotent requests.
-  # A CallContext contains the following:
-  #
-  # idempotence_key::               A randomly generated key used to identify requests
-  # idempotence_request_timestamp:: If a previous request arrived with the same idempotence key,
-  #                                 this value will be set to a timestamp of that request.
-  #
-  # @attr_reader [String] idempotence_key The idempotence key used to identify this request.
-  #              If two requests share the same _idempotence_key_, they are considered to be the same request
-  #              and only the first request will be processed.
-  # @attr        [Integer] idempotence_request_timestamp If two or more requests arrive at the Ingenico ePayments platform with the same _idempotence_key_,
-  #              the _idempotence_request_timestamp_ will be set to the arrival time of the first of these requests.
-  class CallContext
-    @idempotence_request_timestamp = nil
-    @idempotence_key = nil
+        def initialize(idempotence_key = nil)
+          @idempotence_key = idempotence_key
+        end
 
-    def initialize(idempotence_key=nil)
-      @idempotence_key = idempotence_key
+        attr_reader :idempotence_key
+        attr_accessor :idempotence_request_timestamp
+      end
     end
-
-    attr_reader :idempotence_key
-    attr_accessor :idempotence_request_timestamp
   end
 end

data/lib/ingenico/connect/sdk/client.rb

@@ -1,18 +1,17 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
+require 'base64'
 require 'ingenico/connect/sdk/api_resource'
 require 'ingenico/connect/sdk/data_object'
 require 'ingenico/connect/sdk/logging/logging_capable'
 require 'ingenico/connect/sdk/logging/obfuscation/obfuscation_capable'
 require 'ingenico/connect/sdk/merchant/merchant_client'
-require 'base64'
 
 module Ingenico
   module Connect
     module SDK
-
       # Ingenico ePayments platform client.
       #
       # This client and all its child clients are bound to one specific value for the X-GCS-ClientMetaInfo header.
@@ -31,7 +30,7 @@ module Ingenico
 
         # @param communicator     [Ingenico::Connect::SDK::Communicator]
         # @param client_meta_info [String]
-        def initialize(communicator, client_meta_info=nil)
+        def initialize(communicator, client_meta_info = nil)
           super(communicator, nil, client_meta_info)
         end
 

data/lib/ingenico/connect/sdk/communication_exception.rb

@@ -1,16 +1,19 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # This exception is used when an error occurs during network communication with the Ingenico ePayments platform.
+      # A common cause is a timeout while connecting or when receiving or sending data.
+      #
+      # @attr [Exception] cause The error that is the cause of this error.
+      class CommunicationException < RuntimeError
 
-  # This exception is used when an error occurs during network communication with the Ingenico ePayments platform.
-  # A common cause is a timeout while connecting or when receiving or sending data.
-  #
-  # @attr [Exception] cause The error that is the cause of this error.
-  class CommunicationException < RuntimeError
+        def initialize(cause)
+          super()
+          @cause = cause
+        end
 
-    def initialize(cause)
-      super()
-      @cause = cause
+        attr_accessor :cause
+      end
     end
-
-    attr_accessor :cause
   end
 end