Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AccessStatusValue(val value: AccessValue)
Link copied to clipboard
@Serializable
data class AccessValue(val overallStatus: String? = null, val doorLockStatus: String? = null, val doors: List<DoorValue>? = null, val windows: List<WindowValue>? = null)
Link copied to clipboard
@Serializable
data class AccessWrapper(val accessStatus: AccessStatusValue? = null)
Link copied to clipboard
@Serializable
data class BatterySupportContent(val batterySupport: String? = null)
Link copied to clipboard
@Serializable
data class BatterySupportValue(val value: BatterySupportContent)
Link copied to clipboard
@Serializable
data class BatterySupportWrapper(val batterySupport: BatterySupportValue? = null)
Link copied to clipboard
Link copied to clipboard
@Serializable
data class ChargingProfileDto(val id: Int? = null, val name: String? = null, val maxChargingCurrent: String? = null, val minSOC_pct: Int? = null, val targetSOC_pct: Int? = null, val options: ChargingProfileOptionsDto? = null, val preferredChargingTimes: List<PreferredChargingTimeDto>? = null)
Link copied to clipboard
@Serializable
data class ChargingProfileOptionsDto(val id: Int? = null, val autoUnlockPlugWhenCharged: String? = null)
Link copied to clipboard
class ChargingProfilesApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF charging profiles endpoint.

Link copied to clipboard
@Serializable
data class ChargingProfilesContent(val carCapturedTimestamp: String? = null, val profiles: List<ChargingProfileDto>? = null, val vehiclePositionedInProfileID: Int? = null, val nextChargingTimer: NextChargingTimerDto? = null)
Link copied to clipboard
@Serializable
data class ChargingProfilesResponse(val chargingProfiles: ChargingProfilesContent? = null)
Link copied to clipboard
@Serializable
data class ChargingStatusValue(val value: ChargingValue)
Link copied to clipboard
@Serializable
data class ChargingValue(val carCapturedTimestamp: String, val plugConnectionState: String? = null, val plugLockState: String? = null, val chargingState: String? = null, val chargeMode: String? = null, val chargePowerInKw: Double? = null, val remainingTimeToCompleteSocInMin: Int? = null, val targetSocValue: Int? = null)
Link copied to clipboard
@Serializable
data class ChargingWrapper(val chargingStatus: ChargingStatusValue? = null)
Link copied to clipboard
@Serializable
data class ClimatisationSettingsInner(val carCapturedTimestamp: String? = null, val targetTemperature: Double? = null, val windowHeatingEnabled: Boolean? = null)
Link copied to clipboard
@Serializable
data class ClimatisationSettingsValue(val value: ClimatisationSettingsInner)
Link copied to clipboard
@Serializable
data class ClimatisationStatusValue(val value: ClimatisationValue)
Link copied to clipboard
@Serializable
data class ClimatisationValue(val carCapturedTimestamp: String, val climatisationState: String? = null, val remainingClimatisationTimeMin: Int? = null)
Link copied to clipboard
@Serializable
data class ClimatisationWrapper(val climatisationStatus: ClimatisationStatusValue? = null, val climatisationSettings: ClimatisationSettingsValue? = null)
Link copied to clipboard
@Serializable
data class ConnectionState(val isOnline: Boolean? = null, val ignitionOn: Boolean? = null, val inMotion: Boolean? = null, val batteryPowerLevel: String? = null, val isActive: Boolean? = null, val dailyPowerBudgetAvailable: Boolean? = null)
Link copied to clipboard
@Serializable
data class ConnectionWarningValue(val insufficientBatteryLevelWarning: Boolean? = null, val dailyPowerBudgetWarning: Boolean? = null)
Link copied to clipboard
@Serializable
data class DoorValue(val name: String? = null, val status: List<String>? = null)
Link copied to clipboard
@Serializable
data class FuelLevelStatusValue(val value: FuelLevelValue)
Link copied to clipboard
@Serializable
data class FuelLevelValue(val mileage_km: Int? = null)
Link copied to clipboard
@Serializable
data class FuelStatusValue(val carCapturedTimestamp: String, val carType: String? = null, val primaryEngine: PrimaryEngine? = null, val totalRangeKm: Int? = null)
Link copied to clipboard
@Serializable
data class FuelStatusWrapper(val rangeStatus: RangeStatusValue? = null)
Link copied to clipboard
@Serializable
data class GpsCoordinates(val latitude: Double, val longitude: Double)
Link copied to clipboard
@Serializable
data class GpsPositionContent(val carCapturedTimestamp: String, val gpsCoordinates: GpsCoordinates, val heading: Double? = null)
Link copied to clipboard
@Serializable
data class GpsPositionValue(val value: GpsPositionContent)
Link copied to clipboard
Link copied to clipboard
@Serializable
data class LightValue(val name: String? = null, val status: List<String>? = null)
Link copied to clipboard
@Serializable
data class LvBatteryContent(val batterySupport: String? = null, val voltage: Double? = null)
Link copied to clipboard
@Serializable
data class LvBatteryValue(val value: LvBatteryContent)
Link copied to clipboard
@Serializable
data class LvBatteryWrapper(val lvBattery: LvBatteryValue? = null)
Link copied to clipboard
@Serializable
data class MeasurementsWrapper(val fuelLevelStatus: FuelLevelStatusValue? = null, val temperatureBatteryStatus: TemperatureBatteryStatusValue? = null, val odometerStatus: OdometerStatusValue? = null)
Link copied to clipboard
@Serializable
data class NextChargingTimerDto(val id: Int? = null, val targetSOCreachable: String? = null)
Link copied to clipboard
@Serializable
data class OdometerStatusValue(val value: OdometerValue)
Link copied to clipboard
@Serializable
data class OdometerValue(val odometer: Int? = null)
Link copied to clipboard
@Serializable
data class ParkingPositionWrapper(val gpsPosition: GpsPositionValue? = null)
Link copied to clipboard
@Serializable
data class PreferredChargingTimeDto(val id: Int? = null, val enabled: Boolean? = null, val startTime: String? = null, val endTime: String? = null)
Link copied to clipboard
@Serializable
data class PrimaryEngine(val currentSOC_pct: Int? = null, val remainingRange_km: Int? = null)
Link copied to clipboard
@Serializable
data class RangeStatusValue(val value: FuelStatusValue)
Link copied to clipboard
@Serializable
data class ReadinessStatusValue(val value: ReadinessValue)
Link copied to clipboard
@Serializable
data class ReadinessValue(val connectionState: ConnectionState? = null, val connectionWarning: ConnectionWarningValue? = null)
Link copied to clipboard
@Serializable
data class ReadinessWrapper(val readinessStatus: ReadinessStatusValue? = null)
Link copied to clipboard
Link copied to clipboard
@Serializable
data class SelectiveStatusResponse(val fuelStatus: FuelStatusWrapper? = null, val charging: ChargingWrapper? = null, val climatisation: ClimatisationWrapper? = null, val parkingPosition: ParkingPositionWrapper? = null, val readiness: ReadinessWrapper? = null, val measurements: MeasurementsWrapper? = null, val access: AccessWrapper? = null, val vehicleLights: VehicleLightsWrapper? = null, val lvBattery: LvBatteryWrapper? = null, val vehicleHealthWarnings: VehicleHealthWarningsWrapper? = null, val vehicleHealthInspection: VehicleHealthInspectionWrapper? = null, val batterySupport: BatterySupportWrapper? = null)
Link copied to clipboard
@Serializable
data class TemperatureBatteryStatusValue(val value: TemperatureBatteryValue? = null)
Link copied to clipboard
@Serializable
data class TemperatureBatteryValue(val temperatureValue: Double? = null, val temperatureHvBatteryMin_K: Double? = null, val temperatureHvBatteryMax_K: Double? = null)
Link copied to clipboard
class TripsApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF trip data endpoints.

