Reference

Parsed endpoints return the typed payload and raise ApiError on a documented non-2xx. For the raw endpoints, see Raw API Reference.

Source: TeslaFleetManagementApiClient

Charging

Source: Charging

def get_charging_history(*, request_options: RequestOptionsOrDict | None = None) -> ChargingHistoryResponse

Description

Returns the paginated charging history for the authenticated account.

Usage

Sync

try:
    response = client.charging.get_charging_history()
    # TODO: Handle 'response' of type ChargingHistoryResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.charging.get_charging_history()
    # TODO: Handle 'response' of type ChargingHistoryResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: ChargingHistoryResponse -- Charging history retrieved successfully

OnError: ApiError[RawError]

def get_charging_invoice(id_: str, *, request_options: RequestOptionsOrDict | None = None) -> None

Description

Returns a charging invoice PDF for a charging session.

Usage

Sync

try:
    client.charging.get_charging_invoice("some example string")
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    await async_client.charging.get_charging_invoice("some example string")
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`id_`	`str`	Charging session invoice identifier
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: No content

OnError: ApiError[RawError]

def get_charging_sessions(*, request_options: RequestOptionsOrDict | None = None) -> ChargingSessionsResponse

Description

Returns charging session information. Only available for business fleet owners.

Usage

Sync

try:
    response = client.charging.get_charging_sessions()
    # TODO: Handle 'response' of type ChargingSessionsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.charging.get_charging_sessions()
    # TODO: Handle 'response' of type ChargingSessionsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: ChargingSessionsResponse -- Charging sessions retrieved successfully

OnError: ApiError[RawError]

Energy

Source: Energy

def adjust_site_s_backup_reserve(energy_site_id: str, body: BackupRequest | BackupRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> BackupResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.energy.adjust_site_s_backup_reserve(
        "some example string", BackupRequest(backup_reserve_percent=1)
    )
    # TODO: Handle 'response' of type BackupResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.adjust_site_s_backup_reserve(
        "some example string", BackupRequest(backup_reserve_percent=1)
    )
    # TODO: Handle 'response' of type BackupResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`body`	`BackupRequest \| BackupRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: BackupResponse -- Backup reserve updated

OnError: ApiError[RawError]

