Skip to content

api-reference.md

Latest commit

 

History

History
3527 lines (2440 loc) · 68.8 KB

api-reference.md

File metadata and controls

3527 lines (2440 loc) · 68.8 KB
Raw

Reference

Every operation below is shown in its throwing form. On an error status it throws ApiException<TError> — the status code, headers, content type and the operation's error type, RawError (the raw body) when the spec declares none — and where an operation offers an …AsResult sibling, that sibling returns ApiResult<TResponse, TError> instead. A request that produces no usable response surfaces as SdkConnectionException or SdkTimeoutException, a body that does not match the documented response type as ResponseDeserializationException, and a credential that cannot be applied as AuthSchemeException; all of them derive from SdkException and name the failed call. See README → Error Handling.

Source: TeslaFleetManagementApiClient

Charging

Source: Charging

Task<ChargingHistoryResponse> GetChargingHistory(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

Returns the paginated charging history for the authenticated account.

Usage

try
{
    var response = await client.Charging.GetChargingHistory();
    // TODO: Handle 'response' of type ChargingHistoryResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: ChargingHistoryResponse

OnError: ApiException<RawError>

Task GetChargingInvoice(GetChargingInvoiceRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

Returns a charging invoice PDF for a charging session.

Usage

try
{
    await client.Charging.GetChargingInvoice(new GetChargingInvoiceRequest { Id = "some example string" });
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetChargingInvoiceRequest

Response

OnSuccess: No content

OnError: ApiException<RawError>

Task<ChargingSessionsResponse> GetChargingSessions(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

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

Usage

try
{
    var response = await client.Charging.GetChargingSessions();
    // TODO: Handle 'response' of type ChargingSessionsResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: ChargingSessionsResponse

OnError: ApiException<RawError>

Energy

Source: Energy

Task<BackupResponse> AdjustSiteSBackupReserve(AdjustSiteSBackupReserveRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.AdjustSiteSBackupReserve(new AdjustSiteSBackupReserveRequest
    {
        EnergySiteId = "some example string",
        Body = new BackupRequest { BackupReservePercent = 1 },
    });
    // TODO: Handle 'response' of type BackupResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

AdjustSiteSBackupReserveRequest

Response

OnSuccess: BackupResponse

OnError: ApiException<RawError>

Task<GenericUpdateResponse> AdjustSiteSOffGridVehicleChargingReserve(AdjustSiteSOffGridVehicleChargingReserveRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.AdjustSiteSOffGridVehicleChargingReserve(
        new AdjustSiteSOffGridVehicleChargingReserveRequest
        {
            EnergySiteId = "some example string",
            Body = new OffGridVehicleChargingReserveRequest { OffGridVehicleChargingReservePercent = 1 },
        });
    // TODO: Handle 'response' of type GenericUpdateResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

AdjustSiteSOffGridVehicleChargingReserveRequest

Response

OnSuccess: GenericUpdateResponse

OnError: ApiException<RawError>

Task<GenericUpdateResponse> AllowDisallowChargingFromTheGridAndExportingEnergyToTheGrid(AllowDisallowChargingFromTheGridAndExportingEnergyToTheGridRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.AllowDisallowChargingFromTheGridAndExportingEnergyToTheGrid(
        new AllowDisallowChargingFromTheGridAndExportingEnergyToTheGridRequest
        {
            EnergySiteId = "some example string",
        });
    // TODO: Handle 'response' of type GenericUpdateResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

AllowDisallowChargingFromTheGridAndExportingEnergyToTheGridRequest

Response

OnSuccess: GenericUpdateResponse

OnError: ApiException<RawError>

Task<CalendarHistoryResponse> GetBackupOrEnergyHistory(GetBackupOrEnergyHistoryRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.GetBackupOrEnergyHistory(new GetBackupOrEnergyHistoryRequest
    {
        EnergySiteId = "some example string",
        Kind = Kind.Backup,
        StartDate = DateTimeOffset.Parse("2024-01-15T09:30:00Z"),
        EndDate = DateTimeOffset.Parse("2024-01-15T09:30:00Z"),
    });
    // TODO: Handle 'response' of type CalendarHistoryResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetBackupOrEnergyHistoryRequest

Response

OnSuccess: CalendarHistoryResponse

OnError: ApiException<RawError>

Task<LiveStatusResponse> GetLiveSiteStatus(GetLiveSiteStatusRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.GetLiveSiteStatus(new GetLiveSiteStatusRequest
    {
        EnergySiteId = "some example string",
    });
    // TODO: Handle 'response' of type LiveStatusResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetLiveSiteStatusRequest

Response

OnSuccess: LiveStatusResponse

OnError: ApiException<RawError>

Task<SiteInfoResponse> GetSiteInformationAssetsSettingsFeatures(GetSiteInformationAssetsSettingsFeaturesRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.GetSiteInformationAssetsSettingsFeatures(
        new GetSiteInformationAssetsSettingsFeaturesRequest { EnergySiteId = "some example string" });
    // TODO: Handle 'response' of type SiteInfoResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetSiteInformationAssetsSettingsFeaturesRequest

Response

OnSuccess: SiteInfoResponse

OnError: ApiException<RawError>

Task<ProductsResponse> GetUserProductsVehiclesEnergySites(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.GetUserProductsVehiclesEnergySites();
    // TODO: Handle 'response' of type ProductsResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: ProductsResponse

OnError: ApiException<RawError>

Task<ChargeHistoryResponse> GetWallConnectorChargingHistory(GetWallConnectorChargingHistoryRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.GetWallConnectorChargingHistory(new GetWallConnectorChargingHistoryRequest
    {
        EnergySiteId = "some example string",
        Kind = KindGetWallConnectorChargingHistory.Charge,
        StartDate = DateTimeOffset.Parse("2024-01-15T09:30:00Z"),
        EndDate = DateTimeOffset.Parse("2024-01-15T09:30:00Z"),
    });
    // TODO: Handle 'response' of type ChargeHistoryResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetWallConnectorChargingHistoryRequest

Response

OnSuccess: ChargeHistoryResponse

OnError: ApiException<RawError>

Task<GenericUpdateResponse> SetSiteModeAutonomousOrSelfConsumption(SetSiteModeAutonomousOrSelfConsumptionRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.SetSiteModeAutonomousOrSelfConsumption(
        new SetSiteModeAutonomousOrSelfConsumptionRequest
        {
            EnergySiteId = "some example string",
            Body = new OperationRequest { DefaultRealMode = DefaultRealMode.Autonomous },
        });
    // TODO: Handle 'response' of type GenericUpdateResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

SetSiteModeAutonomousOrSelfConsumptionRequest

Response

OnSuccess: GenericUpdateResponse

OnError: ApiException<RawError>

Task<GenericUpdateResponse> UpdateStormWatchParticipation(UpdateStormWatchParticipationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.UpdateStormWatchParticipation(new UpdateStormWatchParticipationRequest
    {
        EnergySiteId = "some example string",
        Body = new StormModeRequest { Enabled = true },
    });
    // TODO: Handle 'response' of type GenericUpdateResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

UpdateStormWatchParticipationRequest

Response

OnSuccess: GenericUpdateResponse

OnError: ApiException<RawError>

Task<GenericUpdateResponse> UpdateTimeOfUseTouSettings(UpdateTimeOfUseTouSettingsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Energy.UpdateTimeOfUseTouSettings(new UpdateTimeOfUseTouSettingsRequest
    {
        EnergySiteId = "some example string",
        Body = new TimeOfUseSettingsRequest { TouSettings = new TouSettings() },
    });
    // TODO: Handle 'response' of type GenericUpdateResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

UpdateTimeOfUseTouSettingsRequest

Response

OnSuccess: GenericUpdateResponse

OnError: ApiException<RawError>

Partner

Source: Partner

Task<PublicKeyResponse> GetPublicKeyForADomain(GetPublicKeyForADomainRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Partner.GetPublicKeyForADomain(new GetPublicKeyForADomainRequest
    {
        Domain = "some example string",
    });
    // TODO: Handle 'response' of type PublicKeyResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetPublicKeyForADomainRequest

Response

OnSuccess: PublicKeyResponse

OnError: ApiException<RawError>

Task<FleetTelemetryErrorsResponse> GetRecentFleetTelemetryErrors(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Partner.GetRecentFleetTelemetryErrors();
    // TODO: Handle 'response' of type FleetTelemetryErrorsResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: FleetTelemetryErrorsResponse

OnError: ApiException<RawError>

Task<BackupResponse> GetVinsWithFleetTelemetryErrors(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Partner.GetVinsWithFleetTelemetryErrors();
    // TODO: Handle 'response' of type BackupResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: BackupResponse

OnError: ApiException<RawError>

Task<RegisterPartnerResponse> RegisterAPartnerAccount(RegisterAPartnerAccountRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Partner.RegisterAPartnerAccount(new RegisterAPartnerAccountRequest
    {
        Body = new RegisterPartnerRequest { Domain = "some example string" },
    });
    // TODO: Handle 'response' of type RegisterPartnerResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

RegisterAPartnerAccountRequest

Response

OnSuccess: RegisterPartnerResponse

OnError: ApiException<RawError>

User

Source: User

Task<OrdersResponse> GetActiveOrdersForAUser(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.User.GetActiveOrdersForAUser();
    // TODO: Handle 'response' of type OrdersResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: OrdersResponse

OnError: ApiException<RawError>

Task<BackupResponse> GetCustomFeatureFlagsForAUser(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.User.GetCustomFeatureFlagsForAUser();
    // TODO: Handle 'response' of type BackupResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: BackupResponse

OnError: ApiException<RawError>

Task<MeResponse> GetSummaryOfAUserSAccount(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.User.GetSummaryOfAUserSAccount();
    // TODO: Handle 'response' of type MeResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: MeResponse

OnError: ApiException<RawError>

Task<RegionResponse> GetUserSRegionAndFleetApiBaseUrl(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.User.GetUserSRegionAndFleetApiBaseUrl();
    // TODO: Handle 'response' of type RegionResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: RegionResponse

OnError: ApiException<RawError>

VehicleCommands

Source: VehicleCommands

Task<CommandResponse> Actuatetrunk(ActuatetrunkOperationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

Controls the front or rear trunk

Usage

try
{
    var response = await client.VehicleCommands.Actuatetrunk(new ActuatetrunkOperationRequest
    {
        VehicleTag = "some example string",
        Body = new ActuateTrunkRequest { WhichTrunk = WhichTrunk.Front },
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

ActuatetrunkOperationRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Addchargeschedule(AddchargescheduleOperationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Addchargeschedule(new AddchargescheduleOperationRequest
    {
        VehicleTag = "some example string",
        Body = new AddChargeScheduleRequest { Lat = 1.5d, Lon = 1.5d, Id = 1, Enabled = true },
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

AddchargescheduleOperationRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Addpreconditionschedule(AddpreconditionscheduleOperationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Addpreconditionschedule(new AddpreconditionscheduleOperationRequest
    {
        VehicleTag = "some example string",
        Body = new AddPreconditionScheduleRequest { Lat = 1.5d, Lon = 1.5d, Id = 1, Enabled = true },
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

AddpreconditionscheduleOperationRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Adjustmediavolume(AdjustmediavolumeRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Adjustmediavolume(new AdjustmediavolumeRequest
    {
        VehicleTag = "some example string",
        Body = new AdjustVolumeRequest { Volume = 1 },
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

AdjustmediavolumeRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Cancelsoftwareupdate(CancelsoftwareupdateRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Cancelsoftwareupdate(new CancelsoftwareupdateRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

CancelsoftwareupdateRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Chargemaxrange(ChargemaxrangeRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Chargemaxrange(new ChargemaxrangeRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

ChargemaxrangeRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Chargestandard(ChargestandardRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Chargestandard(new ChargestandardRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

ChargestandardRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> ClearPiNtoDriveAdmin(ClearPiNtoDriveAdminRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

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

Usage

try
{
    var response = await client.VehicleCommands.ClearPiNtoDriveAdmin(new ClearPiNtoDriveAdminRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

ClearPiNtoDriveAdminRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Closechargeportdoor(ClosechargeportdoorRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Closechargeportdoor(new ClosechargeportdoorRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

ClosechargeportdoorRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> EnableordisableGuestMode(EnableordisableGuestModeRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.EnableordisableGuestMode(new EnableordisableGuestModeRequest
    {
        VehicleTag = "some example string",
        Body = new GuestModeRequest { Enable = true },
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

EnableordisableGuestModeRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Eraseuserdata(EraseuserdataRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

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

Usage

try
{
    var response = await client.VehicleCommands.Eraseuserdata(new EraseuserdataRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

EraseuserdataRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Flashlights(FlashlightsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Description

Briefly flashes vehicle headlights.

Usage

try
{
    var response = await client.VehicleCommands.Flashlights(new FlashlightsRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

FlashlightsRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Honkhorn(HonkhornRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Honkhorn(new HonkhornRequest { VehicleTag = "some example string" });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

HonkhornRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Lockdoors(LockdoorsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Lockdoors(new LockdoorsRequest { VehicleTag = "some example string" });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

LockdoorsRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Nextfavoritemediatrack(NextfavoritemediatrackRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Nextfavoritemediatrack(new NextfavoritemediatrackRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

NextfavoritemediatrackRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Openchargeportdoor(OpenchargeportdoorRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Openchargeportdoor(new OpenchargeportdoorRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

OpenchargeportdoorRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Startcharging(StartchargingRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Startcharging(new StartchargingRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

StartchargingRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Startclimatepreconditioning(StartclimatepreconditioningRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Startclimatepreconditioning(new StartclimatepreconditioningRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

StartclimatepreconditioningRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Stopcharging(StopchargingRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Stopcharging(new StopchargingRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

StopchargingRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Stopclimatepreconditioning(StopclimatepreconditioningRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Stopclimatepreconditioning(new StopclimatepreconditioningRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

StopclimatepreconditioningRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Task<CommandResponse> Unlockdoors(UnlockdoorsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.VehicleCommands.Unlockdoors(new UnlockdoorsRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type CommandResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

UnlockdoorsRequest

Response

OnSuccess: CommandResponse

OnError: ApiException<RawError>

Vehicles

Source: Vehicles

Task<object> ConfigureFleetTelemetryUsingSignedJwsToken(ConfigureFleetTelemetryUsingSignedJwsTokenRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.ConfigureFleetTelemetryUsingSignedJwsToken(
        new ConfigureFleetTelemetryUsingSignedJwsTokenRequest { Body = new FleetTelemetryJwsRequest() });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

ConfigureFleetTelemetryUsingSignedJwsTokenRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<object> CreateOrUpdateFleetTelemetryConfiguration(CreateOrUpdateFleetTelemetryConfigurationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.CreateOrUpdateFleetTelemetryConfiguration(
        new CreateOrUpdateFleetTelemetryConfigurationRequest { Body = body });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

CreateOrUpdateFleetTelemetryConfigurationRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<object> DeleteFleetTelemetryConfiguration(DeleteFleetTelemetryConfigurationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.DeleteFleetTelemetryConfiguration(new DeleteFleetTelemetryConfigurationRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

DeleteFleetTelemetryConfigurationRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<DriversResponse> GetAllowedDriversForAVehicle(GetAllowedDriversForAVehicleRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetAllowedDriversForAVehicle(new GetAllowedDriversForAVehicleRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type DriversResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetAllowedDriversForAVehicleRequest

Response

OnSuccess: DriversResponse

OnError: ApiException<RawError>

Task<SiteInfoResponse> GetEligibleVehicleSubscriptions(GetEligibleVehicleSubscriptionsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetEligibleVehicleSubscriptions(new GetEligibleVehicleSubscriptionsRequest
    {
        Vin = "some example string",
    });
    // TODO: Handle 'response' of type SiteInfoResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetEligibleVehicleSubscriptionsRequest

Response

OnSuccess: SiteInfoResponse

OnError: ApiException<RawError>

Task<SiteInfoResponse> GetEligibleVehicleUpgrades(GetEligibleVehicleUpgradesRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetEligibleVehicleUpgrades(new GetEligibleVehicleUpgradesRequest
    {
        Vin = "some example string",
    });
    // TODO: Handle 'response' of type SiteInfoResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetEligibleVehicleUpgradesRequest

Response

OnSuccess: SiteInfoResponse

OnError: ApiException<RawError>

Task<object> GetEnterpriseRolesForAVehicle(GetEnterpriseRolesForAVehicleRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetEnterpriseRolesForAVehicle(new GetEnterpriseRolesForAVehicleRequest
    {
        Vin = "some example string",
    });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetEnterpriseRolesForAVehicleRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<object> GetFleetStatusForVehicles(GetFleetStatusForVehiclesRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetFleetStatusForVehicles(new GetFleetStatusForVehiclesRequest
    {
        Body = new FleetStatusRequest(),
    });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetFleetStatusForVehiclesRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<object> GetFleetTelemetryConfiguration(GetFleetTelemetryConfigurationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetFleetTelemetryConfiguration(new GetFleetTelemetryConfigurationRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetFleetTelemetryConfigurationRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<object> GetFleetTelemetryErrorsForAVehicle(GetFleetTelemetryErrorsForAVehicleRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetFleetTelemetryErrorsForAVehicle(
        new GetFleetTelemetryErrorsForAVehicleRequest { VehicleTag = "some example string" });
    // TODO: Handle 'response' of type object
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetFleetTelemetryErrorsForAVehicleRequest

Response

OnSuccess: object

OnError: ApiException<RawError>

Task<Api1VehiclesResponseResponse200> GetVehicle(GetVehicleRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.GetVehicle(new GetVehicleRequest { VehicleTag = "some example string" });
    // TODO: Handle 'response' of type Api1VehiclesResponseResponse200
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

GetVehicleRequest

Response

OnSuccess: Api1VehiclesResponseResponse200

OnError: ApiException<RawError>

Task<Api1VehiclesResponse> ListVehicles(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.ListVehicles();
    // TODO: Handle 'response' of type Api1VehiclesResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: Api1VehiclesResponse

OnError: ApiException<RawError>

Task<Api1VehiclesMobileEnabledResponse> MobileEnabled(MobileEnabledRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.MobileEnabled(new MobileEnabledRequest { VehicleTag = "some example string" });
    // TODO: Handle 'response' of type Api1VehiclesMobileEnabledResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

MobileEnabledRequest

Response

OnSuccess: Api1VehiclesMobileEnabledResponse

OnError: ApiException<RawError>

Task<Api1VehiclesNearbyChargingSitesResponse> NearbyChargingSites(NearbyChargingSitesRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.NearbyChargingSites(new NearbyChargingSitesRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type Api1VehiclesNearbyChargingSitesResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

NearbyChargingSitesRequest

Response

OnSuccess: Api1VehiclesNearbyChargingSitesResponse

OnError: ApiException<RawError>

Task<SimpleOkResponse> RemoveDriverAccessFromAVehicle(RemoveDriverAccessFromAVehicleRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.RemoveDriverAccessFromAVehicle(new RemoveDriverAccessFromAVehicleRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type SimpleOkResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

RemoveDriverAccessFromAVehicleRequest

Response

OnSuccess: SimpleOkResponse

OnError: ApiException<RawError>

Task SetEnterprisePayerRoles(SetEnterprisePayerRolesRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    await client.Vehicles.SetEnterprisePayerRoles(new SetEnterprisePayerRolesRequest
    {
        Vin = "some example string",
        Body = new EnterprisePayerRequest { Role = "some example string" },
    });
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

SetEnterprisePayerRolesRequest

Response

OnSuccess: No content

OnError: ApiException<RawError>

Task<SiteInfoResponse> VehicleLiveData(VehicleLiveDataRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.VehicleLiveData(new VehicleLiveDataRequest
    {
        VehicleTag = "some example string",
    });
    // TODO: Handle 'response' of type SiteInfoResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

VehicleLiveDataRequest

Response

OnSuccess: SiteInfoResponse

OnError: ApiException<RawError>

Task<Api1DxVehiclesOptionsResponse> VehicleOptions(VehicleOptionsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.VehicleOptions(new VehicleOptionsRequest { Vin = "some example string" });
    // TODO: Handle 'response' of type Api1DxVehiclesOptionsResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

VehicleOptionsRequest

Response

OnSuccess: Api1DxVehiclesOptionsResponse

OnError: ApiException<RawError>

Task<SiteInfoResponse> VehicleSpecs(VehicleSpecsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.VehicleSpecs(new VehicleSpecsRequest { Vin = "some example string" });
    // TODO: Handle 'response' of type SiteInfoResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

VehicleSpecsRequest

Response

OnSuccess: SiteInfoResponse

OnError: ApiException<RawError>

Task<Api1VehiclesWakeUpResponse> WakeUpVehicle(WakeUpVehicleRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.WakeUpVehicle(new WakeUpVehicleRequest { VehicleTag = "some example string" });
    // TODO: Handle 'response' of type Api1VehiclesWakeUpResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Request

WakeUpVehicleRequest

Response

OnSuccess: Api1VehiclesWakeUpResponse

OnError: ApiException<RawError>

Task<Api1DxWarrantyDetailsResponse> WarrantyDetails(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default);

Usage

try
{
    var response = await client.Vehicles.WarrantyDetails();
    // TODO: Handle 'response' of type Api1DxWarrantyDetailsResponse
}
catch (ApiException<RawError> ex)
{
    // TODO: Handle 'ex.Error' of type RawError
}

Response

OnSuccess: Api1DxWarrantyDetailsResponse

OnError: ApiException<RawError>