Link copied to clipboard
@Serializable
data class TripsResponse(val id: Long? = null, val tripEndTimestamp: String? = null, val tripType: String? = null, val vehicleType: String? = null, val mileage_km: Int? = null, val startMileage_km: Int? = null, val overallMileage_km: Int? = null, val travelTime: Int? = null, val averageFuelConsumption: Double? = null, val averageElectricConsumption: Double? = null, val averageSpeed_kmph: Double? = null, val averageAuxConsumption: Double? = null, val averageRecuperation: Double? = null)
Link copied to clipboard

Trip aggregation type used by the BFF trips endpoint.

Link copied to clipboard
class VehicleApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF vehicle data endpoints.

Link copied to clipboard
class VehicleCommandsApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF vehicle command endpoints.

Link copied to clipboard
@Serializable
data class VehicleData(val vin: String, val model: String? = null, val nickname: String? = null, val brandCode: String? = null, val role: String? = null, val enrollmentStatus: String? = null, val userRoleStatus: String? = null, val devicePlatform: String? = null)
Link copied to clipboard
@Serializable
data class VehicleHealthInspectionContent(val inspectionDue_days: Int? = null, val inspectionDue_km: Int? = null, val oilServiceDue_days: Int? = null, val oilServiceDue_km: Int? = null)
Link copied to clipboard
Link copied to clipboard
@Serializable
data class VehicleHealthInspectionWrapper(val vehicleHealthInspection: VehicleHealthInspectionValue? = null)
Link copied to clipboard
@Serializable
data class VehicleHealthWarningsContent(val mileage_km: Int? = null, val warningLights: List<WarningLightValue>? = null, val insufficientBatteryLevelWarning: Boolean? = null)
Link copied to clipboard
@Serializable
data class VehicleHealthWarningsValue(val value: VehicleHealthWarningsContent)
Link copied to clipboard
@Serializable
data class VehicleHealthWarningsWrapper(val vehicleHealthWarnings: VehicleHealthWarningsValue? = null)
Link copied to clipboard
@Serializable
data class VehicleLightsContent(val lights: List<LightValue>? = null)
Link copied to clipboard
@Serializable
data class VehicleLightsValue(val value: VehicleLightsContent)
Link copied to clipboard
@Serializable
data class VehicleLightsWrapper(val vehicleLights: VehicleLightsValue? = null)
Link copied to clipboard
@Serializable
data class VehicleListResponse(val data: List<VehicleData>)
Link copied to clipboard
@Serializable
data class WarningLightValue(val text: String? = null, val category: String? = null, val priority: Int? = null, val iconColor: String? = null)
Link copied to clipboard
@Serializable
data class WindowValue(val name: String? = null, val status: List<String>? = null)