chainlink-apimatic-sdk 0.0.1

data/lib/swagger_petstore_open_api30/exceptions/oauth_provider_exception.rb

@@ -0,0 +1,64 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # OAuth 2 Authorization endpoint exception.
+  class OauthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OauthProviderError]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # 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 = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}, error_uri:"\
+      " #{@error_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description: #{@error_description.inspect},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/http/api_response.rb

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

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

data/lib/swagger_petstore_open_api30/http/auth/petstore_auth.rb

@@ -0,0 +1,112 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # Utility class for OAuth 2 authorization and token management.
+  class PetstoreAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PetstoreAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(petstore_auth_credentials, config)
+      auth_params = {}
+      @_oauth_client_id = petstore_auth_credentials.oauth_client_id unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.oauth_client_id.nil?
+      @_oauth_redirect_uri = petstore_auth_credentials.oauth_redirect_uri unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.oauth_redirect_uri.nil?
+      @_oauth_token = petstore_auth_credentials.oauth_token unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.oauth_token.nil?
+      @_oauth_scopes = petstore_auth_credentials.oauth_scopes unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.oauth_scopes.nil?
+      @_o_auth_api = OauthAuthorizationApi.new(config)
+      auth_params[:Authorization] = "Bearer #{@_oauth_token.access_token}" unless @_oauth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_oauth_token.nil? && !token_expired?(@_oauth_token)
+    end
+
+    # Builds and returns an authorization URL.
+    # The user is expected to obtain an authorization code from this URL and then call the
+    # fetch token function with that authorization code.
+    # @param [String] state An opaque state string.
+    # @param [Hash] additional_params Any additional query parameters to be added to the URL.
+    # @return [String] The authorization URL.
+    def get_authorization_url(state: nil, additional_params: nil)
+      auth_url = @_config.get_base_uri_executor.call(Server::AUTH_SERVER)
+      auth_url += '/authorize'
+      query_params = {
+        'response_type' => 'code',
+        'client_id' => @_oauth_client_id,
+        'redirect_uri' => @_oauth_redirect_uri
+      }
+      query_params['scope'] = Array(@_o_auth_scopes).compact.join(' ') if @_o_auth_scopes
+      query_params['state'] = state if state
+      query_params.merge!(additional_params) if additional_params
+      auth_url = APIHelper.append_url_with_query_parameters(auth_url,
+                                                            query_params)
+      APIHelper.clean_url(auth_url)
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token is present and not expired.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+  end
+
+  # Data class for PetstoreAuthCredentials.
+  class PetstoreAuthCredentials
+    attr_reader :oauth_client_id, :oauth_redirect_uri, :oauth_token,
+                :oauth_scopes
+
+    def initialize(oauth_client_id:, oauth_redirect_uri:, oauth_token: nil,
+                   oauth_scopes: nil)
+      raise ArgumentError, 'oauth_client_id cannot be nil' if oauth_client_id.nil?
+      raise ArgumentError, 'oauth_redirect_uri cannot be nil' if oauth_redirect_uri.nil?
+
+      @oauth_client_id = oauth_client_id
+      @oauth_redirect_uri = oauth_redirect_uri
+      @oauth_token = oauth_token
+      @oauth_scopes = oauth_scopes
+    end
+
+    def self.from_env
+      oauth_client_id = ENV['PETSTORE_AUTH_OAUTH_CLIENT_ID']
+      oauth_redirect_uri = ENV['PETSTORE_AUTH_OAUTH_REDIRECT_URI']
+      oauth_scopes = ENV['PETSTORE_AUTH_OAUTH_SCOPES']
+      all_nil = [
+        oauth_client_id,
+        oauth_redirect_uri
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(oauth_client_id: oauth_client_id,
+          oauth_redirect_uri: oauth_redirect_uri, oauth_scopes: oauth_scopes)
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_redirect_uri: nil,
+                   oauth_token: nil, oauth_scopes: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_redirect_uri ||= self.oauth_redirect_uri
+      oauth_token ||= self.oauth_token
+      oauth_scopes ||= self.oauth_scopes
+
+      PetstoreAuthCredentials.new(oauth_client_id: oauth_client_id,
+                                  oauth_redirect_uri: oauth_redirect_uri,
+                                  oauth_token: oauth_token,
+                                  oauth_scopes: oauth_scopes)
+    end
+  end
+end

data/lib/swagger_petstore_open_api30/http/http_call_back.rb

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

data/lib/swagger_petstore_open_api30/http/http_method_enum.rb

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

data/lib/swagger_petstore_open_api30/http/http_request.rb

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

data/lib/swagger_petstore_open_api30/http/http_response.rb

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

data/lib/swagger_petstore_open_api30/http/proxy_settings.rb

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

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

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

@@ -0,0 +1,118 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # ApiResponse Model.
+  class ApiResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['type'] = 'type'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        type
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code: SKIP, type: SKIP, message: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @type = type unless type == SKIP
+      @message = message unless message == SKIP
+      @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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # 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.
+      ApiResponse.new(code: code,
+                      type: type,
+                      message: message,
+                      additional_properties: additional_properties)
+    end
+
+    def self.from_element(root)
+      code = XmlUtilities.from_element(root, 'code', Integer)
+      type = XmlUtilities.from_element(root, 'type', String)
+      message = XmlUtilities.from_element(root, 'message', String)
+
+      new(code: code,
+          type: type,
+          message: message,
+          additional_properties: additional_properties)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'code', code)
+      XmlUtilities.add_as_subelement(doc, root, 'type', type)
+      XmlUtilities.add_as_subelement(doc, root, 'message', message)
+      XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
+                                     additional_properties)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, type: #{@type}, message: #{@message},"\
+      " 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} code: #{@code.inspect}, type: #{@type.inspect}, message:"\
+      " #{@message.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end