connect-sdk-ruby 2.24.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 043d7b426f2d6ab34d0f1949f364643320c32fc7763f152521cff4a250607f80
-  data.tar.gz: f2a43f28b020e313336fe55417d20927e583009541f654d4e1936983b2aad571
+  metadata.gz: 5992bcc131f53b3ccada88fbd47649cae3d3e2b7a2f4e962d03b720284ec867b
+  data.tar.gz: 8176d72bdb8b2476334f1b4dee14ee5a3630aaf74d03832444bc4816dbaeb2eb
 SHA512:
-  metadata.gz: 17d3926d57355cf9824fea6a8e7f4477509d7ee002ec3ecfcd041a243eb7b4352a91d4accebdce7bd5c23cbe0acddeda591a7bffbef3ecb7e060215f695f1b59
-  data.tar.gz: d3dfb9d09d2b05df6239d9077ab75aeaa80908064c5e2aa05dbbd02ebbba25c179b9c28a6082fe595f76a4ab6198e6478dad30cc46b87723beee0cb79e95aef4
+  metadata.gz: 339b9d17f342797147b0cb27b957a0365f1c65d695ef4d709863654a989cbabac407c74865ea129b2316c7972b468435ef4d53fd63d39dfb1f8b25a25aa09c66
+  data.tar.gz: ed49a59d4903bdcffb408119dcb3e2448a0e13981c98a1dfa7ad42c3c3b0d15b8e1ee456305ed8577e51b3d404e4f625f790b747879316a3bc5ce4e7f7bec714

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '2.24.0'
+  spec.version        = '2.28.0'
   spec.authors        = ['Ingenico ePayments']
   spec.email          = ['github@epay.ingenico.com']
   spec.summary        = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}

data/examples/merchant/captures/create_refund_capture_example.rb

@@ -0,0 +1,54 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/api_exception'
+require 'ingenico/connect/sdk/declined_refund_exception'
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/refund/refund_references'
+require 'ingenico/connect/sdk/domain/refund/refund_request'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Refund = Ingenico::Connect::SDK::Domain::Refund
+
+def example
+  get_client do |client|
+    amount_of_money = Definitions::AmountOfMoney.new
+    amount_of_money.amount = 500
+    amount_of_money.currency_code = 'EUR'
+
+    refund_references = Refund::RefundReferences.new
+    refund_references.merchant_reference = 'AcmeOrder0001'
+
+    body = Refund::RefundRequest.new
+    body.amount_of_money = amount_of_money
+    body.refund_references = refund_references
+
+    begin
+      response = client.merchant('merchantId').captures.refund('captureId', body)
+    rescue Ingenico::Connect::SDK::DeclinedRefundException => e
+      handle_declined_refund(e.refund_result)
+    rescue Ingenico::Connect::SDK::ApiException => e
+      handle_api_errors(e.errors)
+    end
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end
+
+def handle_declined_refund(refund_result)
+  # handle the result here
+end
+
+def handle_api_errors(errors)
+  # handle the errors here
+end

