connect-sdk-ruby 1.36.0 → 2.0.0

data/lib/ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client.rb

@@ -15,27 +15,27 @@ module Ingenico::Connect::SDK
       # Hostedcheckouts client. Thread-safe.
       class HostedcheckoutsClient < 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}}/hostedcheckouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedcheckouts/create.html Create hosted checkout}
-        # body::    {Ingenico::Connect::SDK::Domain::Hostedcheckout::CreateHostedCheckoutRequest}
-        # context:: {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Hostedcheckout::CreateHostedCheckoutResponse}
-        # 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}/hostedcheckouts - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedcheckouts/create.html Create hosted checkout}
+        # @param body    [Ingenico::Connect::SDK::Domain::Hostedcheckout::CreateHostedCheckoutRequest]
+        # @param context [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Hostedcheckout::CreateHostedCheckoutResponse]
+        # @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}/hostedcheckouts', nil)
+          uri = instantiate_uri('/v1/{merchantId}/hostedcheckouts', nil)
           return @communicator.post(
             uri,
             client_headers,
@@ -49,24 +49,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/hostedcheckouts/{{hostedCheckoutId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedcheckouts/get.html Get hosted checkout status}
-        # hosted_checkout_id:: String
-        # context::            {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Hostedcheckout::GetHostedCheckoutResponse}
-        # 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}/hostedcheckouts/!{hostedCheckoutId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedcheckouts/get.html Get hosted checkout status}
+        # @param hosted_checkout_id [String]
+        # @param context            [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Hostedcheckout::GetHostedCheckoutResponse]
+        # @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(hosted_checkout_id, context=nil)
           path_context = {
-            'hostedCheckoutId' => hosted_checkout_id,
+            'hostedCheckoutId'.freeze => hosted_checkout_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/hostedcheckouts/{hostedCheckoutId}', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/hostedcheckouts/{hostedCheckoutId}', path_context)
           return @communicator.get(
             uri,
             client_headers,

data/lib/ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb

@@ -15,27 +15,27 @@ module Ingenico::Connect::SDK
       # Hostedmandatemanagements client. Thread-safe.
       class HostedmandatemanagementsClient < 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}}/hostedmandatemanagements - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedmandatemanagements/create.html Create hosted mandate management}
-        # body::    {Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementRequest}
-        # context:: {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementResponse}
-        # 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}/hostedmandatemanagements - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedmandatemanagements/create.html Create hosted mandate management}
+        # @param body    [Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementRequest]
+        # @param context [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementResponse]
+        # @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}/hostedmandatemanagements', nil)
+          uri = instantiate_uri('/v1/{merchantId}/hostedmandatemanagements', nil)
           return @communicator.post(
             uri,
             client_headers,
@@ -49,24 +49,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/hostedmandatemanagements/{{hostedMandateManagementId}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedmandatemanagements/get.html Get hosted mandate management status}
-        # hosted_mandate_management_id:: String
-        # context::                      {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::GetHostedMandateManagementResponse}
-        # 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}/hostedmandatemanagements/!{hostedMandateManagementId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/hostedmandatemanagements/get.html Get hosted mandate management status}
+        # @param hosted_mandate_management_id [String]
+        # @param context                      [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::GetHostedMandateManagementResponse]
+        # @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(hosted_mandate_management_id, context=nil)
           path_context = {
-            'hostedMandateManagementId' => hosted_mandate_management_id,
+            'hostedMandateManagementId'.freeze => hosted_mandate_management_id,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/hostedmandatemanagements/{hostedMandateManagementId}', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/hostedmandatemanagements/{hostedMandateManagementId}', path_context)
           return @communicator.get(
             uri,
             client_headers,

data/lib/ingenico/connect/sdk/merchant/mandates/mandates_client.rb

@@ -15,27 +15,27 @@ module Ingenico::Connect::SDK
       # Mandates client. Thread-safe.
       class MandatesClient < 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}}/mandates - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/create.html Create mandate}
