+
+
+
+
+
+
+
+
new Vehicle(id, token, optionsopt)
+
+
+
+
+
+
+
+
Initializes a new Vehicle to use for making requests to the Smartcar API.
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+ Attributes |
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ id |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+
+
+
+ |
+
+
+
+
+ The vehicle's unique identifier. Retrieve a user's
+vehicle id using module:smartcar.getVehicles. |
+
+
+
+
+
+
+ token |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+
+
+
+ |
+
+
+
+
+ A valid access token |
+
+
+
+
+
+
+ options |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+ Attributes |
+
+
+
+ Default |
+
+
+ Description |
+
+
+
+
+
+
+
+
+ unitSystem |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+
+ metric
+
+ |
+
+
+ The unit system to use for vehicle data
+must be either metric or imperial. |
+
+
+
+
+
+
+ version |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+
+ |
+
+
+ API version to use |
+
+
+
+
+
+
+ flags |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+
+ |
+
+
+ Object of flags where key is the name of the flag
+and value is string or boolean value. |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns make model year and id of the vehicle
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Attributes
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ batch(paths) → {Batch}
+
+
+
+
+
+
+
+
Make batch requests for supported items
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ paths |
+
+
+
+
+
+Array.<String>
+
+
+
+ |
+
+
+
+
+
+ A list of paths of endpoints to send requests to. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- on unsuccessful request. An instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Batch
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the state of charge (SOC) and remaining range of an electric or
+plug-in hybrid vehicle's battery.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Battery
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the capacity of an electric or plug-in hybrid vehicle's battery.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+BatteryCapacity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ charge() → {Charge}
+
+
+
+
+
+
+
+
Returns the current charge status of the vehicle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Charge
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Disconnect this vehicle from the connected application.
+Note: Calling this method will invalidate your token's access to the vehicle.
+You will have to reauthorize the user to your application again if you wish
+to make requests to it again.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ActionResponse
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the remaining life span of a vehicle's engine oil
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+EngineOil
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ fuel() → {Fuel}
+
+
+
+
+
+
+
+
Returns the status of the fuel remaining in the vehicle's gas tank.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Fuel
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Fetch the charge limit for an electric vehicle
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ChargeLimit
+
+
+
+
+
+
+
+
+
+
+ Example
+
+ {
+ limit: .7,
+ meta: {
+ requestId: '26c14915-0c26-43c5-8e42-9edfc2a66a0f',
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the last known location of the vehicle in geographic coordinates.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Location
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Attempts to lock the vehicle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ActionResponse
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ lockStatus() → {LockStatus}
+
+
+
+
+
+
+
+
Returns the lock status of the vehicle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+LockStatus
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the vehicle's last known odometer reading.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Odometer
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ permissions(pagingopt) → {Permissions}
+
+
+
+
+
+
+
+
Fetch the list of permissions that this application has been granted
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+ Attributes |
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ paging |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+
+ Properties
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+ Attributes |
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ limit |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+ number of permissions to return |
+
+
+
+
+
+
+ |
+
+
+
+
+
+
+ options.offset |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+ The current start index of the returned list of elements. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Permissions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ request(method, path, body, headers) → {Response}
+
+
+
+
+
+
+
+
General purpose method to make a request to a Smartcar endpoint.
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ method |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+ The HTTP request method to use. |
+
+
+
+
+
+
+ path |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+ The path to make the request to. |
+
+
+
+
+
+
+ body |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+
+ The request body. |
+
+
+
+
+
+
+ headers |
+
+
+
+
+
+Object
+
+
+
+ |
+
+
+
+
+
+ The headers to include in the request. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Response
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sendDestination(latitude, longitude) → {ActionResponse}
+
+
+
+
+
+
+
+
Send a destination to the vehicle's navigation system.
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ latitude |
+
+
+
+
+
+number
+
+
+
+ |
+
+
+
+
+
+ Latitude of the destination. Must be a valid latitude
+value between -90 and 90 (inclusive). |
+
+
+
+
+
+
+ longitude |
+
+
+
+
+
+number
+
+
+
+ |
+
+
+
+
+
+ Longitude of the destination. Must be a valid longitude
+value between -180 and 180 (inclusive). |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- An instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+- A Response object containing the status and metadata.
+
+
+ -
+ Type
+
+ -
+
+ActionResponse
+
+
+
+
+
+
+
+
+
+
+ Example
+
+ {
+ status: string,
+ meta: {
+ requestId: '26c14915-0c26-43c5-8e42-9edfc2a66a0f',
+ }
+}
+
+
+
+
+
+
+
+
+
+ serviceHistory(startDateopt, endDateopt) → {Array.<ServiceHistory>}
+
+
+
+
+
+
+
+
Returns a list of all the service records performed on the vehicle,
+filtered by the optional date range. If no dates are specified, records from the
+last year are returned.
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+ Attributes |
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ startDate |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+ The start date for the record filter, either in 'YYYY-MM-DD' or
+'YYYY-MM-DDTHH:MM:SS.SSSZ' format. |
+
+
+
+
+
+
+ endDate |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+ <optional>
+
+
+
+
+
+ |
+
+
+
+
+ The end date for the record filter, similar format to startDate. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError. See the errors section for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Array.<ServiceHistory>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ setChargeLimit(limit) → {ChargeLimit}
+
+
+
+
+
+
+
+
Set the charge limit for an electric vehicle.
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ limit |
+
+
+
+
+
+number
+
+
+
+ |
+
+
+
+
+
+ a number between 0 and 1 |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ChargeLimit
+
+
+
+
+
+
+
+
+
+
+ Example
+
+ {
+ status: string,
+ meta: {
+ requestId: '26c14915-0c26-43c5-8e42-9edfc2a66a0f',
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Attempts to start charging the vehicle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ActionResponse
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Attempts to stop charging the vehicle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ActionResponse
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ subscribe(webhookId) → {Object}
+
+
+
+
+
+
+
+
Subscribe the vehicle to given webhook Id
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ webhookId |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+ Webhook Id to subscribe to. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns the air pressure of each of the vehicle's tires.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+TirePressure
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Attempts to lock the vehicle.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+ActionResponse
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ unsubscribe(amt, webhookId) → {Meta}
+
+
+
+
+
+
+
+
Unsubscribe the vehicle from given webhook Id
+
Parameters:
+
+
+
+
+
+
+ | Name |
+
+
+ Type |
+
+
+
+
+
+ Description |
+
+
+
+
+
+
+
+
+ amt |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+ Application management token to be used as authorization |
+
+
+
+
+
+
+ webhookId |
+
+
+
+
+
+String
+
+
+
+ |
+
+
+
+
+
+ Webhook Id to unsubscribe from. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Meta
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ vin() → {Vin}
+
+
+
+
+
+
+
+
Returns the vehicle's manufacturer identifier (VIN).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Throws:
+
+
+
+
+ -
+
+
+- an instance of SmartcarError.
+See the errors section
+for all possible errors.
+
+
+
+ -
+
+ -
+ Type
+
+ -
+
+SmartcarError
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+ -
+ Type
+
+ -
+
+Vin
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+