connect-sdk-ruby 1.0.0

data/lib/ingenico/connect/sdk/logging/request_log_message_builder.rb

@@ -0,0 +1,42 @@
+module Ingenico::Connect::SDK
+  module Logging
+
+    # Class that converts data about a request into a properly formatted log message.
+    # Formats request id, http method, uri, headers and body into a helpful message.
+    class RequestLogMessageBuilder < Ingenico::Connect::SDK::Logging::LogMessageBuilder
+      def initialize(request_id, method, uri)
+        super(request_id)
+        @method = method
+        @uri = uri
+      end
+
+      # Constructs and returns a log message based on the request data. The log message is a string.
+      def get_message
+        msgTemplateWithoutBody = "Outgoing request (requestId='%s'):\n" +
+            "  method:       '%s'\n" +
+            "  uri:          '%s'\n" +
+            "  headers:      '%s'"
+        msgTemplateWithBody = msgTemplateWithoutBody + "\n" +
+            "  content-type: '%s'\n" +
+            "  body:         '%s'"
+
+        return sprintf(msgTemplateWithoutBody, @request_id, empty_if_null(@method),
+                       format_uri, @headers) if @body.nil?
+        sprintf(msgTemplateWithBody, @request_id, empty_if_null(@method),
+                format_uri, @headers, empty_if_null(@content_type), @body)
+      end
+
+      private
+
+      def format_uri
+        '' unless @uri && @uri.path
+        if @uri.query.nil?
+          return @uri.path
+        else
+          return @uri.path + '?' + @uri.query unless @uri.query.nil?
+        end
+        # @uri.path + '?' + empty_if_null(@uri.query)
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/logging/response_log_message_builder.rb

@@ -0,0 +1,34 @@
+module Ingenico::Connect::SDK
+  module Logging
+
+    class ResponseLogMessageBuilder < LogMessageBuilder
+
+      # Class that converts data about a response into a properly formatted log message.
+      # Formats request id, status code, headers, body and time between request and response into a helpful message.
+      # request_id::  Identifier of the request corresponding to this response.
+      # status_code:: HTTP status code of the response.
+      # duration::    Time elapsed between request and response.
+      def initialize(request_id, status_code, duration=-1)
+        super(request_id)
+        @status_code = status_code
+        @duration = duration
+      end
+
+      # Constructs and returns a log message based on the request data. The log message is a string.
+      def get_message
+        msgTemplate = "Incoming response (requestId='%s'" +
+            ((@duration < 0) ? "" : ", %.3f ms") +
+            "):\n" +
+            "  status-code:  '%s'\n" +
+            "  headers:      '%s'\n" +
+            "  content-type: '%s'\n" +
+            "  body:         '%s'"
+
+        return sprintf(msgTemplate, @request_id, @status_code, @headers,
+                       empty_if_null(@content_type), empty_if_null(@body)) if @duration < 0
+        sprintf(msgTemplate, @request_id, @duration, @status_code, @headers,
+                empty_if_null(@content_type), empty_if_null(@body))
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/logging/ruby_communicator_logger.rb

@@ -0,0 +1,58 @@
+require 'English'
+
+module Ingenico::Connect::SDK
+  module Logging
+
+    # Logging class that Logs messages and errors to a logger.
+    # Errors can be logged at a separate level compared to regular messages.
+    class RubyCommunicatorLogger < CommunicatorLogger
+
+      # Creates a new RubyCommunicatorLogger instance.
+      # logger::      The logger to log messages to. Messages to log will be provided using logger#log(message level, message)
+      # log_level::   Log level to use for non-error messages.
+      # error_level:: Error logging level to use.
+      def initialize(logger, log_level, error_level=false)
+        # implement the interface
+        error_level ||= log_level
+        raise ArgumentError unless logger
+        raise ArgumentError unless log_level
+        raise ArgumentError unless error_level
+
+        @logger = logger
+        @logLevel = log_level
+        @errorLevel = error_level
+      end
+
+      # Logs a single error or non-error message to the logger.
+      def log(msg, thrown=false)
+        # use Ruby Logger
+        if thrown 
+          @logger.log(@errorLevel) { msg + $RS + thrown.backtrace.join($RS) }
+        else 
+          @logger.log(@logLevel, msg)
+        end
+      end
+
+      # Opens or creates a new file in write-only mode with _filename_.
+      def self.create_logfile(filename)
+        logdev = begin
+                   open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+                 rescue Errno::EEXIST
+                   # file is created by another process
+                   open_logfile(filename)
+                 end
+        logdev.sync = true
+        logdev
+      end
+
+      # Opens or creates a new file in write-only mode with _filename_.
+      def self.open_logfile(filename)
+        begin
+          open(filename, (File::WRONLY | File::APPEND))
+        rescue Errno::ENOENT
+          create_logfile(filename)
+        end
+      end
+    end
+  end
+end

