connect-sdk-ruby 2.28.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5992bcc131f53b3ccada88fbd47649cae3d3e2b7a2f4e962d03b720284ec867b
-  data.tar.gz: 8176d72bdb8b2476334f1b4dee14ee5a3630aaf74d03832444bc4816dbaeb2eb
+  metadata.gz: cf5846113a34444077709cdd1442d0e0ce79d53aafd628759e1b263b4e6377b2
+  data.tar.gz: 4340e5ca7922f121f5c36317945b55f4ea85c642d1c5eb8e63cce9b3356ddb92
 SHA512:
-  metadata.gz: 339b9d17f342797147b0cb27b957a0365f1c65d695ef4d709863654a989cbabac407c74865ea129b2316c7972b468435ef4d53fd63d39dfb1f8b25a25aa09c66
-  data.tar.gz: ed49a59d4903bdcffb408119dcb3e2448a0e13981c98a1dfa7ad42c3c3b0d15b8e1ee456305ed8577e51b3d404e4f625f790b747879316a3bc5ce4e7f7bec714
+  metadata.gz: 3f44ab2a432db832f597d63548ae2f28eb329af96fc32a571b0e1fe2b82f71ac0f5ea5b80fbfb25bd63b4baa906b4eef1b9cbae4f0545c72b14b6041bdb9429f
+  data.tar.gz: 5875974191b3326f5bdc3131429f31dea8379cf95738795a71074cb3512299b1916050655f62a18df57be98787906fada45b29a83d488034e8d2b16204d24fdb

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '2.28.0'
+  spec.version        = '2.29.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/services/get_settlement_details_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|
+    response = client.merchant('merchantId').services.settlementdetails('paymentId')
+  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/payment/cash_payment_method_specific_input.rb

@@ -5,6 +5,9 @@
 require 'ingenico/connect/sdk/domain/payment/abstract_cash_payment_method_specific_input'
 require 'ingenico/connect/sdk/domain/payment/cash_payment_product1503_specific_input'
 require 'ingenico/connect/sdk/domain/payment/cash_payment_product1504_specific_input'
+require 'ingenico/connect/sdk/domain/payment/cash_payment_product1506_specific_input'
+require 'ingenico/connect/sdk/domain/payment/cash_payment_product1508_specific_input'
+require 'ingenico/connect/sdk/domain/payment/cash_payment_product1511_specific_input'
 require 'ingenico/connect/sdk/domain/payment/cash_payment_product1521_specific_input'
 require 'ingenico/connect/sdk/domain/payment/cash_payment_product1522_specific_input'
 require 'ingenico/connect/sdk/domain/payment/cash_payment_product1523_specific_input'
@@ -17,6 +20,9 @@ module Ingenico::Connect::SDK
 
       # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1503SpecificInput] payment_product1503_specific_input
       # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1504SpecificInput] payment_product1504_specific_input
+      # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1506SpecificInput] payment_product1506_specific_input
+      # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1508SpecificInput] payment_product1508_specific_input
+      # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1511SpecificInput] payment_product1511_specific_input
       # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1521SpecificInput] payment_product1521_specific_input
       # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1522SpecificInput] payment_product1522_specific_input
       # @attr [Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1523SpecificInput] payment_product1523_specific_input
@@ -30,6 +36,12 @@ module Ingenico::Connect::SDK
 
         attr_accessor :payment_product1504_specific_input
 
+        attr_accessor :payment_product1506_specific_input
+
+        attr_accessor :payment_product1508_specific_input
+
+        attr_accessor :payment_product1511_specific_input
+
         attr_accessor :payment_product1521_specific_input
 
         attr_accessor :payment_product1522_specific_input
@@ -45,6 +57,9 @@ module Ingenico::Connect::SDK
           hash = super
           hash['paymentProduct1503SpecificInput'] = @payment_product1503_specific_input.to_h unless @payment_product1503_specific_input.nil?
           hash['paymentProduct1504SpecificInput'] = @payment_product1504_specific_input.to_h unless @payment_product1504_specific_input.nil?
+          hash['paymentProduct1506SpecificInput'] = @payment_product1506_specific_input.to_h unless @payment_product1506_specific_input.nil?
+          hash['paymentProduct1508SpecificInput'] = @payment_product1508_specific_input.to_h unless @payment_product1508_specific_input.nil?
+          hash['paymentProduct1511SpecificInput'] = @payment_product1511_specific_input.to_h unless @payment_product1511_specific_input.nil?
           hash['paymentProduct1521SpecificInput'] = @payment_product1521_specific_input.to_h unless @payment_product1521_specific_input.nil?
           hash['paymentProduct1522SpecificInput'] = @payment_product1522_specific_input.to_h unless @payment_product1522_specific_input.nil?
           hash['paymentProduct1523SpecificInput'] = @payment_product1523_specific_input.to_h unless @payment_product1523_specific_input.nil?
@@ -63,6 +78,18 @@ module Ingenico::Connect::SDK
             raise TypeError, "value '%s' is not a Hash" % [hash['paymentProduct1504SpecificInput']] unless hash['paymentProduct1504SpecificInput'].is_a? Hash
             @payment_product1504_specific_input = Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1504SpecificInput.new_from_hash(hash['paymentProduct1504SpecificInput'])
           end
