tesla-fleet-api 0.3.0 → 0.5.0

package/dist/types/products.d.mts

@@ -0,0 +1,58 @@
+import { VehicleResponse } from "./vehicle.mjs";
+import { VehicleConfig } from "./vehicle_data.mjs";
+declare namespace products_d_exports {
+  export { Components, EnergyProduct, Features, ProductsData, ProductsResponse, VehicleProduct, WallConnector };
+}
+export type ProductsData = {
+  response: ProductsResponse;
+  count: number;
+};
+export type ProductsResponse = (VehicleProduct | EnergyProduct)[];
+export type VehicleProduct = VehicleResponse & {
+  vehicle_config: VehicleConfig;
+  command_signing: string;
+  release_notes_supported: boolean;
+};
+export type EnergyProduct = {
+  energy_site_id: number;
+  resource_type: string;
+  site_name: string;
+  id: string;
+  gateway_id: string;
+  asset_site_id: string;
+  warp_site_number: string;
+  energy_left: number;
+  total_pack_energy: number;
+  percentage_charged: number;
+  battery_type: string;
+  backup_capable: boolean;
+  battery_power: number;
+  go_off_grid_test_banner_enabled: null | boolean;
+  storm_mode_enabled: boolean;
+  powerwall_onboarding_settings_set: boolean;
+  powerwall_tesla_electric_interested_in: null | boolean;
+  vpp_tour_enabled: null | boolean;
+  sync_grid_alert_enabled: boolean;
+  breaker_alert_enabled: boolean;
+  components: Components;
+  features: Features;
+};
+export type Components = {
+  battery: boolean;
+  battery_type: string;
+  solar: boolean;
+  solar_type: string;
+  grid: boolean;
+  load_meter: boolean;
+  market_type: string;
+  wall_connectors: WallConnector[];
+};
+export type WallConnector = {
+  device_id: string;
+  din: string;
+  is_active: boolean;
+};
+export type Features = {
+  rate_plan_manager_no_pricing_constraint: boolean;
+};
+export { products_d_exports };

package/dist/types/responses.d.cts

@@ -0,0 +1,13 @@
+declare namespace responses_d_exports {
+  export { OptionsResponse, ResponseEnvelope };
+}
+export type OptionsResponse = {
+  code: string;
+  displayName: string;
+  isActive: boolean;
+}[];
+/** The `{ response }` envelope the Fleet API wraps most payloads in. */
+export type ResponseEnvelope<T> = {
+  response: T;
+};
+export { responses_d_exports };

package/dist/types/responses.d.mts

@@ -0,0 +1,13 @@
+declare namespace responses_d_exports {
+  export { OptionsResponse, ResponseEnvelope };
+}
+export type OptionsResponse = {
+  code: string;
+  displayName: string;
+  isActive: boolean;
+}[];
+/** The `{ response }` envelope the Fleet API wraps most payloads in. */
+export type ResponseEnvelope<T> = {
+  response: T;
+};
+export { responses_d_exports };

package/dist/types/site_info.d.cts