data/lib/ingenico/connect/sdk/logging/stdout_communicator_logger.rb

@@ -0,0 +1,36 @@
+require 'English'
+
+module Ingenico::Connect::SDK
+  module Logging
+
+    # {Ingenico::Connect::SDK::Logging::CommunicatorLogger} that logs the messages to $stdout.
+    class StdoutCommunicatorLogger < CommunicatorLogger
+
+      def initialize
+        # implement the interface
+      end
+
+      # singleton
+      @@INSTANCE = StdoutCommunicatorLogger.new
+
+      private_class_method :new
+
+      # Returns the StdoutCommunicatorLogger instance
+      def self.INSTANCE
+        @@INSTANCE
+      end
+
+      # Logs a single error or non-error message to $stdout.
+      def log(msg, thrown=false)
+        $stdout.puts (get_date_prefix + msg)
+        $stdout.puts thrown.backtrace.join($RS) if thrown
+      end
+
+      private
+
+      def get_date_prefix
+        Time.now.strftime("%Y-%m-%dT%H:%M:%S ")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Ingenico::Connect::SDK
+
+  # Class responsible for marshalling and unmarshalling objects to and from JSON
+  class Marshaller
+
+    # Marshals _request_object_ to JSON format by calling #to_hash on it.
+    def marshal(request_object)
+      raise NotImplementedError
+    end
+
+    # Unmarshals a JSON string into an object of type _type_.
+    # The new object is initialized by calling .new_from_hash with contents of the JSON as a Hash object.
+    # response_json:: The JSON to unmarshal
+    # type::          The class of the object that will be instantiated using _type.new_from_hash_
+    def unmarshal(response_json, type)
+      raise NotImplementedError
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Ingenico::Connect::SDK
+
+  # Raised when an error occurred while marshalling/unmarshalling data to/from JSON
+  class MarshallerSyntaxException < RuntimeError
+  end
+end

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

