tesla-fleet-api 0.0.5 → 0.0.7

package/dist/vehicle.js

@@ -1,90 +1,233 @@
 import { ClimateModes, Seats } from "./types.js";
 import VehicleSpecific from "./vehiclespecific.js";
+const Models = {
+    S: "Model S",
+    "3": "Model 3",
+    X: "Model X",
+    Y: "Model Y",
+    C: "Cybertruck",
+    T: "Semi",
+};
 export default class Vehicle {
     constructor(parent) {
         this.parent = parent;
     }
+    /**
+     * Returns a class for a single vehicle.
+     * @param vin
+     * @returns
+     */
     specific(vin) {
         return new VehicleSpecific(this, vin);
     }
+    /**
+     * Return the vehicle model name
+     * @param vin
+     * @returns
+     */
+    model(vin) {
+        return Models?.[vin[3]] || "Unknown";
+    }
+    /**
+     * Return if the vehicle was build before 2021 and cannot sleep without a break
+     * @param vin
+     * @returns
+     */
+    pre2021(vin) {
+        return (vin[3] === "S" || vin[3] === "X") && vin[9] < "L";
+    }
+    // Vehicle Commands
+    /**
+     * Controls the front (which_trunk: "front") or rear (which_trunk: "rear") trunk.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param which_trunk "front" or "rear"
+     */
     async actuate_truck(vehicle_tag, which_trunk) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/actuate_trunk`, null, { which_trunk });
     }
+    /**
+     * Adjusts vehicle media playback volume.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param volume A floating point number from 0.0 to 11.0.
+     */
     async adjust_volume(vehicle_tag, volume) {
         if (volume < 0 || volume > 11) {
             throw new Error("Volume must a number from 0.0 to 11.0");
         }
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/adjust_volume`, null, { volume });
     }
+    /**
+     * Starts climate preconditioning.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async auto_conditioning_start(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/auto_conditioning_start`);
     }
+    /**
+     * Stops climate preconditioning.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async auto_conditioning_stop(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/auto_conditioning_stop`);
     }
+    /**
+     * Cancels the countdown to install the vehicle software update.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async cancel_software_update(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/cancel_software_update`);
     }
+    /**
+     * Charges in max range mode -- we recommend limiting the use of this mode to long trips.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async charge_max_range(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/charge_max_range`);
     }
+    /**
+     * Closes the charge port door.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async charge_port_door_close(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/charge_port_door_close`);
     }
+    /**
+     * Opens the charge port door.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async charge_port_door_open(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/charge_port_door_open`);
     }
+    /**
+     * Charges in Standard mode.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async charge_standard(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/charge_standard`);
     }
+    /**
+     * Starts charging the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async charge_start(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/charge_start`);
     }
+    /**
+     * Stops charging the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async charge_stop(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/charge_stop`);
     }
+    /**
+     * Deactivates PIN to Drive and resets the associated PIN for vehicles running firmware versions 2023.44+. This command is only accessible to fleet managers or owners.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async clear_pin_to_drive_admin(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/clear_pin_to_drive_admin`);
     }
+    /**
+     * Locks the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async door_lock(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/door_lock`);
     }
+    /**
+     * Unlocks the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async door_unlock(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/door_unlock`);
     }
+    /**
+     * Erases user's data from the user interface. Requires the vehicle to be in park.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async erase_user_data(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/erase_user_data`);
     }
+    /**
+     * Briefly flashes the vehicle headlights. Requires the vehicle to be in park.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async flash_lights(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/flash_lights`);
     }
+    /**
+     * Restricts certain vehicle UI functionality from guest users
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param enable `true` or `false`
+     */
     async guest_mode(vehicle_tag, enable) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/guest_mode`, null, { enable });
     }
+    /**
+     * Honks the vehicle horn. Requires the vehicle to be in park.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async honk_horn(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/honk_horn`);
     }
