connect-sdk-ruby 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 842ad98aeb38bf84bf8d98cb729ef376dc348c550d87ac6761665ff4a8dc112b
-  data.tar.gz: 9cdcb0612d726f67703a89af0531849b2244e9629d5d86f58b317cfdf0a894ca
+  metadata.gz: 683a41961601e3d9f122c7cba1e98ee3da897425fd7a11238679ca08385c4575
+  data.tar.gz: a90404dc3d37afb897ff6bc0dab79088a39a57cc92c81563bc8e907bd3b2bdfd
 SHA512:
-  metadata.gz: c7c506fa4b3a7b861b5cb058f1b1cd1a826624bad69048e238871af54023619fec4d3cc5c26bcc085b38bf7cdf89cb195dad9f5b43c6ab1860004e37bf1a0371
-  data.tar.gz: 5732708f4833696a1272421991f6afc27a64dd4860fac899dfed6946fd5af9b4f06f6f239efa529d85ae8f87fb1f2cfd4f9f995d7c56bccc55067b37903a02f2
+  metadata.gz: e5e6e97d691da7fc6f707365d6e1f5c183f87d76eaf8ea116f793f0dfdad36712a97c78640ad5b756ccd72b1d9ce73ba59706a07d313f9c8a321ff964cbc83a6
+  data.tar.gz: 342cba317af63fc9aa28eccc5b81d7febce0c2a9601f62402703760c36705a3b1c72ddd514f899a1104008dfbf90e4cf210808c8c4ade1ac5cb9368fedf35b9f

