tesla-api-sdk 1.0.0

data/lib/tesla_fleet_management_api/controllers/vehicles_controller.rb

@@ -0,0 +1,431 @@
+# tesla_fleet_management_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TeslaFleetManagementApi
+  # VehiclesController
+  class VehiclesController < BaseController
+    # TODO: type endpoint description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_vehicles
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1VehiclesResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_vehicle(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1VehiclesResponseGetVehicle.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def mobile_enabled(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}/mobile_enabled',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1VehiclesMobileEnabledResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def nearby_charging_sites(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}/nearby_charging_sites',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1VehiclesNearbyChargingSitesResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def vehicle_live_data(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}/vehicle_data',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SiteInfoResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def wake_up_vehicle(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/1/vehicles/{vehicle_tag}/wake_up',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1VehiclesWakeUpResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vin Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def vehicle_specs(vin)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vin}/specs',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vin, key: 'vin')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SiteInfoResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vin Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def vehicle_options(vin)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/dx/vehicles/options',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(vin, key: 'vin')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1DxVehiclesOptionsResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def warranty_details
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/dx/warranty/details',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Api1DxWarrantyDetailsResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_allowed_drivers_for_a_vehicle(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}/drivers',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DriversResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def remove_driver_access_from_a_vehicle(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/api/1/vehicles/{vehicle_tag}/drivers',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SimpleOkResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vin Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_eligible_vehicle_subscriptions(vin)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/dx/vehicles/subscriptions/eligibility',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(vin, key: 'vin')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SiteInfoResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vin Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_eligible_vehicle_upgrades(vin)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/dx/vehicles/upgrades/eligibility',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(vin, key: 'vin')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SiteInfoResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vin Required parameter: TODO: type description here
+    # @param [EnterprisePayerRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def set_enterprise_payer_roles(vin,
+                                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/1/dx/enterprise/v1/{vin}/payer',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vin, key: 'vin')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vin Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_enterprise_roles_for_a_vehicle(vin)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/dx/enterprise/v1/{vin}/roles',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vin, key: 'vin')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [FleetStatusRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_fleet_status_for_vehicles(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/1/vehicles/fleet_status',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [Object] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_or_update_fleet_telemetry_configuration(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/1/vehicles/fleet_telemetry_config',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_fleet_telemetry_configuration(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}/fleet_telemetry_config',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_fleet_telemetry_configuration(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/api/1/vehicles/{vehicle_tag}/fleet_telemetry_config',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [FleetTelemetryJwsRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def configure_fleet_telemetry_using_signed_jws_token(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/1/vehicles/fleet_telemetry_config_jws',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] vehicle_tag Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_fleet_telemetry_errors_for_a_vehicle(vehicle_tag)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/1/vehicles/{vehicle_tag}/fleet_telemetry_errors',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(vehicle_tag, key: 'vehicle_tag')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/tesla_fleet_management_api/exceptions/api_exception.rb

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

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

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

@@ -0,0 +1,53 @@
+# 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 BearerAuth < 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['BEARER_AUTH_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