-        # body::    {Ingenico::Connect::SDK::Domain::Mandates::CreateMandateRequest}
-        # context:: {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Mandates::CreateMandateResponse}
-        # 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}/mandates - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/create.html Create mandate}
+        # @param body    [Ingenico::Connect::SDK::Domain::Mandates::CreateMandateRequest]
+        # @param context [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Mandates::CreateMandateResponse]
+        # @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}/mandates', nil)
+          uri = instantiate_uri('/v1/{merchantId}/mandates', nil)
           return @communicator.post(
             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}}/mandates/{{uniqueMandateReference}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/createWithMandateReference.html Create mandate with mandatereference}
-        # unique_mandate_reference:: String
-        # body::                     {Ingenico::Connect::SDK::Domain::Mandates::CreateMandateRequest}
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Mandates::CreateMandateResponse}
-        # 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}/mandates/!{uniqueMandateReference} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/createWithMandateReference.html Create mandate with mandatereference}
+        # @param unique_mandate_reference [String]
+        # @param body                     [Ingenico::Connect::SDK::Domain::Mandates::CreateMandateRequest]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Mandates::CreateMandateResponse]
+        # @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_with_mandate_reference(unique_mandate_reference, body, context=nil)
           path_context = {
-            'uniqueMandateReference' => unique_mandate_reference,
+            'uniqueMandateReference'.freeze => unique_mandate_reference,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/mandates/{uniqueMandateReference}', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/mandates/{uniqueMandateReference}', path_context)
           return @communicator.put(
             uri,
             client_headers,
@@ -81,24 +81,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/mandates/{{uniqueMandateReference}} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/get.html Get mandate}
-        # unique_mandate_reference:: String
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse}
-        # 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}/mandates/!{uniqueMandateReference} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/get.html Get mandate}
+        # @param unique_mandate_reference [String]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse]
+        # @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(unique_mandate_reference, context=nil)
           path_context = {
-            'uniqueMandateReference' => unique_mandate_reference,
+            'uniqueMandateReference'.freeze => unique_mandate_reference,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/mandates/{uniqueMandateReference}', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/mandates/{uniqueMandateReference}', path_context)
           return @communicator.get(
             uri,
             client_headers,
@@ -111,24 +111,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/mandates/{{uniqueMandateReference}}/block - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/block.html Block mandate}
-        # unique_mandate_reference:: String
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse}
-        # 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}/mandates/!{uniqueMandateReference}/block - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/block.html Block mandate}
+        # @param unique_mandate_reference [String]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse]
+        # @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 block(unique_mandate_reference, context=nil)
           path_context = {
-            'uniqueMandateReference' => unique_mandate_reference,
+            'uniqueMandateReference'.freeze => unique_mandate_reference,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/mandates/{uniqueMandateReference}/block', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/mandates/{uniqueMandateReference}/block', path_context)
           return @communicator.post(
             uri,
             client_headers,
@@ -142,24 +142,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/mandates/{{uniqueMandateReference}}/unblock - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/unblock.html Unblock mandate}
-        # unique_mandate_reference:: String
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse}
-        # 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}/mandates/!{uniqueMandateReference}/unblock - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/unblock.html Unblock mandate}
+        # @param unique_mandate_reference [String]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse]
+        # @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 unblock(unique_mandate_reference, context=nil)
           path_context = {
-            'uniqueMandateReference' => unique_mandate_reference,
+            'uniqueMandateReference'.freeze => unique_mandate_reference,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/mandates/{uniqueMandateReference}/unblock', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/mandates/{uniqueMandateReference}/unblock', path_context)
           return @communicator.post(
             uri,
             client_headers,
@@ -173,24 +173,24 @@ module Ingenico::Connect::SDK
           raise create_exception(e.status_code, e.body, error_object, context)
         end
 
-        # Resource /{{merchantId}}/mandates/{{uniqueMandateReference}}/revoke - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/revoke.html Revoke mandate}
-        # unique_mandate_reference:: String
-        # context::                  {Ingenico::Connect::SDK::CallContext}
-        # Returns:: {Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse}
-        # 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}/mandates/!{uniqueMandateReference}/revoke - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/mandates/revoke.html Revoke mandate}
+        # @param unique_mandate_reference [String]
+        # @param context                  [Ingenico::Connect::SDK::CallContext]
+        # @return [Ingenico::Connect::SDK::Domain::Mandates::GetMandateResponse]
+        # @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 revoke(unique_mandate_reference, context=nil)
           path_context = {
-            'uniqueMandateReference' => unique_mandate_reference,
+            'uniqueMandateReference'.freeze => unique_mandate_reference,
           }
-          uri = instantiate_uri('/{apiVersion}/{merchantId}/mandates/{uniqueMandateReference}/revoke', path_context)
+          uri = instantiate_uri('/v1/{merchantId}/mandates/{uniqueMandateReference}/revoke', path_context)
           return @communicator.post(
             uri,
             client_headers,

data/lib/ingenico/connect/sdk/merchant/merchant_client.rb

@@ -5,6 +5,7 @@
 require 'ingenico/connect/sdk/api_resource'
 require 'ingenico/connect/sdk/merchant/captures/captures_client'
 require 'ingenico/connect/sdk/merchant/disputes/disputes_client'
+require 'ingenico/connect/sdk/merchant/files/files_client'
 require 'ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client'
 require 'ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client'
 require 'ingenico/connect/sdk/merchant/mandates/mandates_client'
@@ -24,95 +25,101 @@ module Ingenico::Connect::SDK
     # Merchant client. Thread-safe.
     class MerchantClient < 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}}/hostedcheckouts
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient}
+      # Resource /!{merchantId}/hostedcheckouts
+      # @return [Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient]
       def hostedcheckouts
         Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/hostedmandatemanagements
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient}
+      # Resource /!{merchantId}/hostedmandatemanagements
+      # @return [Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient]
       def hostedmandatemanagements
         Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/payments
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient}
+      # Resource /!{merchantId}/payments
+      # @return [Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient]
       def payments
         Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/captures
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Captures::CapturesClient}
+      # Resource /!{merchantId}/captures
+      # @return [Ingenico::Connect::SDK::Merchant::Captures::CapturesClient]
       def captures
         Ingenico::Connect::SDK::Merchant::Captures::CapturesClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/refunds
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient}
+      # Resource /!{merchantId}/refunds
+      # @return [Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient]
       def refunds
         Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/disputes
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Disputes::DisputesClient}
+      # Resource /!{merchantId}/disputes
+      # @return [Ingenico::Connect::SDK::Merchant::Disputes::DisputesClient]
       def disputes
         Ingenico::Connect::SDK::Merchant::Disputes::DisputesClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/payouts
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient}
+      # Resource /!{merchantId}/payouts
+      # @return [Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient]
       def payouts
         Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/productgroups
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient}
+      # Resource /!{merchantId}/productgroups
+      # @return [Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient]
       def productgroups
         Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/products
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Products::ProductsClient}
+      # Resource /!{merchantId}/products
+      # @return [Ingenico::Connect::SDK::Merchant::Products::ProductsClient]
       def products
         Ingenico::Connect::SDK::Merchant::Products::ProductsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/riskassessments
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient}
+      # Resource /!{merchantId}/riskassessments
+      # @return [Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient]
       def riskassessments
         Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/services
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Services::ServicesClient}
+      # Resource /!{merchantId}/services
+      # @return [Ingenico::Connect::SDK::Merchant::Services::ServicesClient]
       def services
         Ingenico::Connect::SDK::Merchant::Services::ServicesClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/tokens
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Tokens::TokensClient}
+      # Resource /!{merchantId}/tokens
+      # @return [Ingenico::Connect::SDK::Merchant::Tokens::TokensClient]
       def tokens
         Ingenico::Connect::SDK::Merchant::Tokens::TokensClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/mandates
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Mandates::MandatesClient}
+      # Resource /!{merchantId}/mandates
+      # @return [Ingenico::Connect::SDK::Merchant::Mandates::MandatesClient]
       def mandates
         Ingenico::Connect::SDK::Merchant::Mandates::MandatesClient.new(self, nil)
       end
 
-      # Resource /{{merchantId}}/sessions
-      # Returns:: {Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient}
+      # Resource /!{merchantId}/sessions
+      # @return [Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient]
       def sessions
         Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient.new(self, nil)
       end
+
+      # Resource /!{merchantId}/files
+      # @return [Ingenico::Connect::SDK::Merchant::Files::FilesClient]
+      def files
+        Ingenico::Connect::SDK::Merchant::Files::FilesClient.new(self, nil)
+      end
     end
   end
 end