data/examples/merchant/hostedcheckouts/delete_hosted_checkout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    client.merchant('merchantId').hostedcheckouts.delete('hostedCheckoutId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/lib/ingenico/connect/sdk/domain/definitions/card.rb

@@ -9,14 +9,18 @@ module Ingenico::Connect::SDK
     module Definitions
 
       # @attr [String] cvv
+      # @attr [String] partial_pin
       class Card < Ingenico::Connect::SDK::Domain::Definitions::CardWithoutCvv
 
         attr_accessor :cvv
 
+        attr_accessor :partial_pin
+
         # @return (Hash)
         def to_h
           hash = super
           hash['cvv'] = @cvv unless @cvv.nil?
+          hash['partialPin'] = @partial_pin unless @partial_pin.nil?
           hash
         end
 
@@ -25,6 +29,9 @@ module Ingenico::Connect::SDK
           if hash.has_key? 'cvv'
             @cvv = hash['cvv']
           end
+          if hash.has_key? 'partialPin'
+            @partial_pin = hash['partialPin']
+          end
         end
       end
     end

data/lib/ingenico/connect/sdk/domain/definitions/card_fraud_results.rb

@@ -5,6 +5,7 @@
 require 'ingenico/connect/sdk/domain/definitions/fraud_results'
 require 'ingenico/connect/sdk/domain/definitions/fraud_results_retail_decisions'
 require 'ingenico/connect/sdk/domain/definitions/fraugster_results'
+require 'ingenico/connect/sdk/domain/definitions/microsoft_fraud_results'
 
 module Ingenico::Connect::SDK
   module Domain
@@ -13,6 +14,7 @@ module Ingenico::Connect::SDK
       # @attr [String] avs_result
       # @attr [String] cvv_result
       # @attr [Ingenico::Connect::SDK::Domain::Definitions::FraugsterResults] fraugster
+      # @attr [Ingenico::Connect::SDK::Domain::Definitions::MicrosoftFraudResults] microsoft_fraud_protection
       # @attr [Ingenico::Connect::SDK::Domain::Definitions::FraudResultsRetailDecisions] retail_decisions
       class CardFraudResults < Ingenico::Connect::SDK::Domain::Definitions::FraudResults
 
@@ -22,6 +24,8 @@ module Ingenico::Connect::SDK
 
         attr_accessor :fraugster
 
+        attr_accessor :microsoft_fraud_protection
+
         attr_accessor :retail_decisions
 
         # @return (Hash)
@@ -30,6 +34,7 @@ module Ingenico::Connect::SDK
           hash['avsResult'] = @avs_result unless @avs_result.nil?
           hash['cvvResult'] = @cvv_result unless @cvv_result.nil?
           hash['fraugster'] = @fraugster.to_h unless @fraugster.nil?
+          hash['microsoftFraudProtection'] = @microsoft_fraud_protection.to_h unless @microsoft_fraud_protection.nil?
           hash['retailDecisions'] = @retail_decisions.to_h unless @retail_decisions.nil?
           hash
         end
@@ -46,6 +51,10 @@ module Ingenico::Connect::SDK
             raise TypeError, "value '%s' is not a Hash" % [hash['fraugster']] unless hash['fraugster'].is_a? Hash
             @fraugster = Ingenico::Connect::SDK::Domain::Definitions::FraugsterResults.new_from_hash(hash['fraugster'])
           end
+          if hash.has_key? 'microsoftFraudProtection'
+            raise TypeError, "value '%s' is not a Hash" % [hash['microsoftFraudProtection']] unless hash['microsoftFraudProtection'].is_a? Hash
+            @microsoft_fraud_protection = Ingenico::Connect::SDK::Domain::Definitions::MicrosoftFraudResults.new_from_hash(hash['microsoftFraudProtection'])
+          end
           if hash.has_key? 'retailDecisions'
             raise TypeError, "value '%s' is not a Hash" % [hash['retailDecisions']] unless hash['retailDecisions'].is_a? Hash
             @retail_decisions = Ingenico::Connect::SDK::Domain::Definitions::FraudResultsRetailDecisions.new_from_hash(hash['retailDecisions'])

data/lib/ingenico/connect/sdk/domain/definitions/microsoft_fraud_results.rb

@@ -0,0 +1,32 @@
+#
+# This class was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+#
+require 'ingenico/connect/sdk/data_object'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Definitions
+
+      # @attr [Integer] fraud_score
+      class MicrosoftFraudResults < Ingenico::Connect::SDK::DataObject
+
+        attr_accessor :fraud_score
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['fraudScore'] = @fraud_score unless @fraud_score.nil?
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key? 'fraudScore'
+            @fraud_score = hash['fraudScore']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/payment/abstract_three_d_secure.rb

@@ -19,6 +19,7 @@ module Ingenico::Connect::SDK
       # @attr [Ingenico::Connect::SDK::Domain::Payment::ThreeDSecureData] prior_three_d_secure_data
       # @attr [Ingenico::Connect::SDK::Domain::Payment::SdkDataInput] sdk_data
       # @attr [true/false] skip_authentication
+      # @attr [String] transaction_risk_level
       class AbstractThreeDSecure < Ingenico::Connect::SDK::DataObject
 
         attr_accessor :authentication_amount
@@ -37,6 +38,8 @@ module Ingenico::Connect::SDK
 
         attr_accessor :skip_authentication
 
+        attr_accessor :transaction_risk_level
+
         # @return (Hash)
         def to_h
           hash = super
@@ -48,6 +51,7 @@ module Ingenico::Connect::SDK
           hash['priorThreeDSecureData'] = @prior_three_d_secure_data.to_h unless @prior_three_d_secure_data.nil?
           hash['sdkData'] = @sdk_data.to_h unless @sdk_data.nil?
           hash['skipAuthentication'] = @skip_authentication unless @skip_authentication.nil?
+          hash['transactionRiskLevel'] = @transaction_risk_level unless @transaction_risk_level.nil?
           hash
         end
 
@@ -80,6 +84,9 @@ module Ingenico::Connect::SDK
           if hash.has_key? 'skipAuthentication'
             @skip_authentication = hash['skipAuthentication']
           end
+          if hash.has_key? 'transactionRiskLevel'
+            @transaction_risk_level = hash['transactionRiskLevel']
+          end
         end
       end
     end

data/lib/ingenico/connect/sdk/domain/payment/customer_account_authentication.rb

@@ -8,10 +8,13 @@ module Ingenico::Connect::SDK
   module Domain
     module Payment
 
+      # @attr [String] data
       # @attr [String] method
       # @attr [String] utc_timestamp
       class CustomerAccountAuthentication < Ingenico::Connect::SDK::DataObject
 
+        attr_accessor :data
+
         attr_accessor :method
 
         attr_accessor :utc_timestamp
@@ -19,6 +22,7 @@ module Ingenico::Connect::SDK
         # @return (Hash)
         def to_h
           hash = super
+          hash['data'] = @data unless @data.nil?
           hash['method'] = @method unless @method.nil?
           hash['utcTimestamp'] = @utc_timestamp unless @utc_timestamp.nil?
           hash
@@ -26,6 +30,9 @@ module Ingenico::Connect::SDK
 
         def from_hash(hash)
           super
+          if hash.has_key? 'data'
+            @data = hash['data']
+          end
           if hash.has_key? 'method'
             @method = hash['method']
           end

data/lib/ingenico/connect/sdk/domain/payment/order_line_details.rb

@@ -15,6 +15,7 @@ module Ingenico::Connect::SDK
       # @attr [String] product_code
       # @attr [String] product_name
       # @attr [Integer] product_price
+      # @attr [String] product_sku
       # @attr [String] product_type
       # @attr [Integer] quantity
       # @attr [Integer] tax_amount
@@ -35,6 +36,8 @@ module Ingenico::Connect::SDK
 
         attr_accessor :product_price
 
+        attr_accessor :product_sku
+
         attr_accessor :product_type
 
         attr_accessor :quantity
@@ -53,6 +56,7 @@ module Ingenico::Connect::SDK
           hash['productCode'] = @product_code unless @product_code.nil?
           hash['productName'] = @product_name unless @product_name.nil?
           hash['productPrice'] = @product_price unless @product_price.nil?
+          hash['productSku'] = @product_sku unless @product_sku.nil?
           hash['productType'] = @product_type unless @product_type.nil?
           hash['quantity'] = @quantity unless @quantity.nil?
           hash['taxAmount'] = @tax_amount unless @tax_amount.nil?
@@ -83,6 +87,9 @@ module Ingenico::Connect::SDK
           if hash.has_key? 'productPrice'
             @product_price = hash['productPrice']
           end
+          if hash.has_key? 'productSku'
+            @product_sku = hash['productSku']
+          end
           if hash.has_key? 'productType'
             @product_type = hash['productType']
           end

data/lib/ingenico/connect/sdk/merchant/captures/captures_client.rb

@@ -6,6 +6,8 @@ require 'ingenico/connect/sdk/api_resource'
 require 'ingenico/connect/sdk/response_exception'
 require 'ingenico/connect/sdk/domain/capture/capture_response'
 require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/refund/refund_error_response'
+require 'ingenico/connect/sdk/domain/refund/refund_response'
 
 module Ingenico::Connect::SDK
   module Merchant
@@ -49,6 +51,39 @@ module Ingenico::Connect::SDK
           error_object = @communicator.marshaller.unmarshal(e.body, error_type)
           raise create_exception(e.status_code, e.body, error_object, context)
         end
+
+        # Resource /!{merchantId}/captures/!{captureId}/refund - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/captures/refund.html Create Refund}
+        # @param capture_id [String]
+        # @param body       [Ingenico::Connect::SDK::Domain::Refund::RefundRequest]
+        # @param context    [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Refund::RefundResponse]
+        # @raise [Ingenico::Connect::SDK::DeclinedRefundException] if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception.
+        # @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+        # @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+        # @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+        # @raise [Ingenico::Connect::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+        #        or there was a conflict (HTTP status code 404, 409 or 410)
+        # @raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+        #        the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,
+        #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # @raise [Ingenico::Connect::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+        def refund(capture_id, body, context=nil)
+          path_context = {
+            'captureId'.freeze => capture_id,
+          }
+          uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}/refund', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Refund::RefundResponse,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
       end
     end
   end

