tesla-fleet-api 0.0.6 → 0.0.7

package/dist/charging.d.ts

@@ -2,7 +2,29 @@ import TeslaFleetApi from "./teslafleetapi.js";
 export default class Charging {
     parent: TeslaFleetApi;
     constructor(parent: TeslaFleetApi);
+    /**
+     * Returns the paginated charging history.
+     * @param vin Vehicle Identification Number (VIN) of the selected vehicle.
+     * @param startTime Start time of the windows to download charging history for (i,e "2023-07-27T11:43:45-07:00").
+     * @param endTime End time of the windows to download charging history for (i,e "2023-07-28T11:43:45-07:00").
+     * @param pageNo Current page number.
+     * @param pageSize Number of records per page.
+     * @param sortBy Field to sort by.
+     * @param sortOrder Sort order (ASC or DESC).
+     */
     history(vin?: string, startTime?: string, endTime?: string, pageNo?: number, pageSize?: number, sortBy?: string, sortOrder?: string): Promise<Record<string, any>>;
+    /**
+     * Returns a charging invoice pdf for an event from charging history.
+     * @param id Content ID. This can be obtained from the invoices.contentId of a charging history event.
+     */
     invoice(id: string): Promise<Record<string, any>>;
+    /**
+     * Returns the charging session information including pricing and energy data. This endpoint is only available for business accounts that own a fleet of vehicles.
+     * @param vin Vehicle Identification Number (VIN) of the selected vehicle.
+     * @param date_from Start date of the windows to download charging sessions.
+     * @param date_to End date of the windows to download charging sessions.
+     * @param limit Number of entities to be returned.
+     * @param offset Number of entities to be skipped.
+     */
     sessions(vin?: string, date_from?: string, date_to?: string, limit?: number, offset?: number): Promise<Record<string, any>>;
 }

package/dist/charging.js