+    /**
+     * Advances media player to next favorite track.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async media_next_fav(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/media_next_fav`);
     }
+    /**
+     * Advances media player to next track.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async media_next_track(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/media_next_track`);
     }
+    /**
+     * Advances media player to previous favorite track.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async media_prev_fav(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/media_prev_fav`);
     }
+    /**
+     * Advances media player to previous track.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async media_prev_track(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/media_prev_track`);
     }
+    /**
+     * Toggles current play/pause state.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async media_toggle_playback(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/media_toggle_playback`);
     }
+    /**
+     * Turns the volume down by one.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async media_volume_down(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/media_volume_down`);
     }
+    /**
+     * Start navigation to given coordinates. Order can be used to specify order of multiple stops.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param lat Latitude
+     * @param lon Longitude
+     * @param order Order of multiple stops
+     */
     async navigation_gps_request(vehicle_tag, lat, lon, order) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/navigation_gps_request`, null, { lat, lon, order });
     }
+    /**
+     * Sends a location to the in-vehicle navigation system.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param type "share_ext_content_raw"
+     * @param locale ISO locale such as "en-US"
+     * @param timestamp_ms
+     */
     async navigation_request(vehicle_tag, value, locale, type = "share_ext_content_raw") {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/navigation_request`, null, {
             type,
@@ -95,9 +238,22 @@ export default class Vehicle {
             },
         });
     }
+    /**
+     * Start navigation to a supercharger.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param id Supercharger ID
+     * @param order Order of multiple stops
+     * @returns
+     */
     async navigation_sc_request(vehicle_tag, id, order) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/navigation_sc_request`, null, { id, order });
     }
+    /**
+     * Sets automatic seat heating and cooling.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param auto_seat_position Seat position
+     * @param auto_climate_on `true` or `false`
+     */
     async remote_auto_seat_climate_request(vehicle_tag, auto_seat_position, auto_climate_on) {
         if (typeof auto_seat_position === "string") {
             auto_seat_position = Seats[auto_seat_position];
@@ -107,12 +263,28 @@ export default class Vehicle {
             auto_climate_on,
         });
     }
+    /**
+     * Sets automatic steering wheel heating on/off.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     */
     async remote_auto_steering_wheel_heat_climate_request(vehicle_tag, on) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/remote_auto_steering_wheel_heat_climate_request`, null, { on });
     }
+    /**
+     * Plays a sound through the vehicle external speaker.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param sound Fart is `0`, Locate ping is `2000`
+     */
     async remote_boombox(vehicle_tag, sound = 0) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/remote_boombox`, null, { sound });
     }
+    /**
+     * Sets seat cooling.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param seat_position Seat position
+     * @param seat_cooler_level Cooling level
+     */
     async remote_seat_cooler_request(vehicle_tag, seat_position, seat_cooler_level) {
         if (typeof seat_position === "string") {
             seat_position = Seats[seat_position];
@@ -122,6 +294,12 @@ export default class Vehicle {
             seat_cooler_level,
         });
     }
+    /**
+     * Sets seat heating.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param seat_position Seat position
+     * @param seat_heater_level Heating level
+     */
     async remote_seat_heater_request(vehicle_tag, seat_position, seat_heater_level) {
         if (typeof seat_position === "string") {
             seat_position = Seats[seat_position];
@@ -131,42 +309,101 @@ export default class Vehicle {
             seat_heater_level,
         });
     }
+    /**
+     * Starts the vehicle remotely. Requires keyless driving to be enabled.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async remote_start_drive(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/remote_start_drive`);
     }
+    /**
+     * Sets steering wheel heat level.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param level Heating level
+     */
     async remote_steering_wheel_heat_level_request(vehicle_tag, level) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/remote_steering_wheel_heat_level_request`, null, { level });
     }
+    /**
+     * Sets steering wheel heating on/off. For vehicles that do not support auto steering wheel heat.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     */
     async remote_steering_wheel_heater_request(vehicle_tag, on) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/remote_steering_wheel_heater_request`, null, { on });
     }
+    /**
+     * Removes PIN to Drive. Requires the car to be in Pin to Drive mode and not in Valet mode. Note that this only works if PIN to Drive is not active. This command also requires the Tesla Vehicle Command Protocol - for more information, please see refer to the documentation here.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async reset_pin_to_drive_pin(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/reset_pin_to_drive_pin`);
     }
+    /**
+     * Removes PIN for Valet Mode.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async reset_valet_pin(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/reset_valet_pin`);
     }
+    /**
+     * Schedules a vehicle software update (over the air "OTA") to be installed in the future.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param offset_sec Offset in seconds
+     */
     async schedule_software_update(vehicle_tag, offset_sec) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/schedule_software_update`, null, { offset_sec });
     }
+    /**
+     * Turns Bioweapon Defense Mode on and off.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     * @param manual_override `true` or `false`
+     */
     async set_bioweapon_mode(vehicle_tag, on, manual_override) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_bioweapon_mode`, null, { on, manual_override });
     }