def adjust_site_s_off_grid_vehicle_charging_reserve(energy_site_id: str, body: OffGridVehicleChargingReserveRequest | OffGridVehicleChargingReserveRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> GenericUpdateResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.energy.adjust_site_s_off_grid_vehicle_charging_reserve(
        "some example string", OffGridVehicleChargingReserveRequest(off_grid_vehicle_charging_reserve_percent=1)
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.adjust_site_s_off_grid_vehicle_charging_reserve(
        "some example string", OffGridVehicleChargingReserveRequest(off_grid_vehicle_charging_reserve_percent=1)
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`body`	`OffGridVehicleChargingReserveRequest \| OffGridVehicleChargingReserveRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: GenericUpdateResponse -- Reserve updated

OnError: ApiError[RawError]

def allow_disallow_charging_from_the_grid_and_exporting_energy_to_the_grid(energy_site_id: str, *, body: Any | None = None, request_options: RequestOptionsOrDict | None = None) -> GenericUpdateResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.energy.allow_disallow_charging_from_the_grid_and_exporting_energy_to_the_grid(
        "some example string"
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.allow_disallow_charging_from_the_grid_and_exporting_energy_to_the_grid(
        "some example string"
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`body`	`Any \| None`	The request body. Default: `None`
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: GenericUpdateResponse -- Grid import/export updated

OnError: ApiError[RawError]

def get_backup_or_energy_history(energy_site_id: str, kind: KindOrStr, start_date: RFC3339DateTime, end_date: RFC3339DateTime, *, period: str | None = None, time_zone: str | None = None, request_options: RequestOptionsOrDict | None = None) -> CalendarHistoryResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.energy.get_backup_or_energy_history(
        "some example string",
        Kind.BACKUP,
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
    )
    # TODO: Handle 'response' of type CalendarHistoryResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.get_backup_or_energy_history(
        "some example string",
        Kind.BACKUP,
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
    )
    # TODO: Handle 'response' of type CalendarHistoryResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`kind`	`KindOrStr`	Value sent with the request.
`start_date`	`RFC3339DateTime`	Value sent with the request.
`end_date`	`RFC3339DateTime`	Value sent with the request.
`period`	`str \| None`	Value sent with the request. Default: `None`
`time_zone`	`str \| None`	Value sent with the request. Default: `None`
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CalendarHistoryResponse -- History retrieved

OnError: ApiError[RawError]

def get_live_site_status(energy_site_id: str, *, request_options: RequestOptionsOrDict | None = None) -> LiveStatusResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.energy.get_live_site_status("some example string")
    # TODO: Handle 'response' of type LiveStatusResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.get_live_site_status("some example string")
    # TODO: Handle 'response' of type LiveStatusResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: LiveStatusResponse -- Live status retrieved

OnError: ApiError[RawError]

def get_site_information_assets_settings_features(energy_site_id: str, *, request_options: RequestOptionsOrDict | None = None) -> SiteInfoResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.energy.get_site_information_assets_settings_features("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.get_site_information_assets_settings_features("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: SiteInfoResponse -- Site info retrieved

OnError: ApiError[RawError]

def get_user_products_vehicles_energy_sites(*, request_options: RequestOptionsOrDict | None = None) -> ProductsResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.energy.get_user_products_vehicles_energy_sites()
    # TODO: Handle 'response' of type ProductsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.get_user_products_vehicles_energy_sites()
    # TODO: Handle 'response' of type ProductsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: ProductsResponse -- Products retrieved

OnError: ApiError[RawError]

def get_wall_connector_charging_history(energy_site_id: str, kind: KindGetWallConnectorChargingHistoryOrStr, start_date: RFC3339DateTime, end_date: RFC3339DateTime, *, time_zone: str | None = None, request_options: RequestOptionsOrDict | None = None) -> ChargeHistoryResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.energy.get_wall_connector_charging_history(
        "some example string",
        KindGetWallConnectorChargingHistory.CHARGE,
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
    )
    # TODO: Handle 'response' of type ChargeHistoryResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.get_wall_connector_charging_history(
        "some example string",
        KindGetWallConnectorChargingHistory.CHARGE,
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
        datetime(2024, 1, 15, 9, 30, 0, tzinfo=timezone.utc),
    )
    # TODO: Handle 'response' of type ChargeHistoryResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`kind`	`KindGetWallConnectorChargingHistoryOrStr`	Value sent with the request.
`start_date`	`RFC3339DateTime`	Value sent with the request.
`end_date`	`RFC3339DateTime`	Value sent with the request.
`time_zone`	`str \| None`	Value sent with the request. Default: `None`
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: ChargeHistoryResponse -- Charging history retrieved

OnError: ApiError[RawError]

def set_site_mode_autonomous_or_self_consumption(energy_site_id: str, body: OperationRequest | OperationRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> GenericUpdateResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.energy.set_site_mode_autonomous_or_self_consumption(
        "some example string", OperationRequest(default_real_mode=DefaultRealMode.AUTONOMOUS)
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.set_site_mode_autonomous_or_self_consumption(
        "some example string", OperationRequest(default_real_mode=DefaultRealMode.AUTONOMOUS)
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`body`	`OperationRequest \| OperationRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: GenericUpdateResponse -- Operation mode updated

OnError: ApiError[RawError]

def update_storm_watch_participation(energy_site_id: str, body: StormModeRequest | StormModeRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> GenericUpdateResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.energy.update_storm_watch_participation("some example string", StormModeRequest(enabled=True))
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.update_storm_watch_participation(
        "some example string", StormModeRequest(enabled=True)
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`body`	`StormModeRequest \| StormModeRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: GenericUpdateResponse -- Storm mode updated

OnError: ApiError[RawError]

def update_time_of_use_tou_settings(energy_site_id: str, body: TimeOfUseSettingsRequest | TimeOfUseSettingsRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> GenericUpdateResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.energy.update_time_of_use_tou_settings(
        "some example string", TimeOfUseSettingsRequest(tou_settings=TouSettings())
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.energy.update_time_of_use_tou_settings(
        "some example string", TimeOfUseSettingsRequest(tou_settings=TouSettings())
    )
    # TODO: Handle 'response' of type GenericUpdateResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`energy_site_id`	`str`	Value sent with the request.
`body`	`TimeOfUseSettingsRequest \| TimeOfUseSettingsRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: GenericUpdateResponse -- TOU settings updated

OnError: ApiError[RawError]

Partner

Source: Partner

def get_public_key_for_a_domain(domain: str, *, request_options: RequestOptionsOrDict | None = None) -> PublicKeyResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.partner.get_public_key_for_a_domain("some example string")
    # TODO: Handle 'response' of type PublicKeyResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.partner.get_public_key_for_a_domain("some example string")
    # TODO: Handle 'response' of type PublicKeyResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`domain`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: PublicKeyResponse -- Public key retrieved

OnError: ApiError[RawError]

def get_recent_fleet_telemetry_errors(*, request_options: RequestOptionsOrDict | None = None) -> FleetTelemetryErrorsResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.partner.get_recent_fleet_telemetry_errors()
    # TODO: Handle 'response' of type FleetTelemetryErrorsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.partner.get_recent_fleet_telemetry_errors()
    # TODO: Handle 'response' of type FleetTelemetryErrorsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: FleetTelemetryErrorsResponse -- Fleet telemetry errors retrieved

OnError: ApiError[RawError]

def get_vins_with_fleet_telemetry_errors(*, request_options: RequestOptionsOrDict | None = None) -> BackupResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.partner.get_vins_with_fleet_telemetry_errors()
    # TODO: Handle 'response' of type BackupResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.partner.get_vins_with_fleet_telemetry_errors()
    # TODO: Handle 'response' of type BackupResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: BackupResponse -- List of VINs with telemetry errors

OnError: ApiError[RawError]

def register_a_partner_account(body: RegisterPartnerRequest | RegisterPartnerRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> RegisterPartnerResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.partner.register_a_partner_account(RegisterPartnerRequest(domain="some example string"))
    # TODO: Handle 'response' of type RegisterPartnerResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.partner.register_a_partner_account(
        RegisterPartnerRequest(domain="some example string")
    )
    # TODO: Handle 'response' of type RegisterPartnerResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`body`	`RegisterPartnerRequest \| RegisterPartnerRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: RegisterPartnerResponse -- Partner account registered

OnError: ApiError[RawError]

User

Source: User

def get_active_orders_for_a_user(*, request_options: RequestOptionsOrDict | None = None) -> OrdersResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.user.get_active_orders_for_a_user()
    # TODO: Handle 'response' of type OrdersResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.user.get_active_orders_for_a_user()
    # TODO: Handle 'response' of type OrdersResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: OrdersResponse -- User orders retrieved

OnError: ApiError[RawError]

def get_custom_feature_flags_for_a_user(*, request_options: RequestOptionsOrDict | None = None) -> BackupResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.user.get_custom_feature_flags_for_a_user()
    # TODO: Handle 'response' of type BackupResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.user.get_custom_feature_flags_for_a_user()
    # TODO: Handle 'response' of type BackupResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: BackupResponse -- Feature flags retrieved

OnError: ApiError[RawError]

def get_summary_of_a_user_s_account(*, request_options: RequestOptionsOrDict | None = None) -> MeResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.user.get_summary_of_a_user_s_account()
    # TODO: Handle 'response' of type MeResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.user.get_summary_of_a_user_s_account()
    # TODO: Handle 'response' of type MeResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: MeResponse -- User account retrieved

OnError: ApiError[RawError]

def get_user_s_region_and_fleet_api_base_url(*, request_options: RequestOptionsOrDict | None = None) -> RegionResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.user.get_user_s_region_and_fleet_api_base_url()
    # TODO: Handle 'response' of type RegionResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.user.get_user_s_region_and_fleet_api_base_url()
    # TODO: Handle 'response' of type RegionResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: RegionResponse -- Region information retrieved

OnError: ApiError[RawError]

VehicleCommands

Source: VehicleCommands

def actuatetrunk(vehicle_tag: str, body: ActuateTrunkRequest | ActuateTrunkRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Controls the front or rear trunk

Usage

Sync

try:
    response = client.vehicle_commands.actuatetrunk(
        "some example string", ActuateTrunkRequest(which_trunk=WhichTrunk.FRONT)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.actuatetrunk(
        "some example string", ActuateTrunkRequest(which_trunk=WhichTrunk.FRONT)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`body`	`ActuateTrunkRequest \| ActuateTrunkRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def addchargeschedule(vehicle_tag: str, body: AddChargeScheduleRequest | AddChargeScheduleRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.addchargeschedule(
        "some example string", AddChargeScheduleRequest(lat=1.5, lon=1.5, id=1, enabled=True)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.addchargeschedule(
        "some example string", AddChargeScheduleRequest(lat=1.5, lon=1.5, id=1, enabled=True)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`body`	`AddChargeScheduleRequest \| AddChargeScheduleRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def addpreconditionschedule(vehicle_tag: str, body: AddPreconditionScheduleRequest | AddPreconditionScheduleRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.addpreconditionschedule(
        "some example string", AddPreconditionScheduleRequest(lat=1.5, lon=1.5, id=1, enabled=True)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.addpreconditionschedule(
        "some example string", AddPreconditionScheduleRequest(lat=1.5, lon=1.5, id=1, enabled=True)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`body`	`AddPreconditionScheduleRequest \| AddPreconditionScheduleRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def adjustmediavolume(vehicle_tag: str, body: AdjustVolumeRequest | AdjustVolumeRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.adjustmediavolume("some example string", AdjustVolumeRequest(volume=1))
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.adjustmediavolume(
        "some example string", AdjustVolumeRequest(volume=1)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`body`	`AdjustVolumeRequest \| AdjustVolumeRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def cancelsoftwareupdate(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.cancelsoftwareupdate("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.cancelsoftwareupdate("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def chargemaxrange(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.chargemaxrange("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.chargemaxrange("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def chargestandard(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.chargestandard("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.chargestandard("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def clear_pi_nto_drive_admin(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Deactivates PIN to Drive and resets the associated PIN for supported firmware versions.

Usage

Sync

try:
    response = client.vehicle_commands.clear_pi_nto_drive_admin("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.clear_pi_nto_drive_admin("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def closechargeportdoor(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.closechargeportdoor("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.closechargeportdoor("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def enableordisable_guest_mode(vehicle_tag: str, body: GuestModeRequest | GuestModeRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.enableordisable_guest_mode("some example string", GuestModeRequest(enable=True))
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.enableordisable_guest_mode(
        "some example string", GuestModeRequest(enable=True)
    )
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`body`	`GuestModeRequest \| GuestModeRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def eraseuserdata(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Erases user data from the vehicle UI. Requires Guest Mode.

Usage

Sync

try:
    response = client.vehicle_commands.eraseuserdata("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.eraseuserdata("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def flashlights(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Briefly flashes vehicle headlights.

Usage

Sync

try:
    response = client.vehicle_commands.flashlights("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.flashlights("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def honkhorn(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.honkhorn("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.honkhorn("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def lockdoors(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.lockdoors("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.lockdoors("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def nextfavoritemediatrack(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.nextfavoritemediatrack("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.nextfavoritemediatrack("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def openchargeportdoor(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.openchargeportdoor("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.openchargeportdoor("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def startcharging(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.startcharging("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.startcharging("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def startclimatepreconditioning(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.startclimatepreconditioning("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.startclimatepreconditioning("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def stopcharging(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.stopcharging("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.stopcharging("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def stopclimatepreconditioning(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.stopclimatepreconditioning("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.stopclimatepreconditioning("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

def unlockdoors(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> CommandResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicle_commands.unlockdoors("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicle_commands.unlockdoors("some example string")
    # TODO: Handle 'response' of type CommandResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: CommandResponse -- Vehicle command response

OnError: ApiError[RawError]

Vehicles

Source: Vehicles

def configure_fleet_telemetry_using_signed_jws_token(body: FleetTelemetryJwsRequest | FleetTelemetryJwsRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicles.configure_fleet_telemetry_using_signed_jws_token(FleetTelemetryJwsRequest())
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.configure_fleet_telemetry_using_signed_jws_token(FleetTelemetryJwsRequest())
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`body`	`FleetTelemetryJwsRequest \| FleetTelemetryJwsRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Telemetry configuration result

OnError: ApiError[RawError]

def create_or_update_fleet_telemetry_configuration(body: Any, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicles.create_or_update_fleet_telemetry_configuration({})
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.create_or_update_fleet_telemetry_configuration({})
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`body`	`Any`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Telemetry configuration result

OnError: ApiError[RawError]

def delete_fleet_telemetry_configuration(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a DELETE request.

Usage

Sync

try:
    response = client.vehicles.delete_fleet_telemetry_configuration("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.delete_fleet_telemetry_configuration("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Configuration deleted

OnError: ApiError[RawError]

def get_allowed_drivers_for_a_vehicle(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> DriversResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_allowed_drivers_for_a_vehicle("some example string")
    # TODO: Handle 'response' of type DriversResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_allowed_drivers_for_a_vehicle("some example string")
    # TODO: Handle 'response' of type DriversResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: DriversResponse -- List of drivers

OnError: ApiError[RawError]

def get_eligible_vehicle_subscriptions(vin: str, *, request_options: RequestOptionsOrDict | None = None) -> SiteInfoResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_eligible_vehicle_subscriptions("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_eligible_vehicle_subscriptions("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vin`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: SiteInfoResponse -- Eligible subscriptions

OnError: ApiError[RawError]

def get_eligible_vehicle_upgrades(vin: str, *, request_options: RequestOptionsOrDict | None = None) -> SiteInfoResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_eligible_vehicle_upgrades("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_eligible_vehicle_upgrades("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vin`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: SiteInfoResponse -- Eligible upgrades

OnError: ApiError[RawError]

def get_enterprise_roles_for_a_vehicle(vin: str, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_enterprise_roles_for_a_vehicle("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_enterprise_roles_for_a_vehicle("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vin`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Enterprise roles

OnError: ApiError[RawError]

def get_fleet_status_for_vehicles(body: FleetStatusRequest | FleetStatusRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicles.get_fleet_status_for_vehicles(FleetStatusRequest())
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_fleet_status_for_vehicles(FleetStatusRequest())
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`body`	`FleetStatusRequest \| FleetStatusRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Fleet status

OnError: ApiError[RawError]

def get_fleet_telemetry_configuration(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_fleet_telemetry_configuration("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_fleet_telemetry_configuration("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Fleet telemetry configuration

OnError: ApiError[RawError]

def get_fleet_telemetry_errors_for_a_vehicle(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Any

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_fleet_telemetry_errors_for_a_vehicle("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_fleet_telemetry_errors_for_a_vehicle("some example string")
    # TODO: Handle 'response' of type Any
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Any -- Fleet telemetry errors

OnError: ApiError[RawError]

def get_vehicle(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Api1VehiclesResponseResponse200

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.get_vehicle("some example string")
    # TODO: Handle 'response' of type Api1VehiclesResponseResponse200
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.get_vehicle("some example string")
    # TODO: Handle 'response' of type Api1VehiclesResponseResponse200
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1VehiclesResponseResponse200 -- Vehicle info

OnError: ApiError[RawError]

def list_vehicles(*, request_options: RequestOptionsOrDict | None = None) -> Api1VehiclesResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.list_vehicles()
    # TODO: Handle 'response' of type Api1VehiclesResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.list_vehicles()
    # TODO: Handle 'response' of type Api1VehiclesResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1VehiclesResponse -- Vehicles list

OnError: ApiError[RawError]

def mobile_enabled(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Api1VehiclesMobileEnabledResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.mobile_enabled("some example string")
    # TODO: Handle 'response' of type Api1VehiclesMobileEnabledResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.mobile_enabled("some example string")
    # TODO: Handle 'response' of type Api1VehiclesMobileEnabledResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1VehiclesMobileEnabledResponse -- Mobile access status

OnError: ApiError[RawError]

def nearby_charging_sites(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Api1VehiclesNearbyChargingSitesResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.nearby_charging_sites("some example string")
    # TODO: Handle 'response' of type Api1VehiclesNearbyChargingSitesResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.nearby_charging_sites("some example string")
    # TODO: Handle 'response' of type Api1VehiclesNearbyChargingSitesResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1VehiclesNearbyChargingSitesResponse -- Charging sites

OnError: ApiError[RawError]

def remove_driver_access_from_a_vehicle(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> SimpleOkResponse

Description

Send a DELETE request.

Usage

Sync

try:
    response = client.vehicles.remove_driver_access_from_a_vehicle("some example string")
    # TODO: Handle 'response' of type SimpleOkResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.remove_driver_access_from_a_vehicle("some example string")
    # TODO: Handle 'response' of type SimpleOkResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: SimpleOkResponse -- Driver removed

OnError: ApiError[RawError]

def set_enterprise_payer_roles(vin: str, body: EnterprisePayerRequest | EnterprisePayerRequestDict, *, request_options: RequestOptionsOrDict | None = None) -> None

Description

Send a POST request.

Usage

Sync

try:
    client.vehicles.set_enterprise_payer_roles(
        "some example string", EnterprisePayerRequest(role="some example string")
    )
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    await async_client.vehicles.set_enterprise_payer_roles(
        "some example string", EnterprisePayerRequest(role="some example string")
    )
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vin`	`str`	Value sent with the request.
`body`	`EnterprisePayerRequest \| EnterprisePayerRequestDict`	The request body.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: No content

OnError: ApiError[RawError]

def vehicle_live_data(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> SiteInfoResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.vehicle_live_data("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.vehicle_live_data("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: SiteInfoResponse -- Realtime vehicle data

OnError: ApiError[RawError]

def vehicle_options(vin: str, *, request_options: RequestOptionsOrDict | None = None) -> Api1DxVehiclesOptionsResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.vehicle_options("some example string")
    # TODO: Handle 'response' of type Api1DxVehiclesOptionsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.vehicle_options("some example string")
    # TODO: Handle 'response' of type Api1DxVehiclesOptionsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vin`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1DxVehiclesOptionsResponse -- Vehicle options

OnError: ApiError[RawError]

def vehicle_specs(vin: str, *, request_options: RequestOptionsOrDict | None = None) -> SiteInfoResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.vehicle_specs("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.vehicle_specs("some example string")
    # TODO: Handle 'response' of type SiteInfoResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vin`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: SiteInfoResponse -- Vehicle specifications

OnError: ApiError[RawError]

def wake_up_vehicle(vehicle_tag: str, *, request_options: RequestOptionsOrDict | None = None) -> Api1VehiclesWakeUpResponse

Description

Send a POST request.

Usage

Sync

try:
    response = client.vehicles.wake_up_vehicle("some example string")
    # TODO: Handle 'response' of type Api1VehiclesWakeUpResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.wake_up_vehicle("some example string")
    # TODO: Handle 'response' of type Api1VehiclesWakeUpResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`vehicle_tag`	`str`	Value sent with the request.
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1VehiclesWakeUpResponse -- Vehicle awakened

OnError: ApiError[RawError]

def warranty_details(*, request_options: RequestOptionsOrDict | None = None) -> Api1DxWarrantyDetailsResponse

Description

Send a GET request.

Usage

Sync

try:
    response = client.vehicles.warranty_details()
    # TODO: Handle 'response' of type Api1DxWarrantyDetailsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Async

try:
    response = await async_client.vehicles.warranty_details()
    # TODO: Handle 'response' of type Api1DxWarrantyDetailsResponse
except ApiError as e:
    ...  # TODO: Handle 'e.error' of type RawError

Parameters

Name	Type	Description
`request_options`	`RequestOptionsOrDict \| None`	Per-call overrides for this one request, such as a timeout, extra headers, or its retry count and statuses.

Response

OnSuccess: Api1DxWarrantyDetailsResponse -- Warranty information

OnError: ApiError[RawError]

FilesExpand file tree

api-reference.md

Latest commit

History

api-reference.md

File metadata and controls

Reference

Charging

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Energy

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Partner

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage

Parameters

Response

Description

Usage