data/README.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-The Ruby SDK helps you to communicate with the [Ingenico Connect](http://www.ingenico.com/epayments) Server API. Its primary features are:
+The Ruby SDK helps you to communicate with the [Ingenico Connect](https://epayments.developer-ingenico.com/) Server API. Its primary features are:
 
 * convenient Ruby library for the API calls and responses
     * marshalls Ruby request objects to HTTP requests

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '1.22.0'
+  spec.version        = '1.23.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/payments/get_refunds_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').payments().refunds('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/hostedcheckout/created_payment_output.rb

@@ -25,6 +25,9 @@ module Ingenico::Connect::SDK
         # String
         attr_accessor :payment_status_category
 
+        # true/false
+        attr_accessor :tokenization_succeeded
+
         # String
         attr_accessor :tokens
 
@@ -34,6 +37,7 @@ module Ingenico::Connect::SDK
           add_to_hash(hash, 'payment', @payment)
           add_to_hash(hash, 'paymentCreationReferences', @payment_creation_references)
           add_to_hash(hash, 'paymentStatusCategory', @payment_status_category)
+          add_to_hash(hash, 'tokenizationSucceeded', @tokenization_succeeded)
           add_to_hash(hash, 'tokens', @tokens)
           hash
         end
@@ -61,6 +65,9 @@ module Ingenico::Connect::SDK
           if hash.has_key?('paymentStatusCategory')
             @payment_status_category = hash['paymentStatusCategory']
           end
+          if hash.has_key?('tokenizationSucceeded')
+            @tokenization_succeeded = hash['tokenizationSucceeded']
+          end
           if hash.has_key?('tokens')
             @tokens = hash['tokens']
           end

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

@@ -16,10 +16,14 @@ module Ingenico::Connect::SDK
         # String
         attr_accessor :token
 
+        # true/false
+        attr_accessor :tokenization_succeeded
+
         def to_h
           hash = super
           add_to_hash(hash, 'isNewToken', @is_new_token)
           add_to_hash(hash, 'token', @token)
+          add_to_hash(hash, 'tokenizationSucceeded', @tokenization_succeeded)
           hash
         end
 
@@ -31,6 +35,9 @@ module Ingenico::Connect::SDK
           if hash.has_key?('token')
             @token = hash['token']
           end
+          if hash.has_key?('tokenizationSucceeded')
+            @tokenization_succeeded = hash['tokenizationSucceeded']
+          end
         end
       end
     end

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

@@ -11,6 +11,8 @@ module Ingenico::Connect::SDK
       class RedirectPaymentProduct840SpecificInput < Ingenico::Connect::SDK::DataObject
 
         # String
+        #
+        # Deprecated; use order.references.descriptor instead.
         attr_accessor :custom
 
         # true/false

data/lib/ingenico/connect/sdk/domain/refund/refunds_response.rb

@@ -0,0 +1,38 @@
+#
+# 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/refund/refund_result'
+
+module Ingenico::Connect::SDK
+  module Domain
+    module Refund
+
+      class RefundsResponse < Ingenico::Connect::SDK::DataObject
+
+        # Array of {Ingenico::Connect::SDK::Domain::Refund::RefundResult}
+        attr_accessor :refunds
+
+        def to_h
+          hash = super
+          add_to_hash(hash, 'refunds', @refunds)
+          hash
+        end
+
+        def from_hash(hash)
+          super
+          if hash.has_key?('refunds')
+            if !(hash['refunds'].is_a? Array)
+              raise TypeError, "value '%s' is not an Array" % [hash['refunds']]
+            end
+            @refunds = []
+            hash['refunds'].each do |e|
+              @refunds << Ingenico::Connect::SDK::Domain::Refund::RefundResult.new_from_hash(e)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/merchant/payments/payments_client.rb

@@ -18,6 +18,7 @@ require 'ingenico/connect/sdk/domain/payment/payment_response'
 require 'ingenico/connect/sdk/domain/payment/third_party_status_response'
 require 'ingenico/connect/sdk/domain/refund/refund_error_response'
 require 'ingenico/connect/sdk/domain/refund/refund_response'
+require 'ingenico/connect/sdk/domain/refund/refunds_response'
 require 'ingenico/connect/sdk/domain/token/create_token_response'
 
 module Ingenico::Connect::SDK
@@ -435,6 +436,38 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
+        # Resource /{{merchantId}}/payments/{{paymentId}}/refunds
+        #
+        # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/refunds.html Get refunds of payment}
+        # payment_id:: String
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Refund::RefundsResponse}
+        # Raises:: {Ingenico::Connect::SDK::ValidationException} if the request was not correct and couldn't be processed (HTTP status code 400)
+        # Raises:: {Ingenico::Connect::SDK::AuthorizationException} if the request was not allowed (HTTP status code 403)
+        # Raises:: {Ingenico::Connect::SDK::IdempotenceException} if an idempotent request caused a conflict (HTTP status code 409)
+        # Raises:: {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)
+        # Raises:: {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)
+        # Raises:: {Ingenico::Connect::SDK::ApiException} if the Ingenico ePayments platform returned any other error
+        def refunds(payment_id, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/refunds', path_context)
+          return @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Connect::SDK::Domain::Refund::RefundsResponse,
+            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
+
         # Resource /{{merchantId}}/payments/{{paymentId}}/cancel
         #
         # {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payments/cancel.html Cancel payment}

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

@@ -5,7 +5,7 @@ module Ingenico::Connect::SDK
 
   # Manages metadata about the server using the SDK
   class MetaDataProvider
-    @@SDK_VERSION = '1.22.0'
+    @@SDK_VERSION = '1.23.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: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Ingenico ePayments
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-12 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -142,6 +142,7 @@ files:
 - examples/merchant/payments/find_payments_example.rb
 - examples/merchant/payments/get_payment_captures_example.rb
 - examples/merchant/payments/get_payment_example.rb
+- examples/merchant/payments/get_refunds_example.rb
 - examples/merchant/payments/get_third_party_status_example.rb
 - examples/merchant/payments/process_challenged_payment_example.rb
 - examples/merchant/payments/refund_payment_example.rb
@@ -431,6 +432,7 @@ files:
 - lib/ingenico/connect/sdk/domain/refund/refund_request.rb
 - lib/ingenico/connect/sdk/domain/refund/refund_response.rb
 - lib/ingenico/connect/sdk/domain/refund/refund_result.rb
+- lib/ingenico/connect/sdk/domain/refund/refunds_response.rb
 - lib/ingenico/connect/sdk/domain/riskassessments/contact_details_risk_assessment.rb
 - lib/ingenico/connect/sdk/domain/riskassessments/customer_risk_assessment.rb
 - lib/ingenico/connect/sdk/domain/riskassessments/order_risk_assessment.rb