+    /**
+     * Sets the vehicle overheat protection.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     * @param fan_only `true` or `false`
+     */
     async set_cabin_overheat_protection(vehicle_tag, on, fan_only) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_cabin_overheat_protection`, null, { on, fan_only });
     }
+    /**
+     * Sets the vehicle's charge limit to a custom percentage.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param percent Charge limit percentage typically between 50-100
+     */
     async set_charge_limit(vehicle_tag, percent) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_charge_limit`, null, { percent });
     }
+    /**
+     * Sets the charge limit to the standard setting.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param percent Current limit in Amps typically between 5-32
+     */
     async set_charging_amps(vehicle_tag, charging_amps) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_charging_amps`, null, { charging_amps });
     }
+    /**
+     * Enables climate keeper mode.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param climate_keeper_mode `0` is Off, `1` is Keep, `2` is Dog, `3` is Camp
+     */
     async set_climate_keeper_mode(vehicle_tag, climate_keeper_mode) {
         if (typeof climate_keeper_mode === "string") {
             climate_keeper_mode = ClimateModes[climate_keeper_mode];
         }
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_climate_keeper_mode`, null, { climate_keeper_mode });
     }
+    /**
+     * Adjusts the Cabin Overheat Protection temperature (COP).
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param cop_temp Integer representing Low (0/30C/90F), Medium (1/35C/95F), or High (2/40C/100F)
+     */
     async set_cop_temp(vehicle_tag, cop_temp) {
         if (cop_temp >= 90) {
             cop_temp = (cop_temp - 90) / 5;
@@ -176,15 +413,45 @@ export default class Vehicle {
         }
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_cop_temp`, null, { cop_temp });
     }
+    /**
+     * Sets a four-digit passcode for PIN to Drive. This PIN must then be entered before the vehicle can be driven.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     * @param password Four-digit passcode
+     */
     async set_pin_to_drive(vehicle_tag, on, password) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_pin_to_drive`, null, { on, password: String(password) });
     }
+    /**
+     * Sets an override for preconditioning — it should default to empty if no override is used.
+     * Also known as "Defrost Mode"
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     * @param manual_override `true` or `false`
+     */
     async set_preconditioning_max(vehicle_tag, on, manual_override) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_preconditioning_max`, null, { on, manual_override });
     }
+    /**
+     * Sets a time at which charging should be completed. The time parameter is minutes after midnight (e.g: time=120 schedules charging for 2:00am vehicle local time).
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param enable `true` or `false`
+     * @param time Minutes after midnight
+     */
     async set_scheduled_charging(vehicle_tag, enable, time) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_scheduled_charging`, null, { enable, time });
     }
+    /**
+     * Sets a time at which departure should be completed. The time parameter is minutes after midnight (e.g: time=120 schedules departure for 2:00am vehicle local time).
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param enable `true` or `false`
+     * @param preconditioning_enabled `true` or `false`
+     * @param preconditioning_weekdays_only `true` or `false`
+     * @param departure_time Minutes after midnight
+     * @param off_peak_charging_enabled `true` or `false`
+     * @param off_peak_charging_weekdays_only `true` or `false`
+     * @param end_off_peak_time Minutes after midnight
+     */
     async set_scheduled_departure(vehicle_tag, enable = true, preconditioning_enabled = false, preconditioning_weekdays_only = false, departure_time = 0, off_peak_charging_enabled = false, off_peak_charging_weekdays_only = false, end_off_peak_time = 0) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_scheduled_departure`, null, {
             enable,
@@ -196,119 +463,305 @@ export default class Vehicle {
             end_off_peak_time,
         });
     }
+    /**
+     * Enables and disables Sentry Mode. Sentry Mode allows customers to watch the vehicle cameras live from the mobile app, as well as record sentry events.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     */
     async set_sentry_mode(vehicle_tag, on) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_sentry_mode`, null, { on });
     }
+    /**
+     * Sets the driver and/or passenger-side cabin temperature (and other zones if sync is enabled).
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param driver_temp Driver temperature
+     * @param passenger_temp Passenger temperature
+     */
     async set_temps(vehicle_tag, driver_temp, passenger_temp) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_temps`, null, { driver_temp, passenger_temp });
     }
+    /**
+     * Turns on Valet Mode and sets a four-digit passcode that must then be entered to disable Valet Mode.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param on `true` or `false`
+     * @param password Four-digit passcode
+     */
     async set_valet_mode(vehicle_tag, on, password) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_valet_mode`, null, { on, password: String(password) });
     }
