apimatic-gp-sdk 0.0.1

data/lib/batches/exceptions/batches_transactions401_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Not Authenticated
+  class BatchesTransactions401ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This action failed as token in the request is not valid.
+    # @return [ErrorCode1]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode1]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      @detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}>"
+    end
+  end
+end

data/lib/batches/exceptions/batches_transactions403_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Forbidden
+  class BatchesTransactions403ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This action is not authorized with the credentials being used.
+    # @return [ErrorCode2]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode2]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      @detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}>"
+    end
+  end
+end

data/lib/batches/exceptions/batches_transactions500_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Internal Server Error
+  class BatchesTransactions500ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This indicates an unexpected issue occurred on the Global Payments system.
+    # @return [ErrorCode3]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode3]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      @detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}>"
+    end
+  end
+end

data/lib/batches/exceptions/batches_transactions501_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Not implemented
+  class BatchesTransactions501ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is an error not yet handled or mapped properly.
+    # @return [ErrorCode4]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode4]
+    attr_accessor :detailed_error_code
+
+    # Unique Text describing the specific error not yet handled.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      @detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}>"
+    end
+  end
+end

data/lib/batches/exceptions/batches_transactions502_error_exception.rb

@@ -0,0 +1,62 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Bad Gateway
+  class BatchesTransactions502ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is an error indicating there was an issue connecting to a partner
+    # system..
+    # @return [ErrorCode5]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode5]
+    attr_accessor :detailed_error_code
+
+    # Authentication error—Verify and correct credentials.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      @detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}>"
+    end
+  end
+end

data/lib/batches/exceptions/batches_transactions504_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Timeout
+  class BatchesTransactions504ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is an error indicating there was a timeout issue to another  system.
+    # @return [ErrorCode6]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode6]
+    attr_accessor :detailed_error_code
+
+    # No response from payment method provider.
+    # @return [String]
+    attr_accessor :detailed_error_description
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_code = hash.key?('error_code') ? hash['error_code'] : SKIP
+      @detailed_error_code =
+        hash.key?('detailed_error_code') ? hash['detailed_error_code'] : SKIP
+      @detailed_error_description =
+        hash.key?('detailed_error_description') ? hash['detailed_error_description'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, detailed_error_code: #{@detailed_error_code},"\
+      " detailed_error_description: #{@detailed_error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, detailed_error_code:"\
+      " #{@detailed_error_code.inspect}, detailed_error_description:"\
+      " #{@detailed_error_description.inspect}>"
+    end
+  end
+end

data/lib/batches/http/api_response.rb

@@ -0,0 +1,19 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/batches/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/batches/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/batches/http/http_request.rb

@@ -0,0 +1,10 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/batches/http/http_response.rb

@@ -0,0 +1,10 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/batches/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end

data/lib/batches/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/batches/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end