@@ -0,0 +1,88 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_resource'
+require 'ingenico/connect/sdk/response_exception'
+require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/hostedcheckout/create_hosted_checkout_response'
+require 'ingenico/connect/sdk/domain/hostedcheckout/get_hosted_checkout_response'
+
+module Ingenico::Connect::SDK
+  module Merchant
+    module Hostedcheckouts
+
+      # Hostedcheckouts client. Thread-safe.
+      class HostedcheckoutsClient < Ingenico::Connect::SDK::ApiResource
+
+        # parent::       {Ingenico::Connect::SDK::ApiResource}
+        # path_context:: Hash of String to String
+        def initialize(parent, path_context)
+          super(parent, path_context)
+        end
+
+        # Resource /{{merchantId}}/hostedcheckouts
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__hostedcheckouts_post 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def create(body, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/hostedcheckouts', nil)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Hostedcheckout::CreateHostedCheckoutResponse,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/hostedcheckouts/{{hostedCheckoutId}}
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__hostedcheckouts__hostedCheckoutId__get 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def get(hosted_checkout_id, context=nil)
+          path_context = {
+            'hostedCheckoutId' => hosted_checkout_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/hostedcheckouts/{hostedCheckoutId}', path_context)
+          return @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Connect::SDK::Domain::Hostedcheckout::GetHostedCheckoutResponse,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_resource'
+require 'ingenico/connect/sdk/merchant/hostedcheckouts/hostedcheckouts_client'
+require 'ingenico/connect/sdk/merchant/payments/payments_client'
+require 'ingenico/connect/sdk/merchant/payouts/payouts_client'
+require 'ingenico/connect/sdk/merchant/productgroups/productgroups_client'
+require 'ingenico/connect/sdk/merchant/products/products_client'
+require 'ingenico/connect/sdk/merchant/refunds/refunds_client'
+require 'ingenico/connect/sdk/merchant/riskassessments/riskassessments_client'
+require 'ingenico/connect/sdk/merchant/services/services_client'
+require 'ingenico/connect/sdk/merchant/sessions/sessions_client'
+require 'ingenico/connect/sdk/merchant/tokens/tokens_client'
+
+module Ingenico::Connect::SDK
+  module Merchant
+
+    # Merchant client. Thread-safe.
+    class MerchantClient < Ingenico::Connect::SDK::ApiResource
+
+      # parent::       {Ingenico::Connect::SDK::ApiResource}
+      # path_context:: Hash of String to String
+      def initialize(parent, path_context)
+        super(parent, path_context)
+      end
+
+      # Resource /{{merchantId}}/hostedcheckouts
+      #
+      # Create new hosted checkout
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient}
+      def hostedcheckouts
+        Ingenico::Connect::SDK::Merchant::Hostedcheckouts::HostedcheckoutsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/payments
+      #
+      # Create, cancel and approve payments
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient}
+      def payments
+        Ingenico::Connect::SDK::Merchant::Payments::PaymentsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/payouts
+      #
+      # Create, cancel and approve payouts
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient}
+      def payouts
+        Ingenico::Connect::SDK::Merchant::Payouts::PayoutsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/productgroups
+      #
+      # Get information about payment product groups
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient}
+      def productgroups
+        Ingenico::Connect::SDK::Merchant::Productgroups::ProductgroupsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/products
+      #
+      # Get information about payment products
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Products::ProductsClient}
+      def products
+        Ingenico::Connect::SDK::Merchant::Products::ProductsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/refunds
+      #
+      # Create, cancel and approve refunds
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient}
+      def refunds
+        Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/riskassessments
+      #
+      # Perform risk assessments on your customer data
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient}
+      def riskassessments
+        Ingenico::Connect::SDK::Merchant::Riskassessments::RiskassessmentsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/services
+      #
+      # Several services to help you
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Services::ServicesClient}
+      def services
+        Ingenico::Connect::SDK::Merchant::Services::ServicesClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/sessions
+      #
+      # Create new Session for Client2Server API calls
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient}
+      def sessions
+        Ingenico::Connect::SDK::Merchant::Sessions::SessionsClient.new(self, nil)
+      end
+
+      # Resource /{{merchantId}}/tokens
+      #
+      # Create, delete and update tokens
+      # Returns:: {Ingenico::Connect::SDK::Merchant::Tokens::TokensClient}
+      def tokens
+        Ingenico::Connect::SDK::Merchant::Tokens::TokensClient.new(self, nil)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,319 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_resource'
+require 'ingenico/connect/sdk/response_exception'
+require 'ingenico/connect/sdk/domain/errors/error_response'
+require 'ingenico/connect/sdk/domain/payment/cancel_approval_payment_response'
+require 'ingenico/connect/sdk/domain/payment/cancel_payment_response'
+require 'ingenico/connect/sdk/domain/payment/create_payment_response'
+require 'ingenico/connect/sdk/domain/payment/payment_approval_response'
+require 'ingenico/connect/sdk/domain/payment/payment_error_response'
+require 'ingenico/connect/sdk/domain/payment/payment_response'
+require 'ingenico/connect/sdk/domain/refund/refund_error_response'
+require 'ingenico/connect/sdk/domain/refund/refund_response'
+require 'ingenico/connect/sdk/domain/token/create_token_response'
+
+module Ingenico::Connect::SDK
+  module Merchant
+    module Payments
+
+      # Payments client. Thread-safe.
+      class PaymentsClient < Ingenico::Connect::SDK::ApiResource
+
+        # parent::       {Ingenico::Connect::SDK::ApiResource}
+        # path_context:: Hash of String to String
+        def initialize(parent, path_context)
+          super(parent, path_context)
+        end
+
+        # Resource /{{merchantId}}/payments
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments_post Create payment}
+        # body::    {Ingenico::Connect::SDK::Domain::Payment::CreatePaymentRequest}
+        # context:: {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResponse}
+        # Raises:: {Ingenico::Connect::SDK::DeclinedPaymentException} if the GlobalCollect platform declined / rejected the payment. The payment 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def create(body, context=nil)
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments', nil)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            400 => Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse,
+            402 => Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse,
+            403 => Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse,
+            502 => Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse,
+            503 => Ingenico::Connect::SDK::Domain::Payment::PaymentErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__get Get payment}
+        # payment_id:: String
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Payment::PaymentResponse}
+        # 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def get(payment_id, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}', path_context)
+          return @communicator.get(
+            uri,
+            client_headers,
+            nil,
+            Ingenico::Connect::SDK::Domain::Payment::PaymentResponse,
+            context)
+        rescue ResponseException => e
+          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}/approve
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__approve_post Capture payment}
+        # payment_id:: String
+        # body::       {Ingenico::Connect::SDK::Domain::Payment::ApprovePaymentRequest}
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Payment::PaymentApprovalResponse}
+        # 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def approve(payment_id, body, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/approve', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Payment::PaymentApprovalResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            402 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}/cancel
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__cancel_post Cancel payment}
+        # payment_id:: String
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Payment::CancelPaymentResponse}
+        # 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def cancel(payment_id, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/cancel', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            nil,
+            Ingenico::Connect::SDK::Domain::Payment::CancelPaymentResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            402 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}/cancelapproval
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__cancelapproval_post Undo capture payment request}
+        # payment_id:: String
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Payment::CancelApprovalPaymentResponse}
+        # 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def cancelapproval(payment_id, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/cancelapproval', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            nil,
+            Ingenico::Connect::SDK::Domain::Payment::CancelApprovalPaymentResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}/processchallenged
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__processchallenged_post Approves challenged payment}
+        # payment_id:: String
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Payment::PaymentResponse}
+        # 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def processchallenged(payment_id, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/processchallenged', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            nil,
+            Ingenico::Connect::SDK::Domain::Payment::PaymentResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+            405 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}/refund
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__refund_post Create refund}
+        # payment_id:: String
+        # body::       {Ingenico::Connect::SDK::Domain::Refund::RefundRequest}
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Refund::RefundResponse}
+        # Raises:: {Ingenico::Connect::SDK::DeclinedRefundException} if the GlobalCollect platform declined / rejected the refund. The refund 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def refund(payment_id, body, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/refund', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Refund::RefundResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            400 => Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse,
+            404 => Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+
+        # Resource /{{merchantId}}/payments/{{paymentId}}/tokenize
+        #
+        # {https://developer.globalcollect.com/documentation/api/server/#__merchantId__payments__paymentId__tokenize_post Create a token from payment}
+        # payment_id:: String
+        # body::       {Ingenico::Connect::SDK::Domain::Payment::TokenizePaymentRequest}
+        # context::    {Ingenico::Connect::SDK::CallContext}
+        # Returns:: {Ingenico::Connect::SDK::Domain::Token::CreateTokenResponse}
+        # 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 GlobalCollect platform,  
+        #          the GlobalCollect 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 GlobalCollect platform returned any other error
+        def tokenize(payment_id, body, context=nil)
+          path_context = {
+            'paymentId' => payment_id,
+          }
+          uri = instantiate_uri('/{apiVersion}/{merchantId}/payments/{paymentId}/tokenize', path_context)
+          return @communicator.post(
+            uri,
+            client_headers,
+            nil,
+            body,
+            Ingenico::Connect::SDK::Domain::Token::CreateTokenResponse,
+            context)
+        rescue ResponseException => e
+          error_type = {
+            404 => Ingenico::Connect::SDK::Domain::Errors::ErrorResponse,
+          }.fetch(e.status_code, Ingenico::Connect::SDK::Domain::Errors::ErrorResponse)
+          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+          raise create_exception(e.status_code, e.body, error_object, context)
+        end
+      end
+    end
+  end
+end