@@ -2,6 +2,16 @@ export default class Charging {
     constructor(parent) {
         this.parent = parent;
     }
+    /**
+     * Returns the paginated charging history.
+     * @param vin Vehicle Identification Number (VIN) of the selected vehicle.
+     * @param startTime Start time of the windows to download charging history for (i,e "2023-07-27T11:43:45-07:00").
+     * @param endTime End time of the windows to download charging history for (i,e "2023-07-28T11:43:45-07:00").
+     * @param pageNo Current page number.
+     * @param pageSize Number of records per page.
+     * @param sortBy Field to sort by.
+     * @param sortOrder Sort order (ASC or DESC).
+     */
     async history(vin, startTime, endTime, pageNo, pageSize, sortBy, sortOrder) {
         return await this.parent._request("GET", "api/1/dx/charging/history", {
             vin,
@@ -13,9 +23,21 @@ export default class Charging {
             sortOrder,
         });
     }
+    /**
+     * Returns a charging invoice pdf for an event from charging history.
+     * @param id Content ID. This can be obtained from the invoices.contentId of a charging history event.
+     */
     async invoice(id) {
         return await this.parent._request("GET", `api/1/dx/charging/invoices/${id}`);
     }
+    /**
+     * Returns the charging session information including pricing and energy data. This endpoint is only available for business accounts that own a fleet of vehicles.
+     * @param vin Vehicle Identification Number (VIN) of the selected vehicle.
+     * @param date_from Start date of the windows to download charging sessions.
+     * @param date_to End date of the windows to download charging sessions.
+     * @param limit Number of entities to be returned.
+     * @param offset Number of entities to be skipped.
+     */
     async sessions(vin, date_from, date_to, limit, offset) {
         return await this.parent._request("GET", "api/1/dx/charging/sessions", {
             vin,

package/dist/charging.js.map

@@ -1 +1 @@
-{"version":3,"file":"charging.js","sourceRoot":"","sources":["../src/charging.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,OAAO,QAAQ;IAGzB,YAAY,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAYD,KAAK,CAAC,OAAO,CACT,GAAY,EACZ,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,QAAiB,EACjB,MAAe,EACf,SAAkB;QAElB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,2BAA2B,EAAE;YAClE,GAAG;YACH,SAAS;YACT,OAAO;YACP,MAAM;YACN,QAAQ;YACR,MAAM;YACN,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAMD,KAAK,CAAC,OAAO,CAAC,EAAU;QACpB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,8BAA8B,EAAE,EAAE,CAAC,CAAC;IACjF,CAAC;IAWD,KAAK,CAAC,QAAQ,CAAC,GAAY,EAAE,SAAkB,EAAE,OAAgB,EAAE,KAAc,EAAE,MAAe;QAC9F,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,4BAA4B,EAAE;YACnE,GAAG;YACH,SAAS;YACT,OAAO;YACP,KAAK;YACL,MAAM;SACT,CAAC,CAAC;IACP,CAAC;CACJ"}
+{"version":3,"file":"charging.js","sourceRoot":"","sources":["../src/charging.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,OAAO,OAAO,QAAQ;IAGzB,YAAY,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAO,CACT,GAAY,EACZ,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,QAAiB,EACjB,MAAe,EACf,SAAkB;QAElB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,2BAA2B,EAAE;YAClE,GAAG;YACH,SAAS;YACT,OAAO;YACP,MAAM;YACN,QAAQ;YACR,MAAM;YACN,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU;QACpB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,8BAA8B,EAAE,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;OAOG;IAEH,KAAK,CAAC,QAAQ,CAAC,GAAY,EAAE,SAAkB,EAAE,OAAgB,EAAE,KAAc,EAAE,MAAe;QAC9F,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,4BAA4B,EAAE;YACnE,GAAG;YACH,SAAS;YACT,OAAO;YACP,KAAK;YACL,MAAM;SACT,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/energy.d.ts

@@ -3,15 +3,90 @@ import TeslaFleetApi from "./teslafleetapi.js";
 export default class Energy {
     parent: TeslaFleetApi;
     constructor(parent: TeslaFleetApi);
+    /**
+     * Create an Energy class for a specific site.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @returns `EnergySpecific` class
+     */
     specific(energy_site_id: number): EnergySpecific;
+    /**
+     * Adjust the site's backup reserve.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.ID field of an energy site from /api/1/products endpoint.
+     * @param backup_reserve_percent The desired backup reserve percent.
+     * @returns
+     */
     backup(energy_site_id: number, backup_reserve_percent: number): Promise<Record<string, any>>;
+    /**
+     * Returns the backup (off-grid) event history of the site in duration of seconds.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     backup_history(energy_site_id: number, kind: string, start_date: string, end_date: string, period: string, time_zone: string): Promise<Record<string, any>>;
+    /**
+     * Returns the charging history of a wall connector.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     charge_history(energy_site_id: number, kind: string, start_date: string, end_date: string, time_zone: string): Promise<Record<string, any>>;
+    /**
+     * Returns the energy measurements of the site, aggregated to the requested period.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_dateStart date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     energy_history(energy_site_id: number, kind: string, start_date: string, end_date: string, period: string, time_zone: string): Promise<Record<string, any>>;
+    /**
+     * Allow/disallow charging from the grid and exporting energy to the grid.
+     * @param energy_site_id
+     * @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+     * @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+     * @returns
+     */
     grid_import_export(energy_site_id: number, disallow_charge_from_grid_with_solar_installed?: boolean | null, customer_preferred_export_rule?: string | null): Promise<Record<string, any>>;
+    /**
+     * Returns the live status of the site (power, state of energy, grid status, storm mode).
+     * @param energy_site_id
+     * @returns
+     */
     live_status(energy_site_id: number): Promise<Record<string, any>>;
+    /**
+     * Adjust the site's off-grid vehicle charging backup reserve.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+     * @returns
+     */
     off_grid_vehicle_charging_reserve(energy_site_id: number, off_grid_vehicle_charging_reserve_percent: number): Promise<Record<string, any>>;
+    /**
+     * Set the site's mode.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param default_real_mode The desired operation mode. Use autonomous for time-based control and self_consumption for self-powered mode.
+     * @returns
+     */
     operation(energy_site_id: number, default_real_mode: string): Promise<Record<string, any>>;
+    /**
+     * Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @returns
+     */
     site_info(energy_site_id: number): Promise<Record<string, any>>;
+    /**
+     * Update storm watch participation.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param enabled The storm mode participation value to set.
+     * @returns
+     */
     storm_mode(energy_site_id: number, enabled: boolean): Promise<Record<string, any>>;
 }

package/dist/energy.js

@@ -1,43 +1,119 @@
 import EnergySpecific from "./energyspecific.js";
+// Energy Class
 export default class Energy {
     constructor(parent) {
         this.parent = parent;
     }
+    /**
+     * Create an Energy class for a specific site.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @returns `EnergySpecific` class
+     */
     specific(energy_site_id) {
         return new EnergySpecific(this, energy_site_id);
     }
+    /**
+     * Adjust the site's backup reserve.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.ID field of an energy site from /api/1/products endpoint.
+     * @param backup_reserve_percent The desired backup reserve percent.
+     * @returns
+     */
     async backup(energy_site_id, backup_reserve_percent) {
         return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/backup`, null, { backup_reserve_percent });
     }
+    /**
+     * Returns the backup (off-grid) event history of the site in duration of seconds.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     async backup_history(energy_site_id, kind, start_date, end_date, period, time_zone) {
         return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/calendar_history`, null, { kind, start_date, end_date, period, time_zone });
     }
+    /**
+     * Returns the charging history of a wall connector.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     async charge_history(energy_site_id, kind, start_date, end_date, time_zone) {
         return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/telemetry_history`, null, { kind, start_date, end_date, time_zone });
     }
+    /**
+     * Returns the energy measurements of the site, aggregated to the requested period.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_dateStart date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     async energy_history(energy_site_id, kind, start_date, end_date, period, time_zone) {
         return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/calendar_history`, null, { kind, start_date, end_date, period, time_zone });
     }
+    /**
+     * Allow/disallow charging from the grid and exporting energy to the grid.
+     * @param energy_site_id
+     * @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+     * @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+     * @returns
+     */
     async grid_import_export(energy_site_id, disallow_charge_from_grid_with_solar_installed = null, customer_preferred_export_rule = null) {
         return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/grid_import_export`, null, {
             disallow_charge_from_grid_with_solar_installed,
             customer_preferred_export_rule,
         });
     }
+    /**
+     * Returns the live status of the site (power, state of energy, grid status, storm mode).
+     * @param energy_site_id
+     * @returns
+     */
     async live_status(energy_site_id) {
         return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/live_status`);
     }
+    /**
+     * Adjust the site's off-grid vehicle charging backup reserve.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+     * @returns
+     */
     async off_grid_vehicle_charging_reserve(energy_site_id, off_grid_vehicle_charging_reserve_percent) {
         return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/off_grid_vehicle_charging_reserve`, null, {
             off_grid_vehicle_charging_reserve_percent,
         });
     }
+    /**
+     * Set the site's mode.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param default_real_mode The desired operation mode. Use autonomous for time-based control and self_consumption for self-powered mode.
+     * @returns
+     */
     async operation(energy_site_id, default_real_mode) {
         return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/operation`, null, { default_real_mode });
     }
+    /**
+     * Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @returns
+     */
     async site_info(energy_site_id) {
         return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/site_info`);
     }
+    /**
+     * Update storm watch participation.
+     * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+     * @param enabled The storm mode participation value to set.
+     * @returns
+     */
     async storm_mode(energy_site_id, enabled) {
         return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/storm_mode`, null, { enabled });
     }

package/dist/energy.js.map

@@ -1 +1 @@
-{"version":3,"file":"energy.js","sourceRoot":"","sources":["../src/energy.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,MAAM;IAGvB,YAAY,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAOD,QAAQ,CAAC,cAAsB;QAC3B,OAAO,IAAI,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACpD,CAAC;IAQD,KAAK,CAAC,MAAM,CAAC,cAAsB,EAAE,sBAA8B;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,SAAS,EAAE,IAAI,EAAE,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACzH,CAAC;IAYD,KAAK,CAAC,cAAc,CAChB,cAAsB,EACtB,IAAY,EACZ,UAAkB,EAClB,QAAgB,EAChB,MAAc,EACd,SAAiB;QAEjB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,mBAAmB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzJ,CAAC;IAWD,KAAK,CAAC,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,SAAiB;QAC9G,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,oBAAoB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;IAClJ,CAAC;IAYD,KAAK,CAAC,cAAc,CAChB,cAAsB,EACtB,IAAY,EACZ,UAAkB,EAClB,QAAgB,EAChB,MAAc,EACd,SAAiB;QAEjB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,mBAAmB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzJ,CAAC;IASD,KAAK,CAAC,kBAAkB,CACpB,cAAsB,EACtB,iDAAiE,IAAI,EACrE,iCAAgD,IAAI;QAEpD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,qBAAqB,EAAE,IAAI,EAAE;YACjG,8CAA8C;YAC9C,8BAA8B;SACjC,CAAC,CAAC;IACP,CAAC;IAOD,KAAK,CAAC,WAAW,CAAC,cAAsB;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,cAAc,CAAC,CAAC;IAC3F,CAAC;IAQD,KAAK,CAAC,iCAAiC,CAAC,cAAsB,EAAE,yCAAiD;QAC7G,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,oCAAoC,EAAE,IAAI,EAAE;YAChH,yCAAyC;SAC5C,CAAC,CAAC;IACP,CAAC;IAQD,KAAK,CAAC,SAAS,CAAC,cAAsB,EAAE,iBAAyB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,YAAY,EAAE,IAAI,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACvH,CAAC;IAOD,KAAK,CAAC,SAAS,CAAC,cAAsB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,YAAY,CAAC,CAAC;IACzF,CAAC;IAQD,KAAK,CAAC,UAAU,CAAC,cAAsB,EAAE,OAAgB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,aAAa,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9G,CAAC;CACJ"}
+{"version":3,"file":"energy.js","sourceRoot":"","sources":["../src/energy.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAGjD,eAAe;AACf,MAAM,CAAC,OAAO,OAAO,MAAM;IAGvB,YAAY,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,cAAsB;QAC3B,OAAO,IAAI,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,cAAsB,EAAE,sBAA8B;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,SAAS,EAAE,IAAI,EAAE,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACzH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAChB,cAAsB,EACtB,IAAY,EACZ,UAAkB,EAClB,QAAgB,EAChB,MAAc,EACd,SAAiB;QAEjB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,mBAAmB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,SAAiB;QAC9G,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,oBAAoB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;IAClJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAChB,cAAsB,EACtB,IAAY,EACZ,UAAkB,EAClB,QAAgB,EAChB,MAAc,EACd,SAAiB;QAEjB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,mBAAmB,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CACpB,cAAsB,EACtB,iDAAiE,IAAI,EACrE,iCAAgD,IAAI;QAEpD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,qBAAqB,EAAE,IAAI,EAAE;YACjG,8CAA8C;YAC9C,8BAA8B;SACjC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,cAAsB;QACpC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,cAAc,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iCAAiC,CAAC,cAAsB,EAAE,yCAAiD;QAC7G,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,oCAAoC,EAAE,IAAI,EAAE;YAChH,yCAAyC;SAC5C,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,cAAsB,EAAE,iBAAyB;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,YAAY,EAAE,IAAI,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACvH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,cAAsB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,cAAc,YAAY,CAAC,CAAC;IACzF,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,cAAsB,EAAE,OAAgB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,cAAc,aAAa,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9G,CAAC;CACJ"}

package/dist/energyspecific.d.ts

@@ -3,14 +3,73 @@ export default class EnergySpecific {
     parent: Energy;
     energy_site_id: number;
     constructor(parent: Energy, energy_site_id: number);
+    /**
+     * Adjust the site's backup reserve.
+     * @param backup_reserve_percent The desired backup reserve percent.
+     * @returns
+     */
     backup(backup_reserve_percent: number): Promise<Record<string, any>>;
+    /**
+     * Returns the backup (off-grid) event history of the site in duration of seconds.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     backup_history(kind: string, start_date: string, end_date: string, period: string, time_zone: string): Promise<Record<string, any>>;
+    /**
+     * Returns the charging history of a wall connector.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     charge_history(kind: string, start_date: string, end_date: string, time_zone: string): Promise<Record<string, any>>;
+    /**
+     * Returns the energy history of the site in duration of seconds.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     energy_history(kind: string, start_date: string, end_date: string, period: string, time_zone: string): Promise<Record<string, any>>;
+    /**
+     * Allow/disallow charging from the grid and exporting energy to the grid.
+     * @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+     * @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+     * @returns
+     */
     grid_import_export(disallow_charge_from_grid_with_solar_installed?: boolean | null, customer_preferred_export_rule?: string | null): Promise<Record<string, any>>;
+    /**
+     * Returns the live status of the site.
+     * @returns
+     */
     live_status(): Promise<Record<string, any>>;
+    /**
+     * Adjust the site's off-grid vehicle charging backup reserve.
+     * @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+     * @returns
+     */
     off_grid_vehicle_charging_reserve(off_grid_vehicle_charging_reserve_percent: number): Promise<Record<string, any>>;
+    /**
+     * Set the site's mode.
+     * @param default_real_mode
+     * @returns
+     */
     operation(default_real_mode: string): Promise<Record<string, any>>;
+    /**
+     * Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+     */
     site_info(): Promise<Record<string, any>>;
+    /**
+     * Update storm watch participation.
+     * @param enabled The storm mode participation value to set.
+     * @returns
+     */
     storm_mode(enabled: boolean): Promise<Record<string, any>>;
 }

package/dist/energyspecific.js

@@ -1,11 +1,26 @@
+// Energy Class
 export default class EnergySpecific {
     constructor(parent, energy_site_id) {
         this.parent = parent;
         this.energy_site_id = energy_site_id;
     }
+    /**
+     * Adjust the site's backup reserve.
+     * @param backup_reserve_percent The desired backup reserve percent.
+     * @returns
+     */
     async backup(backup_reserve_percent) {
         return this.parent.parent._request("POST", `api/1/energy_sites/${this.energy_site_id}/backup`, null, { backup_reserve_percent });
     }
+    /**
+     * Returns the backup (off-grid) event history of the site in duration of seconds.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     async backup_history(kind, start_date, end_date, period, time_zone) {
         return this.parent.parent._request("GET", `api/1/energy_sites/${this.energy_site_id}/calendar_history`, null, {
             kind,
@@ -15,6 +30,14 @@ export default class EnergySpecific {
             time_zone,
         });
     }
+    /**
+     * Returns the charging history of a wall connector.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     async charge_history(kind, start_date, end_date, time_zone) {
         return this.parent.parent._request("GET", `api/1/energy_sites/${this.energy_site_id}/telemetry_history`, null, {
             kind,
@@ -23,6 +46,15 @@ export default class EnergySpecific {
             time_zone,
         });
     }
+    /**
+     * Returns the energy history of the site in duration of seconds.
+     * @param kind The kind of history to be requested. 'backup', 'charge', 'energy' are all supported.
+     * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+     * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+     * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+     * @returns
+     */
     async energy_history(kind, start_date, end_date, period, time_zone) {
         return this.parent.parent._request("GET", `api/1/energy_sites/${this.energy_site_id}/calendar_history`, null, {
             kind,
@@ -32,26 +64,54 @@ export default class EnergySpecific {
             time_zone,
         });
     }
+    /**
+     * Allow/disallow charging from the grid and exporting energy to the grid.
+     * @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+     * @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+     * @returns
+     */
     async grid_import_export(disallow_charge_from_grid_with_solar_installed = null, customer_preferred_export_rule = null) {
         return this.parent.parent._request("POST", `api/1/energy_sites/${this.energy_site_id}/grid_import_export`, null, {
             disallow_charge_from_grid_with_solar_installed,
             customer_preferred_export_rule,
         });
     }
+    /**
+     * Returns the live status of the site.
+     * @returns
+     */
     async live_status() {
         return this.parent.parent._request("GET", `api/1/energy_sites/${this.energy_site_id}/live_status`);
     }
+    /**
+     * Adjust the site's off-grid vehicle charging backup reserve.
+     * @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+     * @returns
+     */
     async off_grid_vehicle_charging_reserve(off_grid_vehicle_charging_reserve_percent) {
         return this.parent.parent._request("POST", `api/1/energy_sites/${this.energy_site_id}/off_grid_vehicle_charging_reserve`, null, {
             off_grid_vehicle_charging_reserve_percent,
         });
     }
+    /**
+     * Set the site's mode.
+     * @param default_real_mode
+     * @returns
+     */
     async operation(default_real_mode) {
         return this.parent.parent._request("POST", `api/1/energy_sites/${this.energy_site_id}/operation`, null, { default_real_mode });
     }
+    /**
+     * Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+     */
     async site_info() {
         return this.parent.parent._request("GET", `api/1/energy_sites/${this.energy_site_id}/site_info`);
     }
+    /**
+     * Update storm watch participation.
+     * @param enabled The storm mode participation value to set.
+     * @returns
+     */
     async storm_mode(enabled) {
         return this.parent.parent._request("POST", `api/1/energy_sites/${this.energy_site_id}/storm_mode`, null, { enabled });
     }

package/dist/energyspecific.js.map

@@ -1 +1 @@
-{"version":3,"file":"energyspecific.js","sourceRoot":"","sources":["../src/energyspecific.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,OAAO,cAAc;IAI/B,YAAY,MAAc,EAAE,cAAsB;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAOD,KAAK,CAAC,MAAM,CAAC,sBAA8B;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,SAAS,EAAE,IAAI,EAAE,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACrI,CAAC;IAWD,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,MAAc,EAAE,SAAiB;QACtG,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,mBAAmB,EAAE,IAAI,EAAE;YAC1G,IAAI;YACJ,UAAU;YACV,QAAQ;YACR,MAAM;YACN,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAUD,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,SAAiB;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,oBAAoB,EAAE,IAAI,EAAE;YAC3G,IAAI;YACJ,UAAU;YACV,QAAQ;YACR,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAWD,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,MAAc,EAAE,SAAiB;QACtG,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,mBAAmB,EAAE,IAAI,EAAE;YAC1G,IAAI;YACJ,UAAU;YACV,QAAQ;YACR,MAAM;YACN,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAQD,KAAK,CAAC,kBAAkB,CACpB,iDAAiE,IAAI,EACrE,iCAAgD,IAAI;QAEpD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,qBAAqB,EAAE,IAAI,EAAE;YAC7G,8CAA8C;YAC9C,8BAA8B;SACjC,CAAC,CAAC;IACP,CAAC;IAMD,KAAK,CAAC,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,cAAc,CAAC,CAAC;IACvG,CAAC;IAOD,KAAK,CAAC,iCAAiC,CAAC,yCAAiD;QACrF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,oCAAoC,EAAE,IAAI,EAAE;YAC5H,yCAAyC;SAC5C,CAAC,CAAC;IACP,CAAC;IAOD,KAAK,CAAC,SAAS,CAAC,iBAAyB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,YAAY,EAAE,IAAI,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACnI,CAAC;IAKD,KAAK,CAAC,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,YAAY,CAAC,CAAC;IACrG,CAAC;IAOD,KAAK,CAAC,UAAU,CAAC,OAAgB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,aAAa,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1H,CAAC;CACJ"}
+{"version":3,"file":"energyspecific.js","sourceRoot":"","sources":["../src/energyspecific.ts"],"names":[],"mappings":"AAEA,eAAe;AACf,MAAM,CAAC,OAAO,OAAO,cAAc;IAI/B,YAAY,MAAc,EAAE,cAAsB;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,sBAA8B;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,SAAS,EAAE,IAAI,EAAE,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACrI,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,MAAc,EAAE,SAAiB;QACtG,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,mBAAmB,EAAE,IAAI,EAAE;YAC1G,IAAI;YACJ,UAAU;YACV,QAAQ;YACR,MAAM;YACN,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,SAAiB;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,oBAAoB,EAAE,IAAI,EAAE;YAC3G,IAAI;YACJ,UAAU;YACV,QAAQ;YACR,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,UAAkB,EAAE,QAAgB,EAAE,MAAc,EAAE,SAAiB;QACtG,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,mBAAmB,EAAE,IAAI,EAAE;YAC1G,IAAI;YACJ,UAAU;YACV,QAAQ;YACR,MAAM;YACN,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACpB,iDAAiE,IAAI,EACrE,iCAAgD,IAAI;QAEpD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,qBAAqB,EAAE,IAAI,EAAE;YAC7G,8CAA8C;YAC9C,8BAA8B;SACjC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,cAAc,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iCAAiC,CAAC,yCAAiD;QACrF,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,oCAAoC,EAAE,IAAI,EAAE;YAC5H,yCAAyC;SAC5C,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,SAAS,CAAC,iBAAyB;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,YAAY,EAAE,IAAI,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACnI,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,IAAI,CAAC,cAAc,YAAY,CAAC,CAAC;IACrG,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,OAAgB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,IAAI,CAAC,cAAc,aAAa,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1H,CAAC;CACJ"}

package/dist/index.d.ts

@@ -1,4 +1,8 @@
+import Energy from "./energy.js";
+import EnergySpecific from "./energyspecific.js";
 import TeslaFleetApi from "./teslafleetapi.js";
 import Teslemetry from "./teslemetry.js";
 import Tessie from "./tessie.js";
-export { TeslaFleetApi, Teslemetry, Tessie };
+import Vehicle from "./vehicle.js";
+import VehicleSpecific from "./vehiclespecific.js";
+export { Energy, EnergySpecific, TeslaFleetApi, Teslemetry, Tessie, Vehicle, VehicleSpecific };

package/dist/index.js

@@ -1,5 +1,9 @@
+import Energy from "./energy.js";
+import EnergySpecific from "./energyspecific.js";
 import TeslaFleetApi from "./teslafleetapi.js";
 import Teslemetry from "./teslemetry.js";
 import Tessie from "./tessie.js";
-export { TeslaFleetApi, Teslemetry, Tessie };
+import Vehicle from "./vehicle.js";
+import VehicleSpecific from "./vehiclespecific.js";
+export { Energy, EnergySpecific, TeslaFleetApi, Teslemetry, Tessie, Vehicle, VehicleSpecific };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,UAAU,MAAM,iBAAiB,CAAC;AACzC,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/partner.d.ts

@@ -2,7 +2,22 @@ import TeslaFleetApi from "./teslafleetapi.js";
 export default class Partner {
     parent: TeslaFleetApi;
     constructor(parent: TeslaFleetApi);
+    /**
+     * Returns the public key associated with a domain. It can be used to ensure the registration was successful.
+     * @param domain Domain of the partner account.
+     * @returns
+     */
     public_key(domain?: string | null): Promise<Record<string, any>>;
+    /**
+     * Registers an existing account before it can be used for general API access. Each application from developer.tesla.com must complete this step.
+     * @param domain Domain of the partner account.
+     * @returns
+     */
     register(domain: string): Promise<Record<string, any>>;
+    /**
+     * Returns recent fleet telemetry errors reported by vehicles after receiving the config.
+     * @param domain Domain of the partner account.
+     * @returns
+     */
     fleet_telemetry_errors(domain: string): Promise<Record<string, any>>;
 }

package/dist/partner.js

@@ -1,13 +1,29 @@
+// Partner Class
 export default class Partner {
     constructor(parent) {
         this.parent = parent;
     }
+    /**
+     * Returns the public key associated with a domain. It can be used to ensure the registration was successful.
+     * @param domain Domain of the partner account.
+     * @returns
+     */
     async public_key(domain = null) {
         return this.parent._request("GET", "api/1/partner_accounts/public_key", { domain });
     }
+    /**
+     * Registers an existing account before it can be used for general API access. Each application from developer.tesla.com must complete this step.
+     * @param domain Domain of the partner account.
+     * @returns
+     */
     async register(domain) {
         return this.parent._request("POST", "api/1/partner_accounts", null, { domain });
     }
+    /**
+     * Returns recent fleet telemetry errors reported by vehicles after receiving the config.
+     * @param domain Domain of the partner account.
+     * @returns
+     */
     async fleet_telemetry_errors(domain) {
         return this.parent._request("GET", "api/1/partner_accounts/fleet_telemetry_errors", { domain });
     }

package/dist/partner.js.map

@@ -1 +1 @@
-{"version":3,"file":"partner.js","sourceRoot":"","sources":["../src/partner.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,OAAO,OAAO,OAAO;IAGxB,YAAY,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAOD,KAAK,CAAC,UAAU,CAAC,SAAwB,IAAI;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,mCAAmC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAOD,KAAK,CAAC,QAAQ,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,wBAAwB,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpF,CAAC;IAOD,KAAK,CAAC,sBAAsB,CAAC,MAAc;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,+CAA+C,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;CACJ"}
+{"version":3,"file":"partner.js","sourceRoot":"","sources":["../src/partner.ts"],"names":[],"mappings":"AAEA,gBAAgB;AAChB,MAAM,CAAC,OAAO,OAAO,OAAO;IAGxB,YAAY,MAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,SAAwB,IAAI;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,mCAAmC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,wBAAwB,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,sBAAsB,CAAC,MAAc;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,+CAA+C,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;CACJ"}

package/dist/teslafleetapi.d.ts

@@ -23,6 +23,14 @@ export default class TeslaFleetApi {
         userScope?: boolean;
         vehicleScope?: boolean;
     });
+    /**
+     * Make a request to the Tesla Fleet API.
+     * @param method
+     * @param path
+     * @param params
+     * @param json
+     * @returns
+     */
     _request(method: Method, path: string, params?: Record<string, any> | null, json?: Record<string, any> | null): Promise<any>;
     products(): Promise<Record<string, any>>;
 }

package/dist/teslafleetapi.js

@@ -38,6 +38,14 @@ export default class TeslaFleetApi {
             this.vehicle = new Vehicle(this);
         }
     }
+    /**
+     * Make a request to the Tesla Fleet API.
+     * @param method
+     * @param path
+     * @param params
+     * @param json
+     * @returns
+     */
     async _request(method, path, params = null, json = null) {
         if (!this.server) {
             throw new Error("Server was not set at init. Call findServer() first.");
@@ -46,6 +54,7 @@ export default class TeslaFleetApi {
             throw new Error("GET requests cannot have a body.");
         }
         console.debug(`Sending request to ${path}`);
+        // Remove null and undefined values from params and json
         if (params) {
             params = Object.fromEntries(Object.entries(params).filter(([_, v]) => v != null));
             console.debug(`Parameters: ${JSON.stringify(params)}`);