Karbone/com.ekino.oss.karbone

Package-level declarations

Types

Entry point of the Karbone SDK, a Kotlin client for the Carbone document generation API.

What consumers should depend on. Karbone is the real client; com.ekino.oss.karbone.testing.FakeKarbone is an in-memory double.

KarboneConfig

data class KarboneConfig(val baseUrl: String, val token: String? = null, val apiVersion: Int? = null, val connectTimeout: Duration = 10.seconds, val requestTimeout: Duration = 60.seconds, val retry: RetryPolicy = RetryPolicy.None, val json: Json = DefaultJson, val userAgent: String = "karbone/")

Immutable per-client configuration.

KarboneError

sealed interface KarboneError

Every way a Karbone call can fail, as a value.

KarboneException

class KarboneException(val error: KarboneError) : RuntimeException

Thrown by the blocking facade only. Kotlin callers get KarboneError through Raise.

Renders

interface Renders

Document generation: /render.

RetryPolicy

sealed interface RetryPolicy

Retry on transport failures only (connection reset, timeout). API errors are never retried.

Templates

interface Templates

Template management: /template and /templates.