connect-sdk-ruby 1.36.0 → 2.0.0

data/examples/merchant/productgroups/get_device_fingerprint_for_groups_example.rb

@@ -11,7 +11,7 @@ def example
   get_client do |client|
     body = Product::DeviceFingerprintRequest.new
 
-    response = client.merchant('merchantId').productgroups().device_fingerprint('cards', body)
+    response = client.merchant('merchantId').productgroups.device_fingerprint('cards', body)
   end
 end
 

data/examples/merchant/productgroups/get_payment_product_group_example.rb

@@ -17,7 +17,7 @@ def example
     query.is_recurring = true
     query.add_hide('fields')
 
-    response = client.merchant('merchantId').productgroups().get('cards', query)
+    response = client.merchant('merchantId').productgroups.get('cards', query)
   end
 end
 

data/examples/merchant/productgroups/get_payment_product_groups_example.rb

@@ -17,7 +17,7 @@ def example
     query.is_recurring = true
     query.add_hide('fields')
 
-    response = client.merchant('merchantId').productgroups().find(query)
+    response = client.merchant('merchantId').productgroups.find(query)
   end
 end
 

data/examples/merchant/products/get_customer_details_example.rb

@@ -23,7 +23,7 @@ def example
     body.country_code = 'SE'
     body.values = values
 
-    response = client.merchant('merchantId').products().customer_details(9000, body)
+    response = client.merchant('merchantId').products.customer_details(9000, body)
   end
 end
 

data/examples/merchant/products/get_device_fingerprint_example.rb

@@ -11,7 +11,7 @@ def example
   get_client do |client|
     body = Product::DeviceFingerprintRequest.new
 
-    response = client.merchant('merchantId').products().device_fingerprint(1, body)
+    response = client.merchant('merchantId').products.device_fingerprint(1, body)
   end
 end
 

data/examples/merchant/products/get_directory_example.rb

@@ -13,7 +13,7 @@ def example
     query.country_code = 'NL'
     query.currency_code = 'EUR'
 
-    response = client.merchant('merchantId').products().directory(809, query)
+    response = client.merchant('merchantId').products.directory(809, query)
   end
 end
 

data/examples/merchant/products/get_networks_example.rb

@@ -15,7 +15,7 @@ def example
     query.amount = 1000
     query.is_recurring = true
 
-    response = client.merchant('merchantId').products().networks(320, query)
+    response = client.merchant('merchantId').products.networks(320, query)
   end
 end
 

data/examples/merchant/products/get_payment_product_example.rb

@@ -18,7 +18,7 @@ def example
     query.force_basic_flow = false
     query.add_hide('fields')
 
-    response = client.merchant('merchantId').products().get(1, query)
+    response = client.merchant('merchantId').products.get(1, query)
   end
 end
 

data/examples/merchant/products/get_payment_products_example.rb

@@ -17,7 +17,7 @@ def example
     query.is_recurring = true
     query.add_hide('fields')
 
-    response = client.merchant('merchantId').products().find(query)
+    response = client.merchant('merchantId').products.find(query)
   end
 end
 

data/examples/merchant/refunds/approve_refund_example.rb

@@ -12,7 +12,7 @@ def example
     body = Refund::ApproveRefundRequest.new
     body.amount = 199
 
-    client.merchant('merchantId').refunds().approve('refundId', body)
+    client.merchant('merchantId').refunds.approve('refundId', body)
   end
 end
 

data/examples/merchant/refunds/cancel_approval_refund_example.rb

@@ -7,7 +7,7 @@ require 'ingenico/connect/sdk/factory'
 
 def example
   get_client do |client|
-    client.merchant('merchantId').refunds().cancelapproval('refundId')
+    client.merchant('merchantId').refunds.cancelapproval('refundId')
   end
 end
 

data/examples/merchant/refunds/cancel_refund_example.rb

@@ -7,7 +7,7 @@ require 'ingenico/connect/sdk/factory'
 
 def example
   get_client do |client|
-    client.merchant('merchantId').refunds().cancel('refundId')
+    client.merchant('merchantId').refunds.cancel('refundId')
   end
 end
 

data/examples/merchant/refunds/find_refunds_example.rb

@@ -16,7 +16,7 @@ def example
     query.offset = 0
     query.limit = 10
 
-    response = client.merchant('merchantId').refunds().find(query)
+    response = client.merchant('merchantId').refunds.find(query)
   end
 end
 

data/examples/merchant/refunds/get_refund_example.rb

@@ -7,7 +7,7 @@ require 'ingenico/connect/sdk/factory'
 
 def example
   get_client do |client|
-    response = client.merchant('merchantId').refunds().get('refundId')
+    response = client.merchant('merchantId').refunds.get('refundId')
   end
 end
 

data/examples/merchant/riskassessments/risk_assessment_bank_account_example.rb

@@ -39,7 +39,7 @@ def example
     body.bank_account_bban = bank_account_bban
     body.order = order
 
-    response = client.merchant('merchantId').riskassessments().bankaccounts(body)
+    response = client.merchant('merchantId').riskassessments.bankaccounts(body)
   end
 end
 