+    /**
+     * Changes the name of a vehicle. This command also requires the Tesla Vehicle Command Protocol - for more information, please see refer to the documentation here.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param vehicle_name New name
+     */
     async set_vehicle_name(vehicle_tag, vehicle_name) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/set_vehicle_name`, null, { vehicle_name });
     }
+    /**
+     * Activates Speed Limit Mode with a four-digit PIN.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param pin Four-digit PIN
+     */
     async speed_limit_activate(vehicle_tag, pin) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/speed_limit_activate`, null, { pin: String(pin) });
     }
+    /**
+     * Deactivates Speed Limit Mode and resets the associated PIN.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param pin Four-digit PIN
+     */
     async speed_limit_clear_pin(vehicle_tag, pin) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/speed_limit_clear_pin`, null, { pin: String(pin) });
     }
+    /**
+     * Deactivates Speed Limit Mode and resets the associated PIN for vehicles running firmware versions 2023.38+. This command is only accessible to fleet managers or owners.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async speed_limit_clear_pin_admin(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/speed_limit_clear_pin_admin`);
     }
+    /**
+     * Deactivates Speed Limit Mode.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param pin Four-digit PIN
+     */
     async speed_limit_deactivate(vehicle_tag, pin) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/speed_limit_deactivate`, null, { pin: String(pin) });
     }
+    /**
+     * Sets the maximum speed allowed when Speed Limit Mode is active.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param limit_mph Maximum speed in MPH
+     */
     async speed_limit_set_limit(vehicle_tag, limit_mph) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/speed_limit_set_limit`, null, { limit_mph });
     }
+    /**
+     * Controls the panoramic sunroof on the Model S.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param state "stop", "close" or "vent"
+     */
     async sun_roof_control(vehicle_tag, state) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/sun_roof_control`, null, { state });
     }
+    /**
+     * Records a drive note. The note parameter is truncated to 80 characters in length.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param note Drive note
+     */
     async take_drivenote(vehicle_tag, note) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/take_drivenote`, null, { note });
     }
+    /**
+     * Turns on HomeLink (used to open and close garage doors).
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param token
+     * @param lat Latitude
+     * @param lon Longitude
+     */
     async trigger_homelink(vehicle_tag, lat, lon, token) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/trigger_homelink`, null, { token, lat, lon });
     }
+    /**
+     * Upcoming calendar entries stored on the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param calendar_data Calendar data
+     */
     async upcoming_calendar_entries(vehicle_tag, calendar_data) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/upcoming_calendar_entries`, null, { calendar_data });
     }
+    /**
+     * Control the windows of a parked vehicle. Supported commands: vent and close. When closing, specify lat and lon of user to ensure they are within range of vehicle (unless this is an M3 platform vehicle).
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param command "vent" or "close"
+     * @param lat Latitude
+     * @param lon Longitude
+     */
     async window_control(vehicle_tag, command, lat, lon) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/command/window_control`, null, { command, lat, lon });
     }
+    // Vehicle Endpoints
+    /**
+     * Returns all allowed drivers for a vehicle. This endpoint is only available for the vehicle owner.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async drivers(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/drivers`);
     }
+    /**
+     * Removes driver access from a vehicle. Share users can only remove their own access. Owners can remove share access or their own.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param share_user_id
+     */
     async drivers_remove(vehicle_tag, share_user_id) {
         return this.parent._request("DELETE", `api/1/vehicles/${vehicle_tag}/drivers`, null, { share_user_id });
     }
+    /**
+     * Returns eligible vehicle subscriptions.
+     * @param vin Vehicle Identification Number
+     */
     async eligible_subscriptions(vin) {
         return this.parent._request("GET", "/api/1/dx/vehicles/subscriptions/eligibility", { vin });
     }
+    /**
+     * Returns eligibile vehicle upgrades.
+     * @param vin Vehicle Identification Number
+     */
     async eligible_upgrades(vin) {
         return this.parent._request("GET", "/api/1/dx/vehicles/upgrades/eligibility", { vin });
     }