+          if hash.has_key? 'paymentProduct1506SpecificInput'
+            raise TypeError, "value '%s' is not a Hash" % [hash['paymentProduct1506SpecificInput']] unless hash['paymentProduct1506SpecificInput'].is_a? Hash
+            @payment_product1506_specific_input = Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1506SpecificInput.new_from_hash(hash['paymentProduct1506SpecificInput'])
+          end
+          if hash.has_key? 'paymentProduct1508SpecificInput'
+            raise TypeError, "value '%s' is not a Hash" % [hash['paymentProduct1508SpecificInput']] unless hash['paymentProduct1508SpecificInput'].is_a? Hash
+            @payment_product1508_specific_input = Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1508SpecificInput.new_from_hash(hash['paymentProduct1508SpecificInput'])
+          end
+          if hash.has_key? 'paymentProduct1511SpecificInput'
+            raise TypeError, "value '%s' is not a Hash" % [hash['paymentProduct1511SpecificInput']] unless hash['paymentProduct1511SpecificInput'].is_a? Hash
+            @payment_product1511_specific_input = Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1511SpecificInput.new_from_hash(hash['paymentProduct1511SpecificInput'])
+          end
           if hash.has_key? 'paymentProduct1521SpecificInput'
             raise TypeError, "value '%s' is not a Hash" % [hash['paymentProduct1521SpecificInput']] unless hash['paymentProduct1521SpecificInput'].is_a? Hash
             @payment_product1521_specific_input = Ingenico::Connect::SDK::Domain::Payment::CashPaymentProduct1521SpecificInput.new_from_hash(hash['paymentProduct1521SpecificInput'])

data/lib/ingenico/connect/sdk/domain/payment/cash_payment_product1506_specific_input.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 Payment
+
+      # @attr [String] return_url
+      class CashPaymentProduct1506SpecificInput < Ingenico::Connect::SDK::DataObject
+
+        attr_accessor :return_url
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['returnUrl'] = @return_url unless @return_url.nil?
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key? 'returnUrl'
+            @return_url = hash['returnUrl']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/payment/cash_payment_product1508_specific_input.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 Payment
+
+      # @attr [String] return_url
+      class CashPaymentProduct1508SpecificInput < Ingenico::Connect::SDK::DataObject
+
+        attr_accessor :return_url
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['returnUrl'] = @return_url unless @return_url.nil?
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key? 'returnUrl'
+            @return_url = hash['returnUrl']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/payment/cash_payment_product1511_specific_input.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 Payment
+
+      # @attr [String] return_url
+      class CashPaymentProduct1511SpecificInput < Ingenico::Connect::SDK::DataObject
+
+        attr_accessor :return_url
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['returnUrl'] = @return_url unless @return_url.nil?
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key? 'returnUrl'
+            @return_url = hash['returnUrl']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/domain/services/settlement_details.rb

@@ -0,0 +1,55 @@
+#
+# 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'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Services
+
+      # @attr [String] acquirer_reference_number
+      # @attr [Ingenico::Connect::SDK::Domain::Definitions::AmountOfMoney] amount_of_money
+      # @attr [String] payment_id
+      # @attr [String] retrieval_reference_number
+      class SettlementDetails < Ingenico::Connect::SDK::DataObject
+
+        attr_accessor :acquirer_reference_number
+
+        attr_accessor :amount_of_money
+
+        attr_accessor :payment_id
+
+        attr_accessor :retrieval_reference_number
+
+        # @return (Hash)
+        def to_h
+          hash = super
+          hash['acquirerReferenceNumber'] = @acquirer_reference_number unless @acquirer_reference_number.nil?
+          hash['amountOfMoney'] = @amount_of_money.to_h unless @amount_of_money.nil?
+          hash['paymentId'] = @payment_id unless @payment_id.nil?
+          hash['retrievalReferenceNumber'] = @retrieval_reference_number unless @retrieval_reference_number.nil?
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key? 'acquirerReferenceNumber'
+            @acquirer_reference_number = hash['acquirerReferenceNumber']
+          end
+          if hash.has_key? 'amountOfMoney'
+            raise TypeError, "value '%s' is not a Hash" % [hash['amountOfMoney']] unless hash['amountOfMoney'].is_a? Hash
+            @amount_of_money = Ingenico::Connect::SDK::Domain::Definitions::AmountOfMoney.new_from_hash(hash['amountOfMoney'])
+          end
+          if hash.has_key? 'paymentId'
+            @payment_id = hash['paymentId']
+          end
+          if hash.has_key? 'retrievalReferenceNumber'
+            @retrieval_reference_number = hash['retrievalReferenceNumber']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/merchant/services/services_client.rb

@@ -9,6 +9,7 @@ require 'ingenico/connect/sdk/domain/services/bank_details_response'
 require 'ingenico/connect/sdk/domain/services/convert_amount'
 require 'ingenico/connect/sdk/domain/services/get_iin_details_response'
 require 'ingenico/connect/sdk/domain/services/get_privacy_policy_response'