data/lib/ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client.rb

@@ -78,6 +78,35 @@ module Ingenico::Connect::SDK
           error_object = @communicator.marshaller.unmarshal(e.body, error_type)
           raise create_exception(e.status_code, e.body, error_object, context)
         end
+
+        # Resource /!{merchantId}/hostedcheckouts/!{hostedCheckoutId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedcheckouts/delete.html Delete hosted checkout}
+        # @param hosted_checkout_id [String]
+        # @param context            [Ingenico::Connect::SDK::CallContext]
+        # @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+        # @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+        # @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+        # @raise [Ingenico::Connect::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+        #        or there was a conflict (HTTP status code 404, 409 or 410)
+        # @raise [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+        #        the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,
+        #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+        # @raise [Ingenico::Connect::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+        def delete(hosted_checkout_id, context=nil)
+          path_context = {
+            'hostedCheckoutId'.freeze => hosted_checkout_id,
+          }
+          uri = instantiate_uri('/v1/{merchantId}/hostedcheckouts/{hostedCheckoutId}', path_context)
+          return @communicator.delete(
+            uri,
+            client_headers,
+            nil,
+            nil,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
       end
     end
   end

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

@@ -7,7 +7,7 @@ module Ingenico::Connect::SDK
   #
   # @attr_reader [Array<Ingenico::Connect::SDK::RequestHeader>] meta_data_headers List of headers that should be used in all requests.
   class MetaDataProvider
-    @@SDK_VERSION = '2.24.0'
+    @@SDK_VERSION = '2.28.0'
     @@SERVER_META_INFO_HEADER = 'X-GCS-ServerMetaInfo'
     @@PROHIBITED_HEADERS = [@@SERVER_META_INFO_HEADER, 'X-GCS-Idempotence-Key',
                             'Date', 'Content-Type', 'Authorization'].sort!.freeze

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

@@ -47,11 +47,10 @@ module Ingenico::Connect::SDK
       if value.nil? || value.empty?
         return value
       end
-      # Replace all sequences of whitespace*-linebreak-whitespace* into a single linebreak-space
-      # This will ensure that:
-      # - no line ends with whitespace, because this causes authentication failures
-      # - each line starts with a single whitespace, so it is a valid header value
-      value.gsub(/[\s&&[^\r\n]]*(\r?\n)[\s&&[^\r\n]]*/, '\1 ')
+      # Replace all sequences of linebreak-whitespace* with a single linebreak-space
+      # This matches the normalization done by DefaultAuthenticator, and ensures that multiline headers
+      # will not cause authentication failures
+      value.gsub(/\r?\n[\s&&[^\r\n]]*/, ' ')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connect-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.28.0
 platform: ruby
 authors:
 - Ingenico ePayments
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -127,6 +127,7 @@ files:
 - README.md
 - Rakefile
 - connect-sdk-ruby.gemspec
+- examples/merchant/captures/create_refund_capture_example.rb
 - examples/merchant/captures/get_capture_example.rb
 - examples/merchant/disputes/cancel_dispute_example.rb
 - examples/merchant/disputes/get_dispute_example.rb
@@ -135,6 +136,7 @@ files:
 - examples/merchant/example_configuration.yml
 - examples/merchant/files/get_file_example.rb
 - examples/merchant/hostedcheckouts/create_hosted_checkout_example.rb
+- examples/merchant/hostedcheckouts/delete_hosted_checkout_example.rb
 - examples/merchant/hostedcheckouts/get_hosted_checkout_example.rb
 - examples/merchant/hostedmandatemanagements/create_hosted_mandate_management_example.rb
 - examples/merchant/hostedmandatemanagements/get_hosted_mandate_management_example.rb
@@ -249,6 +251,7 @@ files:
 - lib/ingenico/connect/sdk/domain/definitions/lodging_charge.rb
 - lib/ingenico/connect/sdk/domain/definitions/lodging_data.rb
 - lib/ingenico/connect/sdk/domain/definitions/lodging_room.rb
+- lib/ingenico/connect/sdk/domain/definitions/microsoft_fraud_results.rb
 - lib/ingenico/connect/sdk/domain/definitions/order_status_output.rb
 - lib/ingenico/connect/sdk/domain/definitions/payment_product_filter.rb
 - lib/ingenico/connect/sdk/domain/definitions/personal_name_base.rb