data/examples/merchant/riskassessments/risk_assessment_cards_example.rb

@@ -99,7 +99,7 @@ def example
     body.card = card
     body.order = order
 
-    response = client.merchant('merchantId').riskassessments().cards(body)
+    response = client.merchant('merchantId').riskassessments.cards(body)
   end
 end
 

data/examples/merchant/services/convert_amount_example.rb

@@ -14,7 +14,7 @@ def example
     query.target = 'USD'
     query.amount = 100
 
-    response = client.merchant('merchantId').services().convert_amount(query)
+    response = client.merchant('merchantId').services.convert_amount(query)
   end
 end
 

data/examples/merchant/services/convert_bank_account_example.rb

@@ -19,7 +19,7 @@ def example
     body = Services::BankDetailsRequest.new
     body.bank_account_bban = bank_account_bban
 
-    response = client.merchant('merchantId').services().bankaccount(body)
+    response = client.merchant('merchantId').services.bankaccount(body)
   end
 end
 

data/examples/merchant/services/get_privacy_policy_example.rb

@@ -13,7 +13,7 @@ def example
     query.locale = 'en_US'
     query.payment_product_id = 771
 
-    response = client.merchant('merchantId').services().privacypolicy(query)
+    response = client.merchant('merchantId').services.privacypolicy(query)
   end
 end
 

data/examples/merchant/services/iin_details_example.rb

@@ -12,7 +12,7 @@ def example
     body = Services::GetIINDetailsRequest.new
     body.bin = '4567350000427977'
 
-    response = client.merchant('merchantId').services().get_iin_details(body)
+    response = client.merchant('merchantId').services.get_iin_details(body)
   end
 end
 

data/examples/merchant/services/test_connection_example.rb

@@ -7,7 +7,7 @@ require 'ingenico/connect/sdk/factory'
 
 def example
   get_client do |client|
-    response = client.merchant('merchantId').services().testconnection()
+    response = client.merchant('merchantId').services.testconnection
   end
 end
 

data/examples/merchant/sessions/create_session_example.rb

@@ -19,7 +19,7 @@ def example
     body = Sessions::SessionRequest.new
     body.tokens = tokens
 
-    response = client.merchant('merchantId').sessions().create(body)
+    response = client.merchant('merchantId').sessions.create(body)
   end
 end
 

data/examples/merchant/tokens/approve_sepa_direct_debit_token_example.rb

@@ -14,7 +14,7 @@ def example
     body.mandate_signature_place = 'Monument Valley'
     body.mandate_signed = true
 
-    client.merchant('merchantId').tokens().approvesepadirectdebit('tokenId', body)
+    client.merchant('merchantId').tokens.approvesepadirectdebit('tokenId', body)
   end
 end
 

data/examples/merchant/tokens/create_token_example.rb

@@ -67,7 +67,7 @@ def example
     body.non_sepa_direct_debit = non_sepa_direct_debit
     body.payment_product_id = 705
 
-    response = client.merchant('merchantId').tokens().create(body)
+    response = client.merchant('merchantId').tokens.create(body)
   end
 end
 

data/examples/merchant/tokens/delete_token_example.rb

@@ -12,7 +12,7 @@ def example
     query = Tokens::DeleteTokenParams.new
     query.mandate_cancel_date = '20150102'
 
-    client.merchant('merchantId').tokens().delete('tokenId', query)
+    client.merchant('merchantId').tokens.delete('tokenId', query)
   end
 end
 

data/examples/merchant/tokens/get_token_example.rb

@@ -7,7 +7,7 @@ require 'ingenico/connect/sdk/factory'
 
 def example
   get_client do |client|
-    response = client.merchant('merchantId').tokens().get('tokenId')
+    response = client.merchant('merchantId').tokens.get('tokenId')
   end
 end
 

data/examples/merchant/tokens/update_token_example.rb

@@ -61,7 +61,7 @@ def example
     body.card = card
     body.payment_product_id = 1
 
-    client.merchant('merchantId').tokens().update('tokenId', body)
+    client.merchant('merchantId').tokens.update('tokenId', body)
   end
 end
 

data/lib/ingenico/connect/sdk.rb

@@ -17,12 +17,14 @@ require prefix + 'client'
 require prefix + 'call_context'
 require prefix + 'api_resource'
 require prefix + 'session'
-require prefix + 'response'
 require prefix + 'request_param'
 require prefix + 'request_header'
 require prefix + 'param_request'
 require prefix + 'meta_data_provider'
 require prefix + 'factory'
+require prefix + 'multipart_form_data_object'
+require prefix + 'multipart_form_data_request'
+require prefix + 'uploadable_file'
 
 require prefix + 'defaultimpl'
 require prefix + 'webhooks'

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

@@ -3,15 +3,21 @@ module Ingenico::Connect::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
 
     # Creates a new ApiException that reports an error response from the Ingenico ePayments platform.
-    # It reports the following:
-    # status_code::   HTTP status code the response
-    # response_body:: HTTP response body
-    # error_id::      Error id of the error, may be _nil_
-    # errors::        A list of errors that occurred, may be empty
-    # message::       Error message to include
+    #
+    # @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)
@@ -25,17 +31,9 @@ module Ingenico::Connect::SDK
       end
     end
 
-    # HTTP status code of the returned response.
     attr_reader :status_code
-
-    # Message body of the returned response.
     attr_reader :response_body
-
-    # An error id corresponding to the error that occurred, if available.
     attr_reader :error_id
-
-    # A list of errors received from the Ingenico ePayments platform;
-    # may be empty but never _nil_
     attr_reader :errors
 
     def to_s

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

@@ -4,18 +4,22 @@ module Ingenico::Connect::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
 
     # Creates a new ApiResource.
-    # arg::               Parent class or {Ingenico::Connect::SDK::Communicator} instance.
-    #                     If a parent class is given its communicator will be used for communication.
-    # path_context::      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://api-sandbox.globalcollect.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://api-sandbox.globalcollect.com/v1/1234/payments.
-    # client_meta_info::  JSON string containing the meta data for the client.
+    #
+    # @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://api-sandbox.globalcollect.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://api-sandbox.globalcollect.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?
@@ -36,15 +40,12 @@ module Ingenico::Connect::SDK
       end
     end
 
-    # {Ingenico::Connect::SDK::Communicator} instance that provides communication with the Ingenico ePayments platform.
     attr_reader :communicator
-
-    # JSON string containing client info specific to the current client.
     attr_reader :client_meta_info
 
     protected
 
-    # Returns the X-GCS-ClientMetaInfo header as a {Ingenico::Connect::SDK::RequestHeader}
+    # @return [String] the X-GCS-ClientMetaInfo header as an [Array<Ingenico::Connect::SDK::RequestHeader>]
     def client_headers
       if @client_meta_info.nil?
         nil

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

@@ -4,10 +4,11 @@ module Ingenico::Connect::SDK
   class Authenticator
 
     # Creates a signature to authenticate a request.
-    # Uses the following parameters:
-    # http_method::     'GET', 'PUT', 'POST' or 'DELETE' indicating which HTTP method will be used with the request
-    # resource_uri::    URI object that includes #path and #query of the url that will be used, #query may be *nil*
-    # request_headers:: {Ingenico::Connect::SDK::RequestHeader} list that contains all headers used by the 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

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

@@ -6,6 +6,12 @@ module Ingenico::Connect::SDK
   # 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
@@ -14,13 +20,7 @@ module Ingenico::Connect::SDK
       @idempotence_key = idempotence_key
     end
 
-    # 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_reader :idempotence_key
-
-    # 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.
     attr_accessor :idempotence_request_timestamp
   end
 end

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

@@ -22,19 +22,20 @@ module Ingenico
       class Client < ApiResource
         include Logging::LoggingCapable
 
+        # @return [String]
         def self.API_VERSION
           'v1'
         end
 
-        # communicator::     Ingenico::Connect::SDK::Communicator
-        # client_meta_info:: String
+        # @param communicator     [Ingenico::Connect::SDK::Communicator]
+        # @param client_meta_info [String]
         def initialize(communicator, client_meta_info=nil)
-          super(communicator, {'apiVersion' => Client.API_VERSION}, client_meta_info)
+          super(communicator, nil, client_meta_info)
         end
 
-        # client_meta_info:: JSON string containing the meta data for the client
-        # Returns:: A Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
-        # Raises:: Ingenico::Connect::SDK::MarshallerSyntaxException if the given clientMetaInfo is not a valid JSON string
+        # @param client_meta_info [String] JSON string containing the meta data for the client
+        # @return [Ingenico::Connect::SDK::Client] a Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
+        # @raise [Ingenico::Connect::SDK::MarshallerSyntaxException] if the given clientMetaInfo is not a valid JSON string
         def with_client_meta_info(client_meta_info)
           if @client_meta_info.nil? && client_meta_info.nil?
             self
@@ -63,7 +64,7 @@ module Ingenico
         end
 
         # Turns on logging using the given communicator logger.
-        # communicator_logger:: Ingenico::Connect::SDK::Logging::CommunicatorLogger
+        # @param communicator_logger [Ingenico::Connect::SDK::Logging::CommunicatorLogger]
         def enable_logging(communicator_logger)
           @communicator.enable_logging(communicator_logger)
         end
@@ -78,12 +79,12 @@ module Ingenico
           @communicator.close
         end
 
-        # Resource /{{merchantId}}
-        # merchant_id:: String
-        # Returns:: {Ingenico::Connect::SDK::Merchant::MerchantClient}
+        # Resource /!{merchantId}
+        # @param merchant_id [String]
+        # @return [Ingenico::Connect::SDK::Merchant::MerchantClient]
         def merchant(merchant_id)
           Ingenico::Connect::SDK::Merchant::MerchantClient.new(self, {
-            'merchantId' => merchant_id,
+            'merchantId'.freeze => merchant_id,
           })
         end
       end