+    /**
+     * Checks whether vehicles can accept Tesla commands protocol for the partner's public key
+     * @param vins list of Vehicle Identification Number
+     * @returns
+     */
     async fleet_status(vins) {
         return this.parent._request("POST", "api/1/vehicles/fleet_status", null, { vins });
     }
+    /**
+     * Configures vehicles to connect to self-hosted fleet-telemetry server. This endpoint has concurrency 1 (status 429 will be returned if many calls are made at the same time). Multiple vehicles can be configured with a single call.
+     * @param config A dictionary description the fleet telemetry configuration
+     * @returns
+     */
     async fleet_telemetry_config(config) {
         return this.parent._request("POST", "api/1/vehicles/fleet_telemetry_config", null, config);
     }
+    /**
+     * Disconnects vehicles to stream telemetry data to self hosted fleet-telemetry server.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @returns
+     */
     async fleet_telemetry_config_delete(vehicle_tag) {
         return this.parent._request("DELETE", `api/1/vehicles/${vehicle_tag}/fleet_telemetry_config`);
     }
+    /**
+     * Fetches a vehicle's fleet telemetry config. synced set to true means the vehicle has adopted the target config. synced set to false means the vehicle will attempt to adopt the target config when it next establishes a backend connection.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @returns
+     */
     async fleet_telemetry_config_get(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/fleet_telemetry_config`);
     }
+    /**
+     * Returns vehicles belonging to the account.
+     * @param page Page number
+     * @param per_page Number of items per page
+     */
     async list(page, per_page) {
         return this.parent._request("GET", "api/1/vehicles", { page, per_page });
     }
+    /**
+     * Returns whether or not mobile access is enabled for the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async mobile_enabled(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/mobile_enabled`);
     }
+    /**
+     * Returns the charging sites near the current location of the vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param count
+     * @param radius
+     * @param detail
+     */
     async nearby_charging_sites(vehicle_tag, count, radius, detail) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/nearby_charging_sites`, { count, radius, detail });
     }
+    /**
+     * Returns vehicle option details.
+     * @param vin Vehicle Identification Number
+     */
     async options(vin) {
         return this.parent._request("GET", "api/1/dx/vehicles/options", { vin });
     }
+    /**
+     * List of recent alerts
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async recent_alerts(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/recent_alerts`);
     }
+    /**
+     * Returns firmware release notes.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param staged
+     * @param language
+     */
     async release_notes(vehicle_tag, staged, language) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/release_notes`, { staged, language });
     }
+    /**
+     * Returns service data.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async service_data(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/service_data`);
     }
+    /**
+     * Returns the share invites for a vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async share_invites(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/invitations`);
     }
+    /**
+     * Creates a share invite for a vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async share_invites_create(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/invitations`);
     }
+    /**
+     * Redeems a share invite.
+     * @param code
+     */
     async share_invites_redeem(code) {
         return this.parent._request("POST", "api/1/invitations/redeem", { code });
     }
+    /**
+     * Revokes a share invite.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param id
+     */
     async share_invites_revoke(vehicle_tag, id) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/invitations/${id}/revoke`);
     }
+    /**
+     * Signed Commands is a generic endpoint replacing legacy commands.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param routable_message
+     */
     async signed_command(vehicle_tag, routable_message) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/signed_command`, null, { routable_message });
     }
+    /**
+     * Returns information about a vehicle.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async vehicle(vehicle_tag) {
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}`);
     }
+    /**
+     * Makes a live call to the vehicle. This may return cached data if the vehicle is offline. For vehicles running firmware versions 2023.38+, location_data is required to fetch vehicle location. This will result in a location sharing icon to show on the vehicle UI.
+     * @param vehicle_tag VIN or id field of a vehicle
+     * @param endpoints
+     */
     async vehicle_data(vehicle_tag, endpoints) {
         if (typeof endpoints === "object")
             endpoints = endpoints.join(";");
         return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/vehicle_data`, null, { endpoints });
     }
+    /**
+     * Wakes the vehicle from sleep, which is a state to minimize idle energy consumption.
+     * @param vehicle_tag VIN or id field of a vehicle
+     */
     async wake_up(vehicle_tag) {
         return this.parent._request("POST", `api/1/vehicles/${vehicle_tag}/wake_up`);
     }
+    /**
+     * Returns warranty details.
+     * @param vin
+     */
     async warranty_details(vin) {
         return this.parent._request("GET", "api/1/dx/warranty/details", { vin });
     }