+require 'ingenico/connect/sdk/domain/services/settlement_details'
 require 'ingenico/connect/sdk/domain/services/test_connection'
 
 module Ingenico::Connect::SDK
@@ -159,6 +160,36 @@ 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}/services/settlementdetails/!{paymentId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/services/settlementdetails.html Get Settlement details}
+        # @param payment_id [String]
+        # @param context    [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Services::SettlementDetails]
+        # @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 settlementdetails(payment_id, context=nil)
+          path_context = {
+            'paymentId'.freeze => payment_id,
+          }
+          uri = instantiate_uri('/v1/{merchantId}/services/settlementdetails/{paymentId}', path_context)
+          return @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Connect::SDK::Domain::Services::SettlementDetails,
+            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.28.0'
+    @@SDK_VERSION = '2.29.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/spec/integration/idempotence_spec.rb

@@ -10,6 +10,7 @@ require 'ingenico/connect/sdk/domain/payment/order'
 require 'ingenico/connect/sdk/domain/payment/redirect_payment_product809_specific_input'
 require 'ingenico/connect/sdk/domain/payment/redirect_payment_method_specific_input'
 require 'ingenico/connect/sdk/call_context'
+require 'ingenico/connect/sdk/declined_payment_exception'
 
 describe 'Idempotence with the server' do
 
@@ -41,17 +42,31 @@ describe 'Idempotence with the server' do
     context = Ingenico::Connect::SDK::CallContext.new(idempotence_key)
 
     Integration.init_client(false) do |client|
-      response = client.merchant(Integration::MERCHANT_ID).payments.create(body, context)
-      payment_id = response.payment.id
+      def do_create_payment(client, body, context)
+        # For this test it doesn't matter if the response is successful or declined,
+        # as long as idempotence is handled correctly
+        begin
+          client.merchant(Integration::MERCHANT_ID).payments.create(body, context)
+        rescue Ingenico::Connect::SDK::DeclinedPaymentException => ex
+          ex.payment_result
+        end
+      end
+
+      result = do_create_payment(client, body, context)
+      payment_id = result.payment.id
+      status = result.payment.status
 
       expect(payment_id).to_not be_nil
+      expect(status).to_not be_nil
       expect(context.idempotence_key).to eq(idempotence_key)
       expect(context.idempotence_request_timestamp).to be_nil
 
-      response_2 = client.merchant(Integration::MERCHANT_ID).payments.create(body, context)
-      payment_id2 = response_2.payment.id
+      result_2 = do_create_payment(client, body, context)
+      payment_id2 = result_2.payment.id
+      status2 = result_2.payment.status
 
-      expect(payment_id).to eq(payment_id2)
+      expect(payment_id2).to eq(payment_id)
+      expect(status2).to eq(status)
       expect(context.idempotence_key).to eq(idempotence_key)
       expect(context.idempotence_request_timestamp).to_not be_nil
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connect-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.29.0
 platform: ruby
 authors:
 - Ingenico ePayments
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -189,6 +189,7 @@ files:
 - examples/merchant/services/convert_amount_example.rb
 - examples/merchant/services/convert_bank_account_example.rb
 - examples/merchant/services/get_privacy_policy_example.rb
+- examples/merchant/services/get_settlement_details_example.rb
 - examples/merchant/services/iin_details_example.rb
 - examples/merchant/services/test_connection_example.rb
 - examples/merchant/sessions/create_session_example.rb
@@ -339,6 +340,9 @@ files:
 - lib/ingenico/connect/sdk/domain/payment/cash_payment_method_specific_output.rb
 - lib/ingenico/connect/sdk/domain/payment/cash_payment_product1503_specific_input.rb
 - lib/ingenico/connect/sdk/domain/payment/cash_payment_product1504_specific_input.rb
+- lib/ingenico/connect/sdk/domain/payment/cash_payment_product1506_specific_input.rb
+- lib/ingenico/connect/sdk/domain/payment/cash_payment_product1508_specific_input.rb
+- lib/ingenico/connect/sdk/domain/payment/cash_payment_product1511_specific_input.rb
 - lib/ingenico/connect/sdk/domain/payment/cash_payment_product1521_specific_input.rb
 - lib/ingenico/connect/sdk/domain/payment/cash_payment_product1522_specific_input.rb
 - lib/ingenico/connect/sdk/domain/payment/cash_payment_product1523_specific_input.rb
@@ -548,6 +552,7 @@ files:
 - lib/ingenico/connect/sdk/domain/services/get_privacy_policy_response.rb
 - lib/ingenico/connect/sdk/domain/services/iin_detail.rb
 - lib/ingenico/connect/sdk/domain/services/payment_context.rb
+- lib/ingenico/connect/sdk/domain/services/settlement_details.rb
 - lib/ingenico/connect/sdk/domain/services/swift.rb
 - lib/ingenico/connect/sdk/domain/services/test_connection.rb
 - lib/ingenico/connect/sdk/domain/sessions/payment_product_filters_client_session.rb