connect-sdk-ruby 1.36.0 → 2.0.0

data/lib/ingenico/connect/sdk/merchant/payouts/find_payouts_params.rb

@@ -3,33 +3,34 @@
 # https://epayments-api.developer-ingenico.com/s2sapi/v1/
 #
 require 'ingenico/connect/sdk/param_request'
+require 'ingenico/connect/sdk/request_param'
 
 module Ingenico::Connect::SDK
   module Merchant
     module Payouts
 
       # Query parameters for {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
+      # @attr [String] merchant_reference
+      # @attr [Integer] merchant_order_id
+      # @attr [Integer] offset
+      # @attr [Integer] limit
       class FindPayoutsParams < Ingenico::Connect::SDK::ParamRequest
 
-        # String
         attr_accessor :merchant_reference
 
-        # Integer
         attr_accessor :merchant_order_id
 
-        # Integer
         attr_accessor :offset
 
-        # Integer
         attr_accessor :limit
 
-        # Returns an Array of {Ingenico::Connect::SDK::RequestParam} objects representing the attributes of this class
+        # @return [Array<Ingenico::Connect::SDK::RequestParam>] representing the attributes of this class
         def to_request_parameters
           result = []
-          add_parameter(result, 'merchantReference', @merchant_reference)
-          add_parameter(result, 'merchantOrderId', @merchant_order_id)
-          add_parameter(result, 'offset', @offset)
-          add_parameter(result, 'limit', @limit)
+          result << RequestParam.new('merchantReference', @merchant_reference) unless @merchant_reference.nil?
+          result << RequestParam.new('merchantOrderId', @merchant_order_id.to_s) unless @merchant_order_id.nil?
+          result << RequestParam.new('offset', @offset.to_s) unless @offset.nil?
+          result << RequestParam.new('limit', @limit.to_s) unless @limit.nil?
           result
         end
       end

data/lib/ingenico/connect/sdk/merchant/payouts/payouts_client.rb

@@ -16,28 +16,28 @@ module Ingenico::Connect::SDK
       # Payouts client. Thread-safe.
       class PayoutsClient < Ingenico::Connect::SDK::ApiResource
 
-        # parent::       {Ingenico::Connect::SDK::ApiResource}
-        # path_context:: Hash of String to String
+        # @param parent        [Ingenico::Connect::SDK::ApiResource]
+        # @param path_context  [Hash]
         def initialize(parent, path_context)
           super(parent, path_context)
         end
 
