volvo-api-client/com.github.ayastrebov.volvo.api.client/VolvoCarsConfig

VolvoCarsConfig

data class VolvoCarsConfig(val apiKey: String, val oauth: OAuthConfig? = null, val token: String? = null, val logging: LoggingConfig = LoggingConfig(), val timeout: Timeout = Timeout(socket = 30.seconds), val headers: Map<String, String> = emptyMap(), val proxy: ProxyConfig? = null, val retry: RetryStrategy = RetryStrategy(), val circuitBreaker: CircuitBreakerConfig? = null, val engine: HttpClientEngine? = null, val httpClientConfig: HttpClientConfig<*>.() -> Unit = {})(source)

Volvo API client configuration.

Supports two authentication modes:

1. OAuth2 with automatic refresh (recommended):

VolvoCarsConfig(
    apiKey = "your-vcc-api-key",
    oauth = OAuthConfig(
        accessToken = storedAccessToken,
        refreshToken = storedRefreshToken,
        clientId = "your-client-id",
        clientSecret = "your-client-secret",
        onTokensRefreshed = { access, refresh -> save(access, refresh) }
    )
)

2. Static token (for testing or short-lived scripts):

VolvoCarsConfig(
    apiKey = "your-vcc-api-key",
    token = "your-access-token"
)

Throws

IllegalArgumentException

if neither oauth nor token is provided, or if both are provided

Constructors

VolvoCarsConfig

constructor(apiKey: String, oauth: OAuthConfig? = null, token: String? = null, logging: LoggingConfig = LoggingConfig(), timeout: Timeout = Timeout(socket = 30.seconds), headers: Map<String, String> = emptyMap(), proxy: ProxyConfig? = null, retry: RetryStrategy = RetryStrategy(), circuitBreaker: CircuitBreakerConfig? = null, engine: HttpClientEngine? = null, httpClientConfig: HttpClientConfig<*>.() -> Unit = {})

Properties

apiKey

val apiKey: String

VCC API key from the Volvo Developer Portal

circuitBreaker

val circuitBreaker: CircuitBreakerConfig?

Optional circuit breaker to stop retries after sustained failures. When open, requests fail immediately without hitting the server. See CircuitBreakerConfig.

engine

val engine: HttpClientEngine?

Explicit Ktor HttpClientEngine (useful for testing with mock engines)

headers

val headers: Map<String, String>

Additional HTTP headers to include in every request

httpClientConfig