tesla-fleet-api 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (192) hide show
  1. package/dist/_virtual/_rolldown/runtime.cjs +22 -0
  2. package/dist/_virtual/_rolldown/runtime.mjs +12 -0
  3. package/dist/charging.cjs +53 -0
  4. package/dist/charging.d.cts +31 -0
  5. package/dist/charging.d.mts +30 -0
  6. package/dist/charging.mjs +53 -0
  7. package/dist/commands.cjs +802 -0
  8. package/dist/commands.d.cts +350 -0
  9. package/dist/commands.d.mts +349 -0
  10. package/dist/commands.mjs +800 -0
  11. package/dist/const.cjs +300 -0
  12. package/dist/const.d.cts +287 -0
  13. package/dist/const.d.mts +287 -0
  14. package/dist/const.mjs +263 -0
  15. package/dist/energy.cjs +137 -0
  16. package/dist/energy.d.cts +95 -0
  17. package/{src/energy.ts → dist/energy.d.mts} +17 -140
  18. package/dist/energy.mjs +137 -0
  19. package/dist/energyspecific.cjs +99 -0
  20. package/dist/energyspecific.d.cts +78 -0
  21. package/dist/energyspecific.d.mts +77 -0
  22. package/dist/energyspecific.mjs +99 -0
  23. package/dist/exceptions.cjs +1487 -0
  24. package/dist/exceptions.d.cts +1142 -0
  25. package/dist/exceptions.d.mts +1142 -0
  26. package/dist/exceptions.mjs +1324 -0
  27. package/dist/index.cjs +226 -0
  28. package/dist/index.d.cts +14 -0
  29. package/dist/index.d.mts +14 -0
  30. package/dist/index.mjs +14 -0
  31. package/dist/partner.cjs +32 -0
  32. package/dist/partner.d.cts +24 -0
  33. package/dist/partner.d.mts +23 -0
  34. package/dist/partner.mjs +32 -0
  35. package/dist/router.cjs +0 -0
  36. package/dist/router.d.cts +1 -0
  37. package/dist/router.d.mts +1 -0
  38. package/dist/router.mjs +1 -0
  39. package/dist/signing/crypto.cjs +31 -0
  40. package/dist/signing/crypto.mjs +27 -0
  41. package/dist/signing/session.cjs +112 -0
  42. package/dist/signing/session.d.cts +69 -0
  43. package/dist/signing/session.d.mts +69 -0
  44. package/dist/signing/session.mjs +110 -0
  45. package/dist/tariff.cjs +292 -0
  46. package/dist/{tariff.d.ts → tariff.d.cts} +17 -17
  47. package/dist/tariff.d.mts +29 -0
  48. package/dist/tariff.mjs +291 -0
  49. package/dist/teslafleetapi.cjs +125 -0
  50. package/dist/teslafleetapi.d.cts +64 -0
  51. package/dist/teslafleetapi.d.mts +64 -0
  52. package/dist/teslafleetapi.mjs +125 -0
  53. package/dist/teslemetry.cjs +36 -0
  54. package/dist/teslemetry.d.cts +23 -0
  55. package/dist/teslemetry.d.mts +23 -0
  56. package/dist/teslemetry.mjs +36 -0
  57. package/dist/tessie.cjs +34 -0
  58. package/dist/tessie.d.cts +23 -0
  59. package/dist/tessie.d.mts +23 -0
  60. package/dist/tessie.mjs +34 -0
  61. package/dist/types/commands.d.cts +28 -0
  62. package/dist/types/commands.d.mts +28 -0
  63. package/dist/types/live_status.d.cts +30 -0
  64. package/dist/types/live_status.d.mts +30 -0
  65. package/dist/types/products.d.cts +58 -0
  66. package/dist/types/products.d.mts +58 -0
  67. package/dist/types/responses.d.cts +9 -0
  68. package/dist/types/responses.d.mts +9 -0
  69. package/dist/types/site_info.d.cts +154 -0
  70. package/dist/types/site_info.d.mts +154 -0
  71. package/dist/types/vehicle.d.cts +27 -0
  72. package/dist/types/vehicle.d.mts +27 -0
  73. package/dist/types/vehicle_data.d.cts +278 -0
  74. package/dist/types/vehicle_data.d.mts +278 -0
  75. package/dist/types.cjs +0 -0
  76. package/dist/types.d.cts +9 -0
  77. package/dist/types.d.mts +9 -0
  78. package/dist/types.mjs +1 -0
  79. package/dist/user.cjs +28 -0
  80. package/dist/user.d.cts +17 -0
  81. package/dist/user.d.mts +16 -0
  82. package/dist/user.mjs +28 -0
  83. package/dist/vehicle.cjs +804 -0
  84. package/dist/vehicle.d.cts +550 -0
  85. package/dist/vehicle.d.mts +549 -0
  86. package/dist/vehicle.mjs +804 -0
  87. package/dist/vehiclesigned.cjs +20 -0
  88. package/dist/vehiclesigned.d.cts +14 -0
  89. package/dist/{vehiclesigned.d.ts → vehiclesigned.d.mts} +3 -3
  90. package/dist/vehiclesigned.mjs +20 -0
  91. package/dist/vehiclespecific.cjs +604 -0
  92. package/dist/vehiclespecific.d.cts +433 -0
  93. package/dist/vehiclespecific.d.mts +432 -0
  94. package/dist/vehiclespecific.mjs +604 -0
  95. package/package.json +108 -35
  96. package/dist/charging.d.ts +0 -30
  97. package/dist/charging.js +0 -51
  98. package/dist/charging.js.map +0 -1
  99. package/dist/commands.d.ts +0 -352
  100. package/dist/commands.js +0 -875
  101. package/dist/commands.js.map +0 -1
  102. package/dist/energy.d.ts +0 -94
  103. package/dist/energy.js +0 -125
  104. package/dist/energy.js.map +0 -1
  105. package/dist/energyspecific.d.ts +0 -77
  106. package/dist/energyspecific.js +0 -97
  107. package/dist/energyspecific.js.map +0 -1
  108. package/dist/helpers.d.ts +0 -2
  109. package/dist/helpers.js +0 -10
  110. package/dist/helpers.js.map +0 -1
  111. package/dist/index.d.ts +0 -15
  112. package/dist/index.js +0 -15
  113. package/dist/index.js.map +0 -1
  114. package/dist/partner.d.ts +0 -23
  115. package/dist/partner.js +0 -31
  116. package/dist/partner.js.map +0 -1
  117. package/dist/signing/crypto.d.ts +0 -10
  118. package/dist/signing/crypto.js +0 -26
  119. package/dist/signing/crypto.js.map +0 -1
  120. package/dist/signing/errors.d.ts +0 -29
  121. package/dist/signing/errors.js +0 -40
  122. package/dist/signing/errors.js.map +0 -1
  123. package/dist/signing/session.d.ts +0 -69
  124. package/dist/signing/session.js +0 -102
  125. package/dist/signing/session.js.map +0 -1
  126. package/dist/tariff.js +0 -302
  127. package/dist/tariff.js.map +0 -1
  128. package/dist/teslafleetapi.d.ts +0 -58
  129. package/dist/teslafleetapi.js +0 -120
  130. package/dist/teslafleetapi.js.map +0 -1
  131. package/dist/teslemetry.d.ts +0 -29
  132. package/dist/teslemetry.js +0 -39
  133. package/dist/teslemetry.js.map +0 -1
  134. package/dist/tessie.d.ts +0 -23
  135. package/dist/tessie.js +0 -28
  136. package/dist/tessie.js.map +0 -1
  137. package/dist/types/commands.d.ts +0 -44
  138. package/dist/types/commands.js +0 -11
  139. package/dist/types/commands.js.map +0 -1
  140. package/dist/types/live_status.d.ts +0 -26
  141. package/dist/types/live_status.js +0 -2
  142. package/dist/types/live_status.js.map +0 -1
  143. package/dist/types/products.d.ts +0 -54
  144. package/dist/types/products.js +0 -2
  145. package/dist/types/products.js.map +0 -1
  146. package/dist/types/responses.d.ts +0 -5
  147. package/dist/types/responses.js +0 -2
  148. package/dist/types/responses.js.map +0 -1
  149. package/dist/types/site_info.d.ts +0 -150
  150. package/dist/types/site_info.js +0 -2
  151. package/dist/types/site_info.js.map +0 -1
  152. package/dist/types/vehicle.d.ts +0 -23
  153. package/dist/types/vehicle.js +0 -10
  154. package/dist/types/vehicle.js.map +0 -1
  155. package/dist/types/vehicle_data.d.ts +0 -274
  156. package/dist/types/vehicle_data.js +0 -2
  157. package/dist/types/vehicle_data.js.map +0 -1
  158. package/dist/user.d.ts +0 -16
  159. package/dist/user.js +0 -26
  160. package/dist/user.js.map +0 -1
  161. package/dist/vehicle.d.ts +0 -548
  162. package/dist/vehicle.js +0 -774
  163. package/dist/vehicle.js.map +0 -1
  164. package/dist/vehiclesigned.js +0 -19
  165. package/dist/vehiclesigned.js.map +0 -1
  166. package/dist/vehiclespecific.d.ts +0 -432
  167. package/dist/vehiclespecific.js +0 -601
  168. package/dist/vehiclespecific.js.map +0 -1
  169. package/src/charging.ts +0 -66
  170. package/src/commands.ts +0 -1134
  171. package/src/energyspecific.ts +0 -116
  172. package/src/helpers.ts +0 -11
  173. package/src/index.ts +0 -21
  174. package/src/partner.ts +0 -37
  175. package/src/signing/crypto.ts +0 -29
  176. package/src/signing/errors.ts +0 -50
  177. package/src/signing/session.ts +0 -132
  178. package/src/tariff.ts +0 -375
  179. package/src/teslafleetapi.ts +0 -182
  180. package/src/teslemetry.ts +0 -54
  181. package/src/tessie.ts +0 -42
  182. package/src/types/commands.ts +0 -62
  183. package/src/types/live_status.ts +0 -27
  184. package/src/types/products.ts +0 -61
  185. package/src/types/responses.ts +0 -1
  186. package/src/types/site_info.ts +0 -159
  187. package/src/types/vehicle.ts +0 -33
  188. package/src/types/vehicle_data.ts +0 -286
  189. package/src/user.ts +0 -35
  190. package/src/vehicle.ts +0 -886
  191. package/src/vehiclesigned.ts +0 -20
  192. package/src/vehiclespecific.ts +0 -818