@@ -0,0 +1,154 @@
+declare namespace site_info_d_exports {
+  export { Battery, Components, EnergyCharges, Gateway, Schedule, Season, SellTariff, SiteInfoResponse, TariffContentV2, TariffPeriodWindow, TouPeriods, TouSettings, UserSettings, WallConnector };
+}
+export type SiteInfoResponse = {
+  id: string;
+  site_name: string;
+  backup_reserve_percent: number;
+  default_real_mode: string;
+  installation_date: Date;
+  user_settings: UserSettings;
+  components: Components;
+  version?: string;
+  battery_count?: number;
+  tou_settings?: TouSettings;
+  nameplate_power?: number;
+  nameplate_energy?: number;
+  installation_time_zone: string;
+  max_site_meter_power_ac?: number;
+  min_site_meter_power_ac?: number;
+  vpp_backup_reserve_percent?: number;
+  tariff_content_v2?: TariffContentV2;
+};
+export type Components = {
+  solar: boolean;
+  solar_type?: string;
+  battery: boolean;
+  grid: boolean;
+  backup: boolean;
+  gateway: string;
+  load_meter: boolean;
+  tou_capable: boolean;
+  storm_mode_capable: boolean;
+  flex_energy_request_capable: boolean;
+  car_charging_data_supported: boolean;
+  off_grid_vehicle_charging_reserve_supported: boolean;
+  vehicle_charging_performance_view_enabled: boolean;
+  vehicle_charging_solar_offset_view_enabled: boolean;
+  battery_solar_offset_view_enabled: boolean;
+  solar_value_enabled?: boolean;
+  energy_value_header?: string;
+  energy_value_subheader?: string;
+  energy_service_self_scheduling_enabled: boolean;
+  show_grid_import_battery_source_cards?: boolean;
+  set_islanding_mode_enabled?: boolean;
+  wifi_commissioning_enabled?: boolean;
+  backup_time_remaining_enabled?: boolean;
+  battery_type?: string;
+  configurable?: boolean;
+  grid_services_enabled?: boolean;
+  gateways?: Gateway[];
+  batteries?: Battery[];
+  wall_connectors?: WallConnector[];
+  disallow_charge_from_grid_with_solar_installed?: boolean;
+  customer_preferred_export_rule?: string;
+  net_meter_mode?: string;
+  system_alerts_enabled?: boolean;
+  nbt_supported?: boolean;
+};
+export type Battery = {
+  device_id: string;
+  din: string;
+  serial_number: string;
+  part_number: string;
+  part_type: number;
+  part_name: string;
+  nameplate_max_charge_power: number;
+  nameplate_max_discharge_power: number;
+  nameplate_energy: number;
+};
+export type Gateway = {
+  device_id: string;
+  din: string;
+  serial_number: string;
+  part_number: string;
+  part_type: number;
+  part_name: string;
+  is_active: boolean;
+  site_id: string;
+  firmware_version: string;
+  updated_datetime: Date;
+};
+export type WallConnector = {
+  device_id: string;
+  din: string;
+  part_name: string;
+  is_active: boolean;
+};
+export type TouSettings = {
+  optimization_strategy: string;
+  schedule: Schedule[];
+};
+export type Schedule = {
+  target: string;
+  week_days: number[];
+  start_seconds: number;
+  end_seconds: number;
+};
+export type UserSettings = {
+  go_off_grid_test_banner_enabled: boolean;
+  storm_mode_enabled: boolean;
+  powerwall_onboarding_settings_set: boolean;
+  powerwall_tesla_electric_interested_in: boolean;
+  vpp_tour_enabled: boolean;
+  sync_grid_alert_enabled: boolean;
+  breaker_alert_enabled: boolean;
+  off_grid_vehicle_charging_enabled: boolean;
+};
+export type TariffPeriodWindow = {
+  fromDayOfWeek?: number;
+  toDayOfWeek?: number;
+  fromHour?: number;
+  toHour?: number;
+  fromMinute?: number;
+  toMinute?: number;
+};
+export type TouPeriods = Record<string, {
+  periods: TariffPeriodWindow[];
+}>;
+export type Season = {
+  fromDay?: number;
+  toDay?: number;
+  fromMonth?: number;
+  toMonth?: number;
+  tou_periods?: TouPeriods;
+};
+export type EnergyCharges = Record<string, {
+  rates?: Record<string, number>;
+}>;
+export type SellTariff = {
+  name?: string;
+  utility?: string;
+  daily_charges?: Record<string, any>[];
+  demand_charges?: Record<string, any>;
+  energy_charges: EnergyCharges;
+  seasons?: Record<string, Season>;
+};
+export type TariffContentV2 = {
+  version: number;
+  monthly_minimum_bill?: number;
+  min_applicable_demand?: number;
+  max_applicable_demand?: number;
+  monthly_charges?: number;
+  utility: string;
+  code: string;
+  name: string;
+  currency: string;
+  daily_charges: Record<string, any>[];
+  daily_demand_charges?: Record<string, any>;
+  demand_charges: Record<string, any>;
+  energy_charges: EnergyCharges;
+  seasons: Record<string, Season>;
+  sell_tariff?: SellTariff;
+};
+export { site_info_d_exports };

package/dist/types/site_info.d.mts

