connect-sdk-ruby 2.27.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2798c5d39921f22d03617bb7cf0f0a81699f03213ccea239435b7df0d653622
-  data.tar.gz: 65705c989125db972832f10f33ab89fedc60a0a9008bb26a7c906e7f3e48236b
+  metadata.gz: 5992bcc131f53b3ccada88fbd47649cae3d3e2b7a2f4e962d03b720284ec867b
+  data.tar.gz: 8176d72bdb8b2476334f1b4dee14ee5a3630aaf74d03832444bc4816dbaeb2eb
 SHA512:
-  metadata.gz: 06f8b88f9c280b6ca7126f957ce729fa173996dc217189133e3d33a1ce21e53040739b1cc1622397b101ff2322b5f40d641bf29efbac8df2e1be37208f1a803f
-  data.tar.gz: fae6f33f53e2728ada47a8f3963b03936935d427468e511dc7cacb35015b2d29fdbd398f75f576227c58b34bdde28863ed47b820f0be1637b24f04554ee7b3d9
+  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.27.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/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/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.27.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connect-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.27.0
+  version: 2.28.0
 platform: ruby
 authors:
 - Ingenico ePayments
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 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