package/dist/vehicle.d.ts DELETED
@@ -1,548 +0,0 @@
1
- import TeslaFleetApi from "./teslafleetapi.js";
2
- import { ClimateMode, CommandResponse, FleetTelemetryConfig, Level, Seat, Trunk, VehicleDataEndpoint } from "./types/commands.js";
3
- import { OptionsResponse } from "./types/responses.js";
4
- import { VehicleResponse } from "./types/vehicle.js";
5
- import { VehicleDataResponse } from "./types/vehicle_data.js";
6
- import VehicleSpecific from "./vehiclespecific.js";
7
- import VehicleSigned from "./vehiclesigned.js";
8
- export default class Vehicle {
9
- parent: TeslaFleetApi;
10
- /** Fallback private key for `signed()` when a call site doesn't pass one explicitly. */
11
- private_key?: Buffer;
12
- constructor(parent: TeslaFleetApi);
13
- /**
14
- * Returns a class for a single vehicle.
15
- * @param vin
16
- * @returns
17
- */
18
- specific(vin: string): VehicleSpecific;
19
- /**
20
- * Returns a class for a single vehicle that signs commands with the
21
- * Tesla Vehicle Command Protocol and dispatches them through the Fleet
22
- * API `/signed_command` endpoint, instead of the plaintext REST commands.
23
- * @param vin
24
- * @param private_key Raw 32-byte P-256 private key scalar. Falls back to `this.private_key`.
25
- * @param public_key Uncompressed P-256 public key point. Derived from `private_key` if omitted.
26
- */
27
- signed(vin: string, private_key?: Buffer, public_key?: Buffer): VehicleSigned;
28
- /**
29
- * Return the vehicle model name
30
- * @param vin
31
- * @returns
32
- */
33
- model(vin: string): string;
34
- /**
35
- * Return if the vehicle was build before 2021 and cannot sleep without a break
36
- * @param vin
37
- * @returns
38
- */
39
- pre2021(vin: string): boolean;
40
- /**
41
- * Controls the front (which_trunk: "front") or rear (which_trunk: "rear") trunk.
42
- * @param vehicle_tag VIN or id field of a vehicle
43
- * @param which_trunk "front" or "rear"
44
- */
45
- actuate_truck(vehicle_tag: string | number, which_trunk: Trunk): Promise<CommandResponse>;
46
- /**
47
- * Adjusts vehicle media playback volume.
48
- * @param vehicle_tag VIN or id field of a vehicle
49
- * @param volume A floating point number from 0.0 to 11.0.
50
- */
51
- adjust_volume(vehicle_tag: string | number, volume: number): Promise<CommandResponse>;
52
- /**
53
- * Starts climate preconditioning.
54
- * @param vehicle_tag VIN or id field of a vehicle
55
- */
56
- auto_conditioning_start(vehicle_tag: string | number): Promise<CommandResponse>;
57
- /**
58
- * Stops climate preconditioning.
59
- * @param vehicle_tag VIN or id field of a vehicle
60
- */
61
- auto_conditioning_stop(vehicle_tag: string | number): Promise<CommandResponse>;
62
- /**
63
- * Cancels the countdown to install the vehicle software update.
64
- * @param vehicle_tag VIN or id field of a vehicle
65
- */
66
- cancel_software_update(vehicle_tag: string | number): Promise<CommandResponse>;
67
- /**
68
- * Charges in max range mode -- we recommend limiting the use of this mode to long trips.
69
- * @param vehicle_tag VIN or id field of a vehicle
70
- */
71
- charge_max_range(vehicle_tag: string | number): Promise<CommandResponse>;
72
- /**
73
- * Closes the charge port door.
74
- * @param vehicle_tag VIN or id field of a vehicle
75
- */
76
- charge_port_door_close(vehicle_tag: string | number): Promise<CommandResponse>;
77
- /**
78
- * Opens the charge port door.
79
- * @param vehicle_tag VIN or id field of a vehicle
80
- */
81
- charge_port_door_open(vehicle_tag: string | number): Promise<CommandResponse>;
82
- /**
83
- * Charges in Standard mode.
84
- * @param vehicle_tag VIN or id field of a vehicle
85
- */
86
- charge_standard(vehicle_tag: string | number): Promise<CommandResponse>;
87
- /**
88
- * Starts charging the vehicle.
89
- * @param vehicle_tag VIN or id field of a vehicle
90
- */
91
- charge_start(vehicle_tag: string | number): Promise<CommandResponse>;
92
- /**
93
- * Stops charging the vehicle.
94
- * @param vehicle_tag VIN or id field of a vehicle
95
- */
96
- charge_stop(vehicle_tag: string | number): Promise<CommandResponse>;
97
- /**
98
- * 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.
99
- * @param vehicle_tag VIN or id field of a vehicle
100
- */
101
- clear_pin_to_drive_admin(vehicle_tag: string | number): Promise<CommandResponse>;
102
- /**
103
- * Locks the vehicle.
104
- * @param vehicle_tag VIN or id field of a vehicle
105
- */
106
- door_lock(vehicle_tag: string | number): Promise<CommandResponse>;
107
- /**
108
- * Unlocks the vehicle.
109
- * @param vehicle_tag VIN or id field of a vehicle
110
- */
111
- door_unlock(vehicle_tag: string | number): Promise<CommandResponse>;
112
- /**
113
- * Erases user's data from the user interface. Requires the vehicle to be in park.
114
- * @param vehicle_tag VIN or id field of a vehicle
115
- */
116
- erase_user_data(vehicle_tag: string | number): Promise<CommandResponse>;
117
- /**
118
- * Briefly flashes the vehicle headlights. Requires the vehicle to be in park.
119
- * @param vehicle_tag VIN or id field of a vehicle
120
- */
121
- flash_lights(vehicle_tag: string | number): Promise<CommandResponse>;
122
- /**
123
- * Restricts certain vehicle UI functionality from guest users
124
- * @param vehicle_tag VIN or id field of a vehicle
125
- * @param enable `true` or `false`
126
- */
127
- guest_mode(vehicle_tag: string | number, enable: boolean): Promise<CommandResponse>;
128
- /**
129
- * Honks the vehicle horn. Requires the vehicle to be in park.
130
- * @param vehicle_tag VIN or id field of a vehicle
131
- */
132
- honk_horn(vehicle_tag: string | number): Promise<CommandResponse>;
133
- /**
134
- * Advances media player to next favorite track.
135
- * @param vehicle_tag VIN or id field of a vehicle
136
- */
137
- media_next_fav(vehicle_tag: string | number): Promise<CommandResponse>;
138
- /**
139
- * Advances media player to next track.
140
- * @param vehicle_tag VIN or id field of a vehicle
141
- */
142
- media_next_track(vehicle_tag: string | number): Promise<CommandResponse>;
143
- /**
144
- * Advances media player to previous favorite track.
145
- * @param vehicle_tag VIN or id field of a vehicle
146
- */
147
- media_prev_fav(vehicle_tag: string | number): Promise<CommandResponse>;
148
- /**
149
- * Advances media player to previous track.
150
- * @param vehicle_tag VIN or id field of a vehicle
151
- */
152
- media_prev_track(vehicle_tag: string | number): Promise<CommandResponse>;
153
- /**
154
- * Toggles current play/pause state.
155
- * @param vehicle_tag VIN or id field of a vehicle
156
- */
157
- media_toggle_playback(vehicle_tag: string | number): Promise<CommandResponse>;
158
- /**
159
- * Turns the volume down by one.
160
- * @param vehicle_tag VIN or id field of a vehicle
161
- */
162
- media_volume_down(vehicle_tag: string | number): Promise<CommandResponse>;
163
- /**
164
- * Start navigation to given coordinates. Order can be used to specify order of multiple stops.
165
- * @param vehicle_tag VIN or id field of a vehicle
166
- * @param lat Latitude
167
- * @param lon Longitude
168
- * @param order Order of multiple stops
169
- */
170
- navigation_gps_request(vehicle_tag: string | number, lat: number, lon: number, order?: number): Promise<CommandResponse>;
171
- /**
172
- * Sends a location to the in-vehicle navigation system.
173
- * @param vehicle_tag VIN or id field of a vehicle
174
- * @param type "share_ext_content_raw"
175
- * @param locale ISO locale such as "en-US"
176
- * @param timestamp_ms
177
- */
178
- navigation_request(vehicle_tag: string | number, value: string, locale: string, type?: string): Promise<CommandResponse>;
179
- /**
180
- * Start navigation to a supercharger.
181
- * @param vehicle_tag VIN or id field of a vehicle
182
- * @param id Supercharger ID
183
- * @param order Order of multiple stops
184
- * @returns
185
- */
186
- navigation_sc_request(vehicle_tag: string | number, id: number, order?: number): Promise<CommandResponse>;
187
- /**
188
- * Sets automatic seat heating and cooling.
189
- * @param vehicle_tag VIN or id field of a vehicle
190
- * @param auto_seat_position Seat position
191
- * @param auto_climate_on `true` or `false`
192
- */
193
- remote_auto_seat_climate_request(vehicle_tag: string | number, auto_seat_position: Seat | number, auto_climate_on: boolean): Promise<CommandResponse>;
194
- /**
195
- * Sets automatic steering wheel heating on/off.
196
- * @param vehicle_tag VIN or id field of a vehicle
197
- * @param on `true` or `false`
198
- */
199
- remote_auto_steering_wheel_heat_climate_request(vehicle_tag: string | number, on: boolean): Promise<CommandResponse>;
200
- /**
201
- * Plays a sound through the vehicle external speaker.
202
- * @param vehicle_tag VIN or id field of a vehicle
203
- * @param sound Fart is `0`, Locate ping is `2000`
204
- */
205
- remote_boombox(vehicle_tag: string | number, sound?: number): Promise<CommandResponse>;
206
- /**
207
- * Sets seat cooling.
208
- * @param vehicle_tag VIN or id field of a vehicle
209
- * @param seat_position Seat position
210
- * @param seat_cooler_level Cooling level
211
- */
212
- remote_seat_cooler_request(vehicle_tag: string | number, seat_position: Seat | number, seat_cooler_level: Level): Promise<CommandResponse>;
213
- /**
214
- * Sets seat heating.
215
- * @param vehicle_tag VIN or id field of a vehicle
216
- * @param seat_position Seat position
217
- * @param seat_heater_level Heating level
218
- */
219
- remote_seat_heater_request(vehicle_tag: string | number, seat_position: Seat | number, seat_heater_level: Level): Promise<CommandResponse>;
220
- /**
221
- * Starts the vehicle remotely. Requires keyless driving to be enabled.
222
- * @param vehicle_tag VIN or id field of a vehicle
223
- */
224
- remote_start_drive(vehicle_tag: string | number): Promise<CommandResponse>;
225
- /**
226
- * Sets steering wheel heat level.
227
- * @param vehicle_tag VIN or id field of a vehicle
228
- * @param level Heating level
229
- */
230
- remote_steering_wheel_heat_level_request(vehicle_tag: string | number, level: Level): Promise<CommandResponse>;
231
- /**
232
- * Sets steering wheel heating on/off. For vehicles that do not support auto steering wheel heat.
233
- * @param vehicle_tag VIN or id field of a vehicle
234
- * @param on `true` or `false`
235
- */
236
- remote_steering_wheel_heater_request(vehicle_tag: string | number, on: boolean): Promise<CommandResponse>;
237
- /**
238
- * 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.
239
- * @param vehicle_tag VIN or id field of a vehicle
240
- */
241
- reset_pin_to_drive_pin(vehicle_tag: string | number): Promise<CommandResponse>;
242
- /**
243
- * Removes PIN for Valet Mode.
244
- * @param vehicle_tag VIN or id field of a vehicle
245
- */
246
- reset_valet_pin(vehicle_tag: string | number): Promise<CommandResponse>;
247
- /**
248
- * Schedules a vehicle software update (over the air "OTA") to be installed in the future.
249
- * @param vehicle_tag VIN or id field of a vehicle
250
- * @param offset_sec Offset in seconds
251
- */
252
- schedule_software_update(vehicle_tag: string | number, offset_sec: number): Promise<CommandResponse>;
253
- /**
254
- * Turns Bioweapon Defense Mode on and off.
255
- * @param vehicle_tag VIN or id field of a vehicle
256
- * @param on `true` or `false`
257
- * @param manual_override `true` or `false`
258
- */
259
- set_bioweapon_mode(vehicle_tag: string | number, on: boolean, manual_override: boolean): Promise<CommandResponse>;
260
- /**
261
- * Sets the vehicle overheat protection.
262
- * @param vehicle_tag VIN or id field of a vehicle
263
- * @param on `true` or `false`
264
- * @param fan_only `true` or `false`
265
- */
266
- set_cabin_overheat_protection(vehicle_tag: string | number, on: boolean, fan_only: boolean): Promise<CommandResponse>;
267
- /**
268
- * Sets the vehicle's charge limit to a custom percentage.
269
- * @param vehicle_tag VIN or id field of a vehicle
270
- * @param percent Charge limit percentage typically between 50-100
271
- */
272
- set_charge_limit(vehicle_tag: string | number, percent: number): Promise<CommandResponse>;
273
- /**
274
- * Sets the charge limit to the standard setting.
275
- * @param vehicle_tag VIN or id field of a vehicle
276
- * @param percent Current limit in Amps typically between 5-32
277
- */
278
- set_charging_amps(vehicle_tag: string | number, charging_amps: number): Promise<CommandResponse>;
279
- /**
280
- * Enables climate keeper mode.
281
- * @param vehicle_tag VIN or id field of a vehicle
282
- * @param climate_keeper_mode `0` is Off, `1` is Keep, `2` is Dog, `3` is Camp
283
- */
284
- set_climate_keeper_mode(vehicle_tag: string | number, climate_keeper_mode: number | ClimateMode): Promise<CommandResponse>;
285
- /**
286
- * Adjusts the Cabin Overheat Protection temperature (COP).
287
- * @param vehicle_tag VIN or id field of a vehicle
288
- * @param cop_temp Integer representing Low (0/30C/90F), Medium (1/35C/95F), or High (2/40C/100F)
289
- */
290
- set_cop_temp(vehicle_tag: string | number, cop_temp: 0 | 1 | 2 | 30 | 35 | 40 | 90 | 95 | 100): Promise<CommandResponse>;
291
- /**
292
- * Sets a four-digit passcode for PIN to Drive. This PIN must then be entered before the vehicle can be driven.
293
- * @param vehicle_tag VIN or id field of a vehicle
294
- * @param on `true` or `false`
295
- * @param password Four-digit passcode
296
- */
297
- set_pin_to_drive(vehicle_tag: string | number, on: boolean, password: string | number): Promise<CommandResponse>;
298
- /**
299
- * Sets an override for preconditioning — it should default to empty if no override is used.
300
- * Also known as "Defrost Mode"
301
- * @param vehicle_tag VIN or id field of a vehicle
302
- * @param on `true` or `false`
303
- * @param manual_override `true` or `false`
304
- */
305
- set_preconditioning_max(vehicle_tag: string | number, on: boolean, manual_override: boolean): Promise<CommandResponse>;
306
- /**
307
- * 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).
308
- * @param vehicle_tag VIN or id field of a vehicle
309
- * @param enable `true` or `false`
310
- * @param time Minutes after midnight
311
- */
312
- set_scheduled_charging(vehicle_tag: string | number, enable: boolean, time: number): Promise<CommandResponse>;
313
- /**
314
- * 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).
315
- * @param vehicle_tag VIN or id field of a vehicle
316
- * @param enable `true` or `false`
317
- * @param preconditioning_enabled `true` or `false`
318
- * @param preconditioning_weekdays_only `true` or `false`
319
- * @param departure_time Minutes after midnight
320
- * @param off_peak_charging_enabled `true` or `false`
321
- * @param off_peak_charging_weekdays_only `true` or `false`
322
- * @param end_off_peak_time Minutes after midnight
323
- */
324
- set_scheduled_departure(vehicle_tag: string | number, enable?: boolean, preconditioning_enabled?: boolean, preconditioning_weekdays_only?: boolean, departure_time?: number, off_peak_charging_enabled?: boolean, off_peak_charging_weekdays_only?: boolean, end_off_peak_time?: number): Promise<CommandResponse>;
325
- /**
326
- * 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.
327
- * @param vehicle_tag VIN or id field of a vehicle
328
- * @param on `true` or `false`
329
- */
330
- set_sentry_mode(vehicle_tag: string | number, on: boolean): Promise<CommandResponse>;
331
- /**
332
- * Sets the driver and/or passenger-side cabin temperature (and other zones if sync is enabled).
333
- * @param vehicle_tag VIN or id field of a vehicle
334
- * @param driver_temp Driver temperature
335
- * @param passenger_temp Passenger temperature
336
- */
337
- set_temps(vehicle_tag: string | number, driver_temp: number, passenger_temp: number): Promise<CommandResponse>;
338
- /**
339
- * Turns on Valet Mode and sets a four-digit passcode that must then be entered to disable Valet Mode.
340
- * @param vehicle_tag VIN or id field of a vehicle
341
- * @param on `true` or `false`
342
- * @param password Four-digit passcode
343
- */
344
- set_valet_mode(vehicle_tag: string | number, on: boolean, password: string | number): Promise<CommandResponse>;
345
- /**
346
- * 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.
347
- * @param vehicle_tag VIN or id field of a vehicle
348
- * @param vehicle_name New name
349
- */
350
- set_vehicle_name(vehicle_tag: string | number, vehicle_name: string): Promise<CommandResponse>;
351
- /**
352
- * Activates Speed Limit Mode with a four-digit PIN.
353
- * @param vehicle_tag VIN or id field of a vehicle
354
- * @param pin Four-digit PIN
355
- */
356
- speed_limit_activate(vehicle_tag: string | number, pin: string | number): Promise<CommandResponse>;
357
- /**
358
- * Deactivates Speed Limit Mode and resets the associated PIN.
359
- * @param vehicle_tag VIN or id field of a vehicle
360
- * @param pin Four-digit PIN
361
- */
362
- speed_limit_clear_pin(vehicle_tag: string | number, pin: string | number): Promise<CommandResponse>;
363
- /**
364
- * 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.
365
- * @param vehicle_tag VIN or id field of a vehicle
366
- */
367
- speed_limit_clear_pin_admin(vehicle_tag: string | number): Promise<CommandResponse>;
368
- /**
369
- * Deactivates Speed Limit Mode.
370
- * @param vehicle_tag VIN or id field of a vehicle
371
- * @param pin Four-digit PIN
372
- */
373
- speed_limit_deactivate(vehicle_tag: string | number, pin: string | number): Promise<CommandResponse>;
374
- /**
375
- * Sets the maximum speed allowed when Speed Limit Mode is active.
376
- * @param vehicle_tag VIN or id field of a vehicle
377
- * @param limit_mph Maximum speed in MPH
378
- */
379
- speed_limit_set_limit(vehicle_tag: string | number, limit_mph: number): Promise<CommandResponse>;
380
- /**
381
- * Controls the panoramic sunroof on the Model S.
382
- * @param vehicle_tag VIN or id field of a vehicle
383
- * @param state "stop", "close" or "vent"
384
- */
385
- sun_roof_control(vehicle_tag: string | number, state: "stop" | "close" | "vent"): Promise<CommandResponse>;
386
- /**
387
- * Records a drive note. The note parameter is truncated to 80 characters in length.
388
- * @param vehicle_tag VIN or id field of a vehicle
389
- * @param note Drive note
390
- */
391
- take_drivenote(vehicle_tag: string | number, note: string): Promise<CommandResponse>;
392
- /**
393
- * Turns on HomeLink (used to open and close garage doors).
394
- * @param vehicle_tag VIN or id field of a vehicle
395
- * @param token
396
- * @param lat Latitude
397
- * @param lon Longitude
398
- */
399
- trigger_homelink(vehicle_tag: string | number, lat: number, lon: number, token?: string): Promise<CommandResponse>;
400
- /**
401
- * Upcoming calendar entries stored on the vehicle.
402
- * @param vehicle_tag VIN or id field of a vehicle
403
- * @param calendar_data Calendar data
404
- */
405
- upcoming_calendar_entries(vehicle_tag: string | number, calendar_data: string): Promise<CommandResponse>;
406
- /**
407
- * 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).
408
- * @param vehicle_tag VIN or id field of a vehicle
409
- * @param command "vent" or "close"
410
- * @param lat Latitude
411
- * @param lon Longitude
412
- */
413
- window_control(vehicle_tag: string | number, command: "vent" | "close", lat: number, lon: number): Promise<CommandResponse>;
414
- /**
415
- * Returns all allowed drivers for a vehicle. This endpoint is only available for the vehicle owner.
416
- * @param vehicle_tag VIN or id field of a vehicle
417
- */
418
- drivers(vehicle_tag: string | number): Promise<Record<string, any>[]>;
419
- /**
420
- * Removes driver access from a vehicle. Share users can only remove their own access. Owners can remove share access or their own.
421
- * @param vehicle_tag VIN or id field of a vehicle
422
- * @param share_user_id
423
- */
424
- drivers_remove(vehicle_tag: string | number, share_user_id?: number): Promise<Record<string, any>>;
425
- /**
426
- * Returns eligible vehicle subscriptions.
427
- * @param vin Vehicle Identification Number
428
- */
429
- eligible_subscriptions(vin: string): Promise<Record<string, any>>;
430
- /**
431
- * Returns eligibile vehicle upgrades.
432
- * @param vin Vehicle Identification Number
433
- */
434
- eligible_upgrades(vin: string): Promise<Record<string, any>>;
435
- /**
436
- * Checks whether vehicles can accept Tesla commands protocol for the partner's public key
437
- * @param vins list of Vehicle Identification Number
438
- * @returns
439
- */
440
- fleet_status(vins: Array<string>): Promise<Record<string, any>>;
441
- /**
442
- * 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.
443
- * @param config A dictionary description the fleet telemetry configuration
444
- * @returns
445
- */
446
- fleet_telemetry_config(config: FleetTelemetryConfig): Promise<Record<string, any>>;
447
- /**
448
- * Disconnects vehicles to stream telemetry data to self hosted fleet-telemetry server.
449
- * @param vehicle_tag VIN or id field of a vehicle
450
- * @returns
451
- */
452
- fleet_telemetry_config_delete(vehicle_tag: string | number): Promise<Record<string, any>>;
453
- /**
454
- * 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.
455
- * @param vehicle_tag VIN or id field of a vehicle
456
- * @returns
457
- */
458
- fleet_telemetry_config_get(vehicle_tag: string | number): Promise<Record<string, any>>;
459
- /**
460
- * Returns vehicles belonging to the account.
461
- * @param page Page number
462
- * @param per_page Number of items per page
463
- */
464
- list(page?: number, per_page?: number): Promise<Record<string, any>>;
465
- /**
466
- * Returns whether or not mobile access is enabled for the vehicle.
467
- * @param vehicle_tag VIN or id field of a vehicle
468
- */
469
- mobile_enabled(vehicle_tag: string | number): Promise<Record<string, any>>;
470
- /**
471
- * Returns the charging sites near the current location of the vehicle.
472
- * @param vehicle_tag VIN or id field of a vehicle
473
- * @param count
474
- * @param radius
475
- * @param detail
476
- */
477
- nearby_charging_sites(vehicle_tag: string | number, count?: number, radius?: number, detail?: boolean): Promise<Record<string, any>>;
478
- /**
479
- * Returns vehicle option details.
480
- * @param vin Vehicle Identification Number
481
- */
482
- options(vin: string): Promise<OptionsResponse>;
483
- /**
484
- * List of recent alerts
485
- * @param vehicle_tag VIN or id field of a vehicle
486
- */
487
- recent_alerts(vehicle_tag: string | number): Promise<Record<string, any>>;
488
- /**
489
- * Returns firmware release notes.
490
- * @param vehicle_tag VIN or id field of a vehicle
491
- * @param staged
492
- * @param language
493
- */
494
- release_notes(vehicle_tag: string | number, staged?: boolean, language?: string): Promise<Record<string, any>>;
495
- /**
496
- * Returns service data.
497
- * @param vehicle_tag VIN or id field of a vehicle
498
- */
499
- service_data(vehicle_tag: string | number): Promise<Record<string, any>>;
500
- /**
501
- * Returns the share invites for a vehicle.
502
- * @param vehicle_tag VIN or id field of a vehicle
503
- */
504
- share_invites(vehicle_tag: string | number): Promise<Record<string, any>>;
505
- /**
506
- * Creates a share invite for a vehicle.
507
- * @param vehicle_tag VIN or id field of a vehicle
508
- */
509
- share_invites_create(vehicle_tag: string | number): Promise<Record<string, any>>;
510
- /**
511
- * Redeems a share invite.
512
- * @param code
513
- */
514
- share_invites_redeem(code: string): Promise<Record<string, any>>;
515
- /**
516
- * Revokes a share invite.
517
- * @param vehicle_tag VIN or id field of a vehicle
518
- * @param id
519
- */
520
- share_invites_revoke(vehicle_tag: string | number, id: string): Promise<Record<string, any>>;
521
- /**
522
- * Signed Commands is a generic endpoint replacing legacy commands.
523
- * @param vehicle_tag VIN or id field of a vehicle
524
- * @param routable_message
525
- */
526
- signed_command(vehicle_tag: string | number, routable_message: string): Promise<Record<string, any>>;
527
- /**
528
- * Returns information about a vehicle.
529
- * @param vehicle_tag VIN or id field of a vehicle
530
- */
531
- vehicle(vehicle_tag: string | number): Promise<VehicleResponse>;
532
- /**
533
- * 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.
534
- * @param vehicle_tag VIN or id field of a vehicle
535
- * @param endpoints
536
- */
537
- vehicle_data(vehicle_tag: string | number, endpoints?: VehicleDataEndpoint[] | string): Promise<VehicleDataResponse>;
538
- /**
539
- * Wakes the vehicle from sleep, which is a state to minimize idle energy consumption.
540
- * @param vehicle_tag VIN or id field of a vehicle
541
- */
542
- wake_up(vehicle_tag: string | number): Promise<Record<string, any>>;
543
- /**
544
- * Returns warranty details.
545
- * @param vin
546
- */
547
- warranty_details(vin: string): Promise<Record<string, any>>;
548
- }