@@ -0,0 +1,154 @@
+declare namespace site_info_d_exports {
+  export { Battery, Components, EnergyCharges, Gateway, Schedule, Season, SellTariff, SiteInfoResponse, TariffContentV2, TariffPeriodWindow, TouPeriods, TouSettings, UserSettings, WallConnector };
+}
+export type SiteInfoResponse = {
+  id: string;
+  site_name: string;
+  backup_reserve_percent: number;
+  default_real_mode: string;
+  installation_date: Date;
+  user_settings: UserSettings;
+  components: Components;
+  version?: string;
+  battery_count?: number;
+  tou_settings?: TouSettings;
+  nameplate_power?: number;
+  nameplate_energy?: number;
+  installation_time_zone: string;
+  max_site_meter_power_ac?: number;
+  min_site_meter_power_ac?: number;
+  vpp_backup_reserve_percent?: number;
+  tariff_content_v2?: TariffContentV2;
+};
+export type Components = {
+  solar: boolean;
+  solar_type?: string;
+  battery: boolean;
+  grid: boolean;
+  backup: boolean;
+  gateway: string;
+  load_meter: boolean;
+  tou_capable: boolean;
+  storm_mode_capable: boolean;
+  flex_energy_request_capable: boolean;
+  car_charging_data_supported: boolean;
+  off_grid_vehicle_charging_reserve_supported: boolean;
+  vehicle_charging_performance_view_enabled: boolean;
+  vehicle_charging_solar_offset_view_enabled: boolean;
+  battery_solar_offset_view_enabled: boolean;
+  solar_value_enabled?: boolean;
+  energy_value_header?: string;
+  energy_value_subheader?: string;
+  energy_service_self_scheduling_enabled: boolean;
+  show_grid_import_battery_source_cards?: boolean;
+  set_islanding_mode_enabled?: boolean;
+  wifi_commissioning_enabled?: boolean;
+  backup_time_remaining_enabled?: boolean;
+  battery_type?: string;
+  configurable?: boolean;
+  grid_services_enabled?: boolean;
+  gateways?: Gateway[];
+  batteries?: Battery[];
+  wall_connectors?: WallConnector[];
+  disallow_charge_from_grid_with_solar_installed?: boolean;
+  customer_preferred_export_rule?: string;
+  net_meter_mode?: string;
+  system_alerts_enabled?: boolean;
+  nbt_supported?: boolean;
+};
+export type Battery = {
+  device_id: string;
+  din: string;
+  serial_number: string;
+  part_number: string;
+  part_type: number;
+  part_name: string;
+  nameplate_max_charge_power: number;
+  nameplate_max_discharge_power: number;
+  nameplate_energy: number;
+};
+export type Gateway = {
+  device_id: string;
+  din: string;
+  serial_number: string;
+  part_number: string;
+  part_type: number;
+  part_name: string;
+  is_active: boolean;
+  site_id: string;
+  firmware_version: string;
+  updated_datetime: Date;
+};
+export type WallConnector = {
+  device_id: string;
+  din: string;
+  part_name: string;
+  is_active: boolean;
+};
+export type TouSettings = {
+  optimization_strategy: string;
+  schedule: Schedule[];
+};
+export type Schedule = {
+  target: string;
+  week_days: number[];
+  start_seconds: number;
+  end_seconds: number;
+};
+export type UserSettings = {
+  go_off_grid_test_banner_enabled: boolean;
+  storm_mode_enabled: boolean;
+  powerwall_onboarding_settings_set: boolean;
+  powerwall_tesla_electric_interested_in: boolean;
+  vpp_tour_enabled: boolean;
+  sync_grid_alert_enabled: boolean;
+  breaker_alert_enabled: boolean;
+  off_grid_vehicle_charging_enabled: boolean;
+};
+export type TariffPeriodWindow = {
+  fromDayOfWeek?: number;
+  toDayOfWeek?: number;
+  fromHour?: number;
+  toHour?: number;
+  fromMinute?: number;
+  toMinute?: number;
+};
+export type TouPeriods = Record<string, {
+  periods: TariffPeriodWindow[];
+}>;
+export type Season = {
+  fromDay?: number;
+  toDay?: number;
+  fromMonth?: number;
+  toMonth?: number;
+  tou_periods?: TouPeriods;
+};
+export type EnergyCharges = Record<string, {
+  rates?: Record<string, number>;
+}>;
+export type SellTariff = {
+  name?: string;
+  utility?: string;
+  daily_charges?: Record<string, any>[];
+  demand_charges?: Record<string, any>;
+  energy_charges: EnergyCharges;
+  seasons?: Record<string, Season>;
+};
+export type TariffContentV2 = {
+  version: number;
+  monthly_minimum_bill?: number;
+  min_applicable_demand?: number;
+  max_applicable_demand?: number;
+  monthly_charges?: number;
+  utility: string;
+  code: string;
+  name: string;
+  currency: string;
+  daily_charges: Record<string, any>[];
+  daily_demand_charges?: Record<string, any>;
+  demand_charges: Record<string, any>;
+  energy_charges: EnergyCharges;
+  seasons: Record<string, Season>;
+  sell_tariff?: SellTariff;
+};
+export { site_info_d_exports };

package/dist/types/vehicle.d.cts

@@ -0,0 +1,33 @@
+import { Models } from "../const.cjs";
+declare namespace vehicle_d_exports {
+  export { GranularAccess, Models, VehicleResponse, WakeUpOptions };
+}
+export type VehicleResponse = {
+  id: number;
+  vehicle_id: number;
+  vin: string;
+  color: null;
+  access_type: string;
+  display_name: string;
+  option_codes: null;
+  granular_access: GranularAccess;
+  tokens: string[];
+  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;
+};
+export type WakeUpOptions = {
+  /** Poll `vehicle()` until the vehicle reports `online`, raising `VehicleOffline` at the deadline. */
+  wait?: boolean;
+  /** Deadline for `wait`, in milliseconds. */
+  timeoutMs?: number;
+};
+export type GranularAccess = {
+  hide_private: boolean;
+};
+export { Models, vehicle_d_exports };

package/dist/types/vehicle.d.mts

@@ -0,0 +1,33 @@
+import { Models } from "../const.mjs";
+declare namespace vehicle_d_exports {
+  export { GranularAccess, Models, VehicleResponse, WakeUpOptions };
+}
+export type VehicleResponse = {
+  id: number;
+  vehicle_id: number;
+  vin: string;
+  color: null;
+  access_type: string;
+  display_name: string;
+  option_codes: null;
+  granular_access: GranularAccess;
+  tokens: string[];
+  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;
+};
+export type WakeUpOptions = {
+  /** Poll `vehicle()` until the vehicle reports `online`, raising `VehicleOffline` at the deadline. */
+  wait?: boolean;
+  /** Deadline for `wait`, in milliseconds. */
+  timeoutMs?: number;
+};
+export type GranularAccess = {
+  hide_private: boolean;
+};
+export { Models, vehicle_d_exports };