@teslemetry/api 0.2.0 → 0.2.2

package/dist/index.cjs

@@ -4984,7 +4984,7 @@ const consoleLogger = {
 
 //#endregion
 //#region package.json
-var version = "0.1.0";
+var version = "0.2.2";
 
 //#endregion
 //#region src/Teslemetry.ts
@@ -5055,12 +5055,14 @@ var Teslemetry = class {
 				name: product.display_name ?? useTeslaModel(product.vin),
 				vin: product.vin,
 				api: this.api.getVehicle(product.vin),
-				sse: this.sse.getVehicle(product.vin)
+				sse: this.sse.getVehicle(product.vin),
+				product
 			};
 			if (product.device_type === "energy") result.energySites[product.energy_site_id] = {
 				name: product.site_name ?? "Unnamed",
 				site: product.energy_site_id,
-				api: this.api.getEnergySite(product.energy_site_id)
+				api: this.api.getEnergySite(product.energy_site_id),
+				product
 			};
 		});
 		return result;

package/dist/index.d.cts

@@ -1,5 +1,101 @@
 //#region src/client/types.gen.d.ts
 
+type GetApi1ProductsResponses = {
+  /**
+   * Default Response
+   */
+  200: {
+    response: Array<{
+      id: number;
+      user_id: number;
+      vehicle_id: number;
+      vin: string;
+      color: null;
+      access_type: null | string;
+      display_name: string;
+      option_codes: null | string;
+      cached_data: null | string | {
+        [key: string]: unknown;
+      };
+      mobile_access_disabled: boolean;
+      granular_access: {
+        hide_private: boolean;
+      };
+      tokens: null;
+      state: string;
+      in_service: boolean;
+      id_s: string;
+      calendar_enabled: boolean;
+      api_version: number;
+      backseat_token: null;
+      backseat_token_updated_at: null;
+      ble_autopair_enrolled: boolean;
+      device_type: 'vehicle';
+      command_signing: string;
+      release_notes_supported?: boolean;
+      share_type_s?: string;
+      bnd_enrolled?: boolean;
+    } | {
+      energy_site_id: number;
+      device_type: 'energy';
+      resource_type: string;
+      site_name?: string;
+      id: string;
+      gateway_id?: string;
+      asset_site_id: string;
+      warp_site_number: string;
+      percentage_charged?: number;
+      battery_type?: string;
+      battery_power?: number;
+      go_off_grid_test_banner_enabled: null;
+      storm_mode_enabled: boolean | null;
+      powerwall_onboarding_settings_set: boolean | null;
+      powerwall_tesla_electric_interested_in: null;
+      vpp_tour_enabled: null;
+      components: {
+        battery: boolean;
+        battery_type?: string;
+        solar: boolean;
+        solar_type?: string;
+        grid: boolean;
+        load_meter: boolean;
+        market_type: string;
+        gateways?: Array<{
+          device_id: string;
+          din: string;
+          serial_number: string;
+          part_number: string;
+          is_active: boolean;
+        }>;
+        wall_connectors?: Array<{
+          device_id: string;
+          din: string;
+          serial_number: string;
+          part_number: string;
+          is_active: boolean;
+        }>;
+        inverters?: Array<{
+          device_id: string;
+          din: string;
+          serial_number: string;
+          part_number: string;
+          is_active: boolean;
+          site_id: string;
+          firmware_version?: string;
+        }>;
+        generator?: boolean;
+      };
+      features: {
+        rate_plan_manager_no_pricing_constraint?: boolean;
+      };
+      solar_power?: number;
+      charge_on_solar_capable?: boolean;
+      grid_installation_id?: string;
+      solar_type?: string;
+    }>;
+    count?: number;
+  };
+};
 type GetApiConfigByVinResponses = {
   /**
    * Default Response
@@ -8889,7 +8985,29 @@ declare class TeslemetryVehicleApi {
    * Wakes the vehicle from sleep. This command costs 20 command credits
    * @return Promise to an object with response containing wake up confirmation
    */
-  wakeUp(): Promise<unknown>;
+  wakeUp(): Promise<{
+    response?: {
+      id?: number;
+      vehicle_id?: number;
+      vin?: string;
+      color?: string | null;
+      access_type?: string;
+      display_name?: string | null;
+      option_codes?: string | null;
+      granular_access?: {
+        hide_private?: boolean;
+      };
+      tokens?: null;
+      state?: string;
+      in_service?: boolean;
+      id_s?: string;
+      calendar_enabled?: boolean;
+      api_version?: number;
+      backseat_token?: string | null;
+      backseat_token_updated_at?: string | null;
+      ble_autopair_enrolled?: boolean;
+    };
+  }>;
   /**
    * Fetches a vehicle's fleet telemetry config.
    * @return Promise to an object with response containing fleet telemetry configuration
@@ -10823,9 +10941,7 @@ declare class TeslemetryVehicleApi {
    */
   ping(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10836,9 +10952,7 @@ declare class TeslemetryVehicleApi {
    */
   closure(body: PostApi1VehiclesByVinCustomCommandClosureData["body"]): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10849,9 +10963,7 @@ declare class TeslemetryVehicleApi {
    */
   setSeatHeaters(body: PostApi1VehiclesByVinCustomCommandSeatHeaterData["body"]): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10864,9 +10976,7 @@ declare class TeslemetryVehicleApi {
    */
   chargeOnSolar(enabled?: boolean, lowerChargeLimit?: number, upperChargeLimit?: number): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10876,9 +10986,7 @@ declare class TeslemetryVehicleApi {
    */
   dashcamSave(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10889,9 +10997,7 @@ declare class TeslemetryVehicleApi {
    */
   playVideo(url: string): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10901,9 +11007,7 @@ declare class TeslemetryVehicleApi {
    */
   stopLightShow(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10917,9 +11021,7 @@ declare class TeslemetryVehicleApi {
    */
   startLightShow(show_index: number, start_time?: number, volume?: number, dance_moves?: boolean): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10930,9 +11032,7 @@ declare class TeslemetryVehicleApi {
    */
   clearPinToDrive(pin: string): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10942,9 +11042,7 @@ declare class TeslemetryVehicleApi {
    */
   removeAllImpermanentKeys(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -11000,18 +11098,29 @@ type SseConfig = ExtractSse<{
 type FieldsResponse = GetApiConfigByVinResponses[200]["fields"];
 type FieldsRequest = NonNullable<NonNullable<PatchApiConfigByVinData["body"]>["fields"]>;
 type Signals = keyof SseData["data"];
+type ProductsResponse = GetApi1ProductsResponses[200]["response"];
+type VehicleProduct = Extract<ProductsResponse[number], {
+  device_type: "vehicle";
+}>;
+type EnergyProduct = Extract<ProductsResponse[number], {
+  device_type: "energy";
+}>;
+interface VehicleDetails {
+  name: string;
+  vin: string;
+  api: TeslemetryVehicleApi;
+  sse: TeslemetryVehicleStream;
+  product: VehicleProduct;
+}
+interface EnergyDetails {
+  name: string;
+  site: number;
+  api: TeslemetryEnergyApi;
+  product: EnergyProduct;
+}
 interface Products {
-  vehicles: Record<string, {
-    name: string;
-    vin: string;
-    api: TeslemetryVehicleApi;
-    sse: TeslemetryVehicleStream;
-  }>;
-  energySites: Record<string, {
-    name: string;
-    site: number;
-    api: TeslemetryEnergyApi;
-  }>;
+  vehicles: Record<string, VehicleDetails>;
+  energySites: Record<string, EnergyDetails>;
 }
 //#endregion
 //#region src/logger.d.ts
@@ -11846,4 +11955,4 @@ declare class ValueError extends Error {
   constructor(message: string);
 }
 //#endregion
-export { FieldsRequest, FieldsResponse, Products, Signals, SseAlerts, SseConfig, SseConnectivity, SseCredits, SseData, SseErrors, SseEvent, SseState, SseVehicleData, Teslemetry, TeslemetryApi, TeslemetryEnergyApi, TeslemetryStream, TeslemetryStreamConnectionError, TeslemetryStreamEnded, TeslemetryStreamError, TeslemetryVehicleApi, TeslemetryVehicleStream, TeslemetryVehicleStreamNotConfigured, ValueError };
+export { type EnergyDetails, FieldsRequest, FieldsResponse, type Products, Signals, SseAlerts, SseConfig, SseConnectivity, SseCredits, SseData, SseErrors, SseEvent, SseState, SseVehicleData, Teslemetry, TeslemetryApi, TeslemetryEnergyApi, TeslemetryStream, TeslemetryStreamConnectionError, TeslemetryStreamEnded, TeslemetryStreamError, TeslemetryVehicleApi, TeslemetryVehicleStream, TeslemetryVehicleStreamNotConfigured, ValueError, type VehicleDetails };

package/dist/index.d.mts

@@ -1,5 +1,101 @@
 //#region src/client/types.gen.d.ts
 
+type GetApi1ProductsResponses = {
+  /**
+   * Default Response
+   */
+  200: {
+    response: Array<{
+      id: number;
+      user_id: number;
+      vehicle_id: number;
+      vin: string;
+      color: null;
+      access_type: null | string;
+      display_name: string;
+      option_codes: null | string;
+      cached_data: null | string | {
+        [key: string]: unknown;
+      };
+      mobile_access_disabled: boolean;
+      granular_access: {
+        hide_private: boolean;
+      };
+      tokens: null;
+      state: string;
+      in_service: boolean;
+      id_s: string;
+      calendar_enabled: boolean;
+      api_version: number;
+      backseat_token: null;
+      backseat_token_updated_at: null;
+      ble_autopair_enrolled: boolean;
+      device_type: 'vehicle';
+      command_signing: string;
+      release_notes_supported?: boolean;
+      share_type_s?: string;
+      bnd_enrolled?: boolean;
+    } | {
+      energy_site_id: number;
+      device_type: 'energy';
+      resource_type: string;
+      site_name?: string;
+      id: string;
+      gateway_id?: string;
+      asset_site_id: string;
+      warp_site_number: string;
+      percentage_charged?: number;
+      battery_type?: string;
+      battery_power?: number;
+      go_off_grid_test_banner_enabled: null;
+      storm_mode_enabled: boolean | null;
+      powerwall_onboarding_settings_set: boolean | null;
+      powerwall_tesla_electric_interested_in: null;
+      vpp_tour_enabled: null;
+      components: {
+        battery: boolean;
+        battery_type?: string;
+        solar: boolean;
+        solar_type?: string;
+        grid: boolean;
+        load_meter: boolean;
+        market_type: string;
+        gateways?: Array<{
+          device_id: string;
+          din: string;
+          serial_number: string;
+          part_number: string;
+          is_active: boolean;
+        }>;
+        wall_connectors?: Array<{
+          device_id: string;
+          din: string;
+          serial_number: string;
+          part_number: string;
+          is_active: boolean;
+        }>;
+        inverters?: Array<{
+          device_id: string;
+          din: string;
+          serial_number: string;
+          part_number: string;
+          is_active: boolean;
+          site_id: string;
+          firmware_version?: string;
+        }>;
+        generator?: boolean;
+      };
+      features: {
+        rate_plan_manager_no_pricing_constraint?: boolean;
+      };
+      solar_power?: number;
+      charge_on_solar_capable?: boolean;
+      grid_installation_id?: string;
+      solar_type?: string;
+    }>;
+    count?: number;
+  };
+};
 type GetApiConfigByVinResponses = {
   /**
    * Default Response
@@ -8889,7 +8985,29 @@ declare class TeslemetryVehicleApi {
    * Wakes the vehicle from sleep. This command costs 20 command credits
    * @return Promise to an object with response containing wake up confirmation
    */
-  wakeUp(): Promise<unknown>;
+  wakeUp(): Promise<{
+    response?: {
+      id?: number;
+      vehicle_id?: number;
+      vin?: string;
+      color?: string | null;
+      access_type?: string;
+      display_name?: string | null;
+      option_codes?: string | null;
+      granular_access?: {
+        hide_private?: boolean;
+      };
+      tokens?: null;
+      state?: string;
+      in_service?: boolean;
+      id_s?: string;
+      calendar_enabled?: boolean;
+      api_version?: number;
+      backseat_token?: string | null;
+      backseat_token_updated_at?: string | null;
+      ble_autopair_enrolled?: boolean;
+    };
+  }>;
   /**
    * Fetches a vehicle's fleet telemetry config.
    * @return Promise to an object with response containing fleet telemetry configuration
@@ -10823,9 +10941,7 @@ declare class TeslemetryVehicleApi {
    */
   ping(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10836,9 +10952,7 @@ declare class TeslemetryVehicleApi {
    */
   closure(body: PostApi1VehiclesByVinCustomCommandClosureData["body"]): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10849,9 +10963,7 @@ declare class TeslemetryVehicleApi {
    */
   setSeatHeaters(body: PostApi1VehiclesByVinCustomCommandSeatHeaterData["body"]): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10864,9 +10976,7 @@ declare class TeslemetryVehicleApi {
    */
   chargeOnSolar(enabled?: boolean, lowerChargeLimit?: number, upperChargeLimit?: number): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10876,9 +10986,7 @@ declare class TeslemetryVehicleApi {
    */
   dashcamSave(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10889,9 +10997,7 @@ declare class TeslemetryVehicleApi {
    */
   playVideo(url: string): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10901,9 +11007,7 @@ declare class TeslemetryVehicleApi {
    */
   stopLightShow(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10917,9 +11021,7 @@ declare class TeslemetryVehicleApi {
    */
   startLightShow(show_index: number, start_time?: number, volume?: number, dance_moves?: boolean): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10930,9 +11032,7 @@ declare class TeslemetryVehicleApi {
    */
   clearPinToDrive(pin: string): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -10942,9 +11042,7 @@ declare class TeslemetryVehicleApi {
    */
   removeAllImpermanentKeys(): Promise<{
     response: {
-      result: boolean | {
-        [key: string]: unknown;
-      };
+      result: boolean;
       reason?: string;
     };
   }>;
@@ -11000,18 +11098,29 @@ type SseConfig = ExtractSse<{
 type FieldsResponse = GetApiConfigByVinResponses[200]["fields"];
 type FieldsRequest = NonNullable<NonNullable<PatchApiConfigByVinData["body"]>["fields"]>;
 type Signals = keyof SseData["data"];
+type ProductsResponse = GetApi1ProductsResponses[200]["response"];
+type VehicleProduct = Extract<ProductsResponse[number], {
+  device_type: "vehicle";
+}>;
+type EnergyProduct = Extract<ProductsResponse[number], {
+  device_type: "energy";
+}>;
+interface VehicleDetails {
+  name: string;
+  vin: string;
+  api: TeslemetryVehicleApi;
+  sse: TeslemetryVehicleStream;
+  product: VehicleProduct;
+}
+interface EnergyDetails {
+  name: string;
+  site: number;
+  api: TeslemetryEnergyApi;
+  product: EnergyProduct;
+}
 interface Products {
-  vehicles: Record<string, {
-    name: string;
-    vin: string;
-    api: TeslemetryVehicleApi;
-    sse: TeslemetryVehicleStream;
-  }>;
-  energySites: Record<string, {
-    name: string;
-    site: number;
-    api: TeslemetryEnergyApi;
-  }>;
+  vehicles: Record<string, VehicleDetails>;
+  energySites: Record<string, EnergyDetails>;
 }
 //#endregion
 //#region src/logger.d.ts
@@ -11846,4 +11955,4 @@ declare class ValueError extends Error {
   constructor(message: string);
 }
 //#endregion
-export { FieldsRequest, FieldsResponse, Products, Signals, SseAlerts, SseConfig, SseConnectivity, SseCredits, SseData, SseErrors, SseEvent, SseState, SseVehicleData, Teslemetry, TeslemetryApi, TeslemetryEnergyApi, TeslemetryStream, TeslemetryStreamConnectionError, TeslemetryStreamEnded, TeslemetryStreamError, TeslemetryVehicleApi, TeslemetryVehicleStream, TeslemetryVehicleStreamNotConfigured, ValueError };
+export { type EnergyDetails, FieldsRequest, FieldsResponse, type Products, Signals, SseAlerts, SseConfig, SseConnectivity, SseCredits, SseData, SseErrors, SseEvent, SseState, SseVehicleData, Teslemetry, TeslemetryApi, TeslemetryEnergyApi, TeslemetryStream, TeslemetryStreamConnectionError, TeslemetryStreamEnded, TeslemetryStreamError, TeslemetryVehicleApi, TeslemetryVehicleStream, TeslemetryVehicleStreamNotConfigured, ValueError, type VehicleDetails };

package/dist/index.mjs

@@ -4983,7 +4983,7 @@ const consoleLogger = {
 
 //#endregion
 //#region package.json
-var version = "0.1.0";
+var version = "0.2.2";
 
 //#endregion
 //#region src/Teslemetry.ts
@@ -5054,12 +5054,14 @@ var Teslemetry = class {
 				name: product.display_name ?? useTeslaModel(product.vin),
 				vin: product.vin,
 				api: this.api.getVehicle(product.vin),
-				sse: this.sse.getVehicle(product.vin)
+				sse: this.sse.getVehicle(product.vin),
+				product
 			};
 			if (product.device_type === "energy") result.energySites[product.energy_site_id] = {
 				name: product.site_name ?? "Unnamed",
 				site: product.energy_site_id,
-				api: this.api.getEnergySite(product.energy_site_id)
+				api: this.api.getEnergySite(product.energy_site_id),
+				product
 			};
 		});
 		return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teslemetry/api",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "API client for Teslemetry",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -29,8 +29,14 @@
     "url": "https://teslemetry.com"
   },
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Teslemetry/typescript-teslemetry"
+  },
+  "bugs": "https://github.com/Teslemetry/typescript-teslemetry/issues/new?template=api_bug.yml",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "devDependencies": {
     "@hey-api/openapi-ts": "0.88.0",