wp-sdk 1.0.0

data/lib/reporting_settlement_research_api/configuration.rb

@@ -0,0 +1,164 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.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?
+
+      default_value
+    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, :custom_header_authentication_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      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,
+      custom_header_authentication_credentials: nil
+    )
+      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 object holding Custom Header Signature credentials
+      @custom_header_authentication_credentials = custom_header_authentication_credentials
+
+      # Initializing Custom Header Signature credentials with the provided auth parameters
+      @custom_header_authentication_credentials = custom_header_authentication_credentials
+
+      # 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,
+                   custom_header_authentication_credentials: 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
+      custom_header_authentication_credentials ||= self.custom_header_authentication_credentials
+
+      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,
+        custom_header_authentication_credentials: custom_header_authentication_credentials
+      )
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://apis.cert.worldpay.com/merchant-reporting/settlementresearch/v1'
+      }
+    }.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'] || 60).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
+
+      # === Authentication credentials ===
+      custom_header_authentication_credentials = CustomHeaderAuthenticationCredentials.from_env
+
+      # === 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,
+        custom_header_authentication_credentials: custom_header_authentication_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # 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/reporting_settlement_research_api/exceptions/search_date0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Search Date 0 Error class.
+  class SearchDate0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/search_store0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Search Store 0 Error class.
+  class SearchStore0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/settlementerrors_pendingsettlementbatches_search0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Settlementerrors Pendingsettlementbatches Search 0 Error class.
+  class SettlementerrorsPendingsettlementbatchesSearch0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/settlementerrors_settlementfileerrors_search0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Settlementerrors Settlementfileerrors Search 0 Error class.
+  class SettlementerrorsSettlementfileerrorsSearch0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/settlements_daily_totals_search0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Settlements Daily Totals Search 0 Error class.
+  class SettlementsDailyTotalsSearch0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/settlements_search0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Settlements Search 0 Error class.
+  class SettlementsSearch0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/transaction_statuses0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Transaction Statuses 0 Error class.
+  class TransactionStatuses0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/exceptions/transaction_types0_error_exception.rb

@@ -0,0 +1,58 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # Transaction Types 0 Error class.
+  class TransactionTypes0ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Code of error
+    # @return [String]
+    attr_accessor :error_code
+
+    # Error Message
+    # @return [String]
+    attr_accessor :error_message
+
+    # Error Target
+    # @return [String]
+    attr_accessor :target
+
+    # 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?('errorCode') ? hash['errorCode'] : SKIP
+      @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
+      @target = hash.key?('target') ? hash['target'] : 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}, error_message: #{@error_message}, target:"\
+      " #{@target}>"
+    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}, error_message:"\
+      " #{@error_message.inspect}, target: #{@target.inspect}>"
+    end
+  end
+end

data/lib/reporting_settlement_research_api/http/api_response.rb

@@ -0,0 +1,19 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # 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