apimatic-gp-sdk 0.0.1

data/lib/batches/configuration.rb

@@ -0,0 +1,166 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Sandbox Environment
+    # ENVIRONMENT2: Production Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'environment2' then ENVIRONMENT2
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        logging_configuration: logging_configuration,
+                        environment: environment)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://apis.sandbox.globalpay.com/ucp'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://apis.globalpay.com/ucp'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 30).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/batches/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/batches/exceptions/batches400_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Bad Request
+  class Batches400ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This indicates an issue with the API request.
+    # @return [ErrorCode]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode]
+    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/batches401_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 Batches401ErrorException < 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/batches403_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 Batches403ErrorException < 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/batches500_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 Batches500ErrorException < 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/batches501_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 Batches501ErrorException < 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/batches502_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 Batches502ErrorException < 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/batches504_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 Batches504ErrorException < 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/exceptions/batches_transactions400_error_exception.rb

@@ -0,0 +1,61 @@
+# batches
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Batches
+  # Bad Request
+  class BatchesTransactions400ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This indicates an issue with the API request.
+    # @return [ErrorCode]
+    attr_accessor :error_code
+
+    # Unique reference to identify the error.
+    # @return [DetailedErrorCode]
+    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