orb-apiamtic-sdk 0.0.1

data/lib/api_reference/exceptions/idempotency_request_mismatch_exception.rb

@@ -0,0 +1,60 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # IdempotencyRequestMismatch class.
+  class IdempotencyRequestMismatchException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # 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
+
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @title = hash.key?('title') ? hash['title'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}>"
+    end
+  end
+end

data/lib/api_reference/exceptions/server_error_exception.rb

@@ -0,0 +1,61 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ServerError class.
+  class ServerErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # 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
+
+      @status = hash.key?('status') ? hash['status'] : nil
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @title = hash.key?('title') ? hash['title'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}>"
+    end
+  end
+end

data/lib/api_reference/exceptions/too_many_requests_exception.rb

@@ -0,0 +1,60 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TooManyRequests class.
+  class TooManyRequestsException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # 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
+
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @title = hash.key?('title') ? hash['title'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}>"
+    end
+  end
+end

data/lib/api_reference/http/api_response.rb

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

@@ -0,0 +1,53 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Utility class for OAuth 2 authorization and token management.
+  class Oauth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BearerAuth: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(bearer_auth_credentials)
+      auth_params = {}
+      @_access_token = bearer_auth_credentials.access_token unless
+        bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for BearerAuthCredentials.
+  class BearerAuthCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/api_reference/http/http_call_back.rb

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

data/lib/api_reference/http/http_method_enum.rb

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

data/lib/api_reference/http/http_request.rb

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

data/lib/api_reference/http/http_response.rb

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

data/lib/api_reference/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  ##
+  # 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/api_reference/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # 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/api_reference/logging/sdk_logger.rb

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

data/lib/api_reference/models/accounting_provider.rb

@@ -0,0 +1,108 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AccountingProvider Model.
+  class AccountingProvider < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ProviderType]
+    attr_accessor :provider_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :external_provider_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['provider_type'] = 'provider_type'
+      @_hash['external_provider_id'] = 'external_provider_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        external_provider_id
+      ]
+    end
+
+    def initialize(provider_type:, external_provider_id:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @provider_type = provider_type
+      @external_provider_id = external_provider_id
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      provider_type = hash.key?('provider_type') ? hash['provider_type'] : nil
+      external_provider_id =
+        hash.key?('external_provider_id') ? hash['external_provider_id'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountingProvider.new(provider_type: provider_type,
+                             external_provider_id: external_provider_id,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AccountingProvider | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.provider_type,
+                                ->(val) { ProviderType.validate(val) }) and
+            APIHelper.valid_type?(value.external_provider_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['provider_type'],
+                              ->(val) { ProviderType.validate(val) }) and
+          APIHelper.valid_type?(value['external_provider_id'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} provider_type: #{@provider_type}, external_provider_id:"\
+      " #{@external_provider_id}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} provider_type: #{@provider_type.inspect}, external_provider_id:"\
+      " #{@external_provider_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end