sdksio-apimatic-sdk 3.0.0 → 3.0.1

data/lib/apimatic_api/http/auth/custom_header_authentication.rb

@@ -1,42 +1,52 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # Utility class for custom header authorization.
-  class CustomHeaderAuthentication < CoreLibrary::HeaderAuth
-    # Display error message on occurrence of authentication failure.
-    # @returns [String] The oAuth error message.
-    def error_message
-      'CustomHeaderAuthentication: authorization is undefined.'
-    end
-
-    # Initialization constructor.
-    def initialize(custom_header_authentication_credentials)
-      auth_params = {}
-      auth_params['Authorization'] = custom_header_authentication_credentials.authorization unless
-        custom_header_authentication_credentials.nil? || custom_header_authentication_credentials.authorization.nil?
-
-      super auth_params
-    end
-  end
-
-  # Data class for CustomHeaderAuthenticationCredentials.
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # Utility class for custom header authorization.
+  class CustomHeaderAuthentication < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'CustomHeaderAuthentication: authorization is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(custom_header_authentication_credentials)
+      auth_params = {}
+      auth_params['Authorization'] = custom_header_authentication_credentials.authorization unless
+        custom_header_authentication_credentials.nil? || custom_header_authentication_credentials.authorization.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for CustomHeaderAuthenticationCredentials.
   # Data class for CustomHeaderAuthenticationCredentials.
   class CustomHeaderAuthenticationCredentials
     attr_reader :authorization
 
-    def initialize(authorization:)
-      raise ArgumentError, 'authorization cannot be nil' if authorization.nil?
-
-      @authorization = authorization
-    end
-
-    def clone_with(authorization: nil)
-      authorization ||= self.authorization
-
-      CustomHeaderAuthenticationCredentials.new(authorization: authorization)
-    end
-  end
-end
+    def initialize(authorization:)
+      raise ArgumentError, 'authorization cannot be nil' if authorization.nil?
+
+      @authorization = authorization
+    end
+
+    def self.from_env
+      authorization = ENV['AUTHORIZATION']
+      all_nil = [
+        authorization
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(authorization: authorization)
+    end
+
+    def clone_with(authorization: nil)
+      authorization ||= self.authorization
+
+      CustomHeaderAuthenticationCredentials.new(authorization: authorization)
+    end
+  end
+end

data/lib/apimatic_api/http/http_call_back.rb

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

data/lib/apimatic_api/http/http_method_enum.rb

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

data/lib/apimatic_api/http/http_request.rb

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

data/lib/apimatic_api/http/http_response.rb

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

data/lib/apimatic_api/http/proxy_settings.rb

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

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

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

@@ -0,0 +1,26 @@
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # Accept.
+  class Accept
+    ACCEPT = [
+      # TODO: Write general description for ENUM_APPLICATIONJSON
+      ENUM_APPLICATIONJSON = 'application/json'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCEPT.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_APPLICATIONJSON)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/apimatic_api/models/api_validation_summary.rb

@@ -1,75 +1,100 @@
-# apimatic_api
-#
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-module ApimaticApi
-  # ApiValidationSummary Model.
-  class ApiValidationSummary < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # TODO: Write general description for this method
-    # @return [TrueClass | FalseClass]
-    attr_accessor :success
-
-    # TODO: Write general description for this method
-    # @return [Array[String]]
-    attr_accessor :errors
-
-    # TODO: Write general description for this method
-    # @return [Array[String]]
-    attr_accessor :warnings
-
-    # TODO: Write general description for this method
-    # @return [Array[String]]
-    attr_accessor :messages
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['success'] = 'success'
-      @_hash['errors'] = 'errors'
-      @_hash['warnings'] = 'warnings'
-      @_hash['messages'] = 'messages'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(success = nil,
-                   errors = nil,
-                   warnings = nil,
-                   messages = nil)
-      @success = success
-      @errors = errors
-      @warnings = warnings
-      @messages = messages
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      success = hash.key?('success') ? hash['success'] : nil
-      errors = hash.key?('errors') ? hash['errors'] : nil
-      warnings = hash.key?('warnings') ? hash['warnings'] : nil
-      messages = hash.key?('messages') ? hash['messages'] : nil
-
-      # Create object from extracted values.
-      ApiValidationSummary.new(success,
-                               errors,
-                               warnings,
-                               messages)
-    end
-  end
-end
+# apimatic_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApimaticApi
+  # ApiValidationSummary Model.
+  class ApiValidationSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :errors
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :warnings
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'success'
+      @_hash['errors'] = 'errors'
+      @_hash['warnings'] = 'warnings'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success:, errors:, warnings:, messages:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @success = success
+      @errors = errors
+      @warnings = warnings
+      @messages = messages
+      @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.
+      success = hash.key?('success') ? hash['success'] : nil
+      errors = hash.key?('errors') ? hash['errors'] : nil
+      warnings = hash.key?('warnings') ? hash['warnings'] : nil
+      messages = hash.key?('messages') ? hash['messages'] : 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.
+      ApiValidationSummary.new(success: success,
+                               errors: errors,
+                               warnings: warnings,
+                               messages: messages,
+                               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} success: #{@success}, errors: #{@errors}, warnings: #{@warnings}, messages:"\
+      " #{@messages}, 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} success: #{@success.inspect}, errors: #{@errors.inspect}, warnings:"\
+      " #{@warnings.inspect}, messages: #{@messages.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end