-        # Resource /{{merchantId}}/payouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/create.html Create payout}
-        # body::    {Ingenico::Connect::SDK::Domain::Payout::CreatePayoutRequest}
-        # context:: {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Payout::PayoutResponse}
-        # Raises:: {Ingenico::Connect::SDK::DeclinedPayoutException} if the Ingenico ePayments platform declined / rejected the payout. The payout result will be available from the exception.
-        # 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
+        # Resource /!{merchantId}/payouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/create.html Create payout}
+        # @param body    [Ingenico::Connect::SDK::Domain::Payout::CreatePayoutRequest]
+        # @param context [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse]
+        # @raise [Ingenico::Connect::SDK::DeclinedPayoutException] if the Ingenico ePayments platform declined / rejected the payout. The payout 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 create(body, context=nil)
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/payouts', nil)
+          uri = instantiate_uri('/v1/{merchantId}/payouts', nil)
           return @communicator.post(
             uri,
             client_headers,
@@ -51,21 +51,21 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/payouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
-        # query::   {Ingenico::Connect::SDK::Merchant::Payouts::FindPayoutsParams}
-        # context:: {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Payout::FindPayoutsResponse}
-        # 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
+        # Resource /!{merchantId}/payouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/find.html Find payouts}
+        # @param query   [Ingenico::Connect::SDK::Merchant::Payouts::FindPayoutsParams]
+        # @param context [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Payout::FindPayoutsResponse]
+        # @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 find(query, context=nil)
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/payouts', nil)
+          uri = instantiate_uri('/v1/{merchantId}/payouts', nil)
           return @communicator.get(
             uri,
             client_headers,
@@ -78,24 +78,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/payouts/{{payoutId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/get.html Get payout}
-        # payout_id:: String
-        # context::   {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Payout::PayoutResponse}
-        # 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
+        # Resource /!{merchantId}/payouts/!{payoutId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/get.html Get payout}
+        # @param payout_id [String]
+        # @param context   [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse]
+        # @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 get(payout_id, context=nil)
           path_context = {
-            'payoutId' => payout_id,
+            'payoutId'.freeze => payout_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/payouts/{payoutId}', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}', path_context)
           return @communicator.get(
             uri,
             client_headers,
@@ -108,25 +108,25 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/payouts/{{payoutId}}/approve - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/approve.html Approve payout}
-        # payout_id:: String
-        # body::      {Ingenico::Connect::SDK::Domain::Payout::ApprovePayoutRequest}
-        # context::   {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Payout::PayoutResponse}
-        # 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
+        # Resource /!{merchantId}/payouts/!{payoutId}/approve - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/approve.html Approve payout}
+        # @param payout_id [String]
+        # @param body      [Ingenico::Connect::SDK::Domain::Payout::ApprovePayoutRequest]
+        # @param context   [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResponse]
+        # @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 approve(payout_id, body, context=nil)
           path_context = {
-            'payoutId' => payout_id,
+            'payoutId'.freeze => payout_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/payouts/{payoutId}/approve', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}/approve', path_context)
           return @communicator.post(
             uri,
             client_headers,
@@ -140,23 +140,23 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/payouts/{{payoutId}}/cancel - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancel.html Cancel payout}
-        # payout_id:: String
-        # context::   {Ingenico::Connect::SDK::CallContext}
-        # 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
+        # Resource /!{merchantId}/payouts/!{payoutId}/cancel - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancel.html Cancel payout}
+        # @param payout_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 cancel(payout_id, context=nil)
           path_context = {
-            'payoutId' => payout_id,
+            'payoutId'.freeze => payout_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/payouts/{payoutId}/cancel', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}/cancel', path_context)
           return @communicator.post(
             uri,
             client_headers,
@@ -170,23 +170,23 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/payouts/{{payoutId}}/cancelapproval - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancelapproval.html Undo approve payout}
-        # payout_id:: String
-        # context::   {Ingenico::Connect::SDK::CallContext}
-        # 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
+        # Resource /!{merchantId}/payouts/!{payoutId}/cancelapproval - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/payouts/cancelapproval.html Undo approve payout}
+        # @param payout_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 cancelapproval(payout_id, context=nil)
           path_context = {
-            'payoutId' => payout_id,
+            'payoutId'.freeze => payout_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/payouts/{payoutId}/cancelapproval', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/payouts/{payoutId}/cancelapproval', path_context)
           return @communicator.post(
             uri,
             client_headers,

data/lib/ingenico/connect/sdk/merchant/productgroups/find_productgroups_params.rb

@@ -3,33 +3,35 @@
 # https://epayments-api.developer-ingenico.com/s2sapi/v1/
 #
 require 'ingenico/connect/sdk/param_request'
+require 'ingenico/connect/sdk/request_param'
 
 module Ingenico::Connect::SDK
   module Merchant
     module Productgroups
 
       # Query parameters for {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
+      # @attr [String] country_code
+      # @attr [String] currency_code
+      # @attr [String] locale
+      # @attr [Integer] amount
+      # @attr [true/false] is_recurring
+      # @attr [Array<String>] hide
       class FindProductgroupsParams < Ingenico::Connect::SDK::ParamRequest
 
-        # String
         attr_accessor :country_code
 
-        # String
         attr_accessor :currency_code
 
-        # String
         attr_accessor :locale
 
-        # Integer
         attr_accessor :amount
 
-        # true/false
         attr_accessor :is_recurring
 
-        # Array of String
         attr_accessor :hide
 
         # Adds the parameter _value_ to the _hide_ Array
+        # @param value [String]
         def add_hide(value)
           unless @hide
             @hide = []
@@ -37,15 +39,17 @@ module Ingenico::Connect::SDK
           @hide << value
         end
 
-        # Returns an Array of {Ingenico::Connect::SDK::RequestParam} objects representing the attributes of this class
+        # @return [Array<Ingenico::Connect::SDK::RequestParam>] representing the attributes of this class
         def to_request_parameters
           result = []
-          add_parameter(result, 'countryCode', @country_code)
-          add_parameter(result, 'currencyCode', @currency_code)
-          add_parameter(result, 'locale', @locale)
-          add_parameter(result, 'amount', @amount)
-          add_parameter(result, 'isRecurring', @is_recurring)
-          add_parameter(result, 'hide', @hide)
+          result << RequestParam.new('countryCode', @country_code) unless @country_code.nil?
+          result << RequestParam.new('currencyCode', @currency_code) unless @currency_code.nil?
+          result << RequestParam.new('locale', @locale) unless @locale.nil?
+          result << RequestParam.new('amount', @amount.to_s) unless @amount.nil?
+          result << RequestParam.new('isRecurring', @is_recurring.to_s) unless @is_recurring.nil?
+          unless @hide.nil?
+            @hide.each {|e| result << RequestParam.new('hide', e)}
+          end
           result
         end
       end

data/lib/ingenico/connect/sdk/merchant/productgroups/get_productgroup_params.rb

@@ -3,33 +3,35 @@
 # https://epayments-api.developer-ingenico.com/s2sapi/v1/
 #
 require 'ingenico/connect/sdk/param_request'
+require 'ingenico/connect/sdk/request_param'
 
 module Ingenico::Connect::SDK
   module Merchant
     module Productgroups
 
       # Query parameters for {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
+      # @attr [String] country_code
+      # @attr [String] currency_code
+      # @attr [String] locale
+      # @attr [Integer] amount
+      # @attr [true/false] is_recurring
+      # @attr [Array<String>] hide
       class GetProductgroupParams < Ingenico::Connect::SDK::ParamRequest
 
-        # String
         attr_accessor :country_code
 
-        # String
         attr_accessor :currency_code
 
-        # String
         attr_accessor :locale
 
-        # Integer
         attr_accessor :amount
 
-        # true/false
         attr_accessor :is_recurring
 
-        # Array of String
         attr_accessor :hide
 
         # Adds the parameter _value_ to the _hide_ Array
+        # @param value [String]
         def add_hide(value)
           unless @hide
             @hide = []
@@ -37,15 +39,17 @@ module Ingenico::Connect::SDK
           @hide << value
         end
 
-        # Returns an Array of {Ingenico::Connect::SDK::RequestParam} objects representing the attributes of this class
+        # @return [Array<Ingenico::Connect::SDK::RequestParam>] representing the attributes of this class
         def to_request_parameters
           result = []
-          add_parameter(result, 'countryCode', @country_code)
-          add_parameter(result, 'currencyCode', @currency_code)
-          add_parameter(result, 'locale', @locale)
-          add_parameter(result, 'amount', @amount)
-          add_parameter(result, 'isRecurring', @is_recurring)
-          add_parameter(result, 'hide', @hide)
+          result << RequestParam.new('countryCode', @country_code) unless @country_code.nil?
+          result << RequestParam.new('currencyCode', @currency_code) unless @currency_code.nil?
+          result << RequestParam.new('locale', @locale) unless @locale.nil?
+          result << RequestParam.new('amount', @amount.to_s) unless @amount.nil?
+          result << RequestParam.new('isRecurring', @is_recurring.to_s) unless @is_recurring.nil?
+          unless @hide.nil?
+            @hide.each {|e| result << RequestParam.new('hide', e)}
+          end
           result
         end
       end

data/lib/ingenico/connect/sdk/merchant/productgroups/productgroups_client.rb

@@ -16,27 +16,27 @@ module Ingenico::Connect::SDK
       # Productgroups client. Thread-safe.
       class ProductgroupsClient < Ingenico::Connect::SDK::ApiResource
 
-        # parent::       {Ingenico::Connect::SDK::ApiResource}
-        # path_context:: Hash of String to String
+        # @param parent        [Ingenico::Connect::SDK::ApiResource]
+        # @param path_context  [Hash]
         def initialize(parent, path_context)
           super(parent, path_context)
         end
 
-        # Resource /{{merchantId}}/productgroups - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
-        # query::   {Ingenico::Connect::SDK::Merchant::Productgroups::FindProductgroupsParams}
-        # context:: {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Product::PaymentProductGroups}
-        # 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
+        # Resource /!{merchantId}/productgroups - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/find.html Get payment product groups}
+        # @param query   [Ingenico::Connect::SDK::Merchant::Productgroups::FindProductgroupsParams]
+        # @param context [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Product::PaymentProductGroups]
+        # @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 find(query, context=nil)
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/productgroups', nil)
+          uri = instantiate_uri('/v1/{merchantId}/productgroups', nil)
           return @communicator.get(
             uri,
             client_headers,
@@ -49,25 +49,25 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/productgroups/{{paymentProductGroupId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
-        # payment_product_group_id:: String
-        # query::                    {Ingenico::Connect::SDK::Merchant::Productgroups::GetProductgroupParams}
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Product::PaymentProductGroupResponse}
-        # 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
+        # Resource /!{merchantId}/productgroups/!{paymentProductGroupId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/get.html Get payment product group}
+        # @param payment_product_group_id [String]
+        # @param query                    [Ingenico::Connect::SDK::Merchant::Productgroups::GetProductgroupParams]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Product::PaymentProductGroupResponse]
+        # @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 get(payment_product_group_id, query, context=nil)
           path_context = {
-            'paymentProductGroupId' => payment_product_group_id,
+            'paymentProductGroupId'.freeze => payment_product_group_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/productgroups/{paymentProductGroupId}', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/productgroups/{paymentProductGroupId}', path_context)
           return @communicator.get(
             uri,
             client_headers,
@@ -80,25 +80,25 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/productgroups/{{paymentProductGroupId}}/deviceFingerprint - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/deviceFingerprint.html Get device fingerprint}
-        # payment_product_group_id:: String
-        # body::                     {Ingenico::Connect::SDK::Domain::Product::DeviceFingerprintRequest}
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Product::DeviceFingerprintResponse}
-        # 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
+        # Resource /!{merchantId}/productgroups/!{paymentProductGroupId}/deviceFingerprint - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/productgroups/deviceFingerprint.html Get device fingerprint}
+        # @param payment_product_group_id [String]
+        # @param body                     [Ingenico::Connect::SDK::Domain::Product::DeviceFingerprintRequest]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Product::DeviceFingerprintResponse]
+        # @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 device_fingerprint(payment_product_group_id, body, context=nil)
           path_context = {
-            'paymentProductGroupId' => payment_product_group_id,
+            'paymentProductGroupId'.freeze => payment_product_group_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/productgroups/{paymentProductGroupId}/deviceFingerprint', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/productgroups/{paymentProductGroupId}/deviceFingerprint', path_context)
           return @communicator.post(
             uri,
             client_headers,