tesla-api-sdk 1.0.0

data/lib/tesla_fleet_management_api/http/auth/oauth_2.rb

@@ -0,0 +1,154 @@
+# tesla_fleet_management_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TeslaFleetManagementApi
+  # 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
+      'Oauth2: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(oauth_2_credentials, config)
+      auth_params = {}
+      @_oauth_client_id = oauth_2_credentials.oauth_client_id unless
+        oauth_2_credentials.nil? || oauth_2_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = oauth_2_credentials.oauth_client_secret unless
+        oauth_2_credentials.nil? || oauth_2_credentials.oauth_client_secret.nil?
+      @_oauth_redirect_uri = oauth_2_credentials.oauth_redirect_uri unless
+        oauth_2_credentials.nil? || oauth_2_credentials.oauth_redirect_uri.nil?
+      @_oauth_token = oauth_2_credentials.oauth_token unless
+        oauth_2_credentials.nil? || oauth_2_credentials.oauth_token.nil?
+      @_config = config
+      @_o_auth_api = OauthAuthorizationController.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
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_oauth_client_id, @_oauth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [String] auth_code The authentication code.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(auth_code, additional_params: nil)
+      token = @_o_auth_api.request_token_oauth_2(
+        build_basic_auth_header,
+        auth_code,
+        @_oauth_redirect_uri,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    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
+
+    # Refreshes OAuth token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def refresh_token(additional_params: nil)
+      token = @_o_auth_api.refresh_token_oauth_2(
+        build_basic_auth_header,
+        @_oauth_token.refresh_token,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+  end
+
+  # Data class for Oauth2Credentials.
+  class Oauth2Credentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_redirect_uri,
+                :oauth_token
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_redirect_uri:,
+                   oauth_token: nil)
+      raise ArgumentError, 'oauth_client_id cannot be nil' if oauth_client_id.nil?
+      raise ArgumentError, 'oauth_client_secret cannot be nil' if oauth_client_secret.nil?
+      raise ArgumentError, 'oauth_redirect_uri cannot be nil' if oauth_redirect_uri.nil?
+
+      @oauth_client_id = oauth_client_id
+      @oauth_client_secret = oauth_client_secret
+      @oauth_redirect_uri = oauth_redirect_uri
+      @oauth_token = oauth_token
+    end
+
+    def self.from_env
+      oauth_client_id = ENV['OAUTH_2_OAUTH_CLIENT_ID']
+      oauth_client_secret = ENV['OAUTH_2_OAUTH_CLIENT_SECRET']
+      oauth_redirect_uri = ENV['OAUTH_2_OAUTH_REDIRECT_URI']
+      all_nil = [
+        oauth_client_id,
+        oauth_client_secret,
+        oauth_redirect_uri
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(oauth_client_id: oauth_client_id,
+          oauth_client_secret: oauth_client_secret,
+          oauth_redirect_uri: oauth_redirect_uri)
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_redirect_uri: nil, oauth_token: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_client_secret ||= self.oauth_client_secret
+      oauth_redirect_uri ||= self.oauth_redirect_uri
+      oauth_token ||= self.oauth_token
+
+      Oauth2Credentials.new(oauth_client_id: oauth_client_id,
+                            oauth_client_secret: oauth_client_secret,
+                            oauth_redirect_uri: oauth_redirect_uri,
+                            oauth_token: oauth_token)
+    end
+  end
+end

data/lib/tesla_fleet_management_api/http/http_call_back.rb

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

data/lib/tesla_fleet_management_api/http/http_method_enum.rb

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

data/lib/tesla_fleet_management_api/http/http_request.rb

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

data/lib/tesla_fleet_management_api/http/http_response.rb

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

data/lib/tesla_fleet_management_api/http/proxy_settings.rb

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

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

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

@@ -0,0 +1,76 @@
+# tesla_fleet_management_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TeslaFleetManagementApi
+  # Api1DxVehiclesOptionsResponse Model.
+  class Api1DxVehiclesOptionsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ResponseApi1DxVehiclesOptionsResponse]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @response = response unless response == 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.
+      response = ResponseApi1DxVehiclesOptionsResponse.from_hash(hash['response']) if
+        hash['response']
+
+      # 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.
+      Api1DxVehiclesOptionsResponse.new(response: response,
+                                        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} response: #{@response}, 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} response: #{@response.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tesla_fleet_management_api/models/api1_dx_warranty_details_response.rb

@@ -0,0 +1,76 @@
+# tesla_fleet_management_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TeslaFleetManagementApi
+  # Api1DxWarrantyDetailsResponse Model.
+  class Api1DxWarrantyDetailsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ResponseApi1DxWarrantyDetailsResponse]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @response = response unless response == 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.
+      response = ResponseApi1DxWarrantyDetailsResponse.from_hash(hash['response']) if
+        hash['response']
+
+      # 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.
+      Api1DxWarrantyDetailsResponse.new(response: response,
+                                        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} response: #{@response}, 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} response: #{@response.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tesla_fleet_management_api/models/api1_vehicles_mobile_enabled_response.rb

@@ -0,0 +1,75 @@
+# tesla_fleet_management_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TeslaFleetManagementApi
+  # Api1VehiclesMobileEnabledResponse Model.
+  class Api1VehiclesMobileEnabledResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MobileEnabled]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @response = response unless response == 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.
+      response = MobileEnabled.from_hash(hash['response']) if hash['response']
+
+      # 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.
+      Api1VehiclesMobileEnabledResponse.new(response: response,
+                                            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} response: #{@response}, 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} response: #{@response.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end