thankly-sdk-jvm/ai.thankly.sdk

Package-level declarations

Types

@Serializable

data class CapabilityRequest(val type: String, val config: JsonObject? = null, val playbookId: String? = null)

A capability to run, with its per-capability configuration.

data class Cart(val type: CartType, val products: List<CartProduct>, val additionalContext: Map<String, String>? = null, val vibes: List<Vibe>? = null) : ExperienceContext

A basket or selection of products.

CartProduct

data class CartProduct(val productId: String? = null, val name: String? = null, val brand: String? = null, val price: Double? = null, val category: String? = null)

A product in a cart. Supply productId to have the catalog fill the rest.

CartType

@Serializable

enum CartType : Enum<CartType>

What kind of cart is being described.

Cruise

@Serializable

@SerialName(value = "cruise")

data class Cruise(val departurePort: String, val arrivalPort: String, val departureTimestamp: Long, val arrivalTimestamp: Long, val numTravelers: Int) : Travel

A cruise leg.

EngagementDecision

data class EngagementDecision(val decisionId: String, val experienceId: String, val accessToken: String, val status: String, val widgets: List<Widget> = emptyList(), val widgetData: JsonObject? = null)

The outcome of an engagement decision.

Experience

class Experience

A handle to one experience.

ExperienceContext

sealed interface ExperienceContext

The subject of an experience.

ExperienceResult

@Serializable

data class ExperienceResult(val experienceId: String, val status: ExperienceStatus, val widgets: List<Widget> = emptyList())

A fully-polled experience.

ExperienceStatus

@Serializable

enum ExperienceStatus : Enum<ExperienceStatus>

Where an experience is in its lifecycle.

Flight

@Serializable

@SerialName(value = "flight")

data class Flight(val departureAirport: String, val arrivalAirport: String, val departureTimestamp: Long, val arrivalTimestamp: Long, val numTravelers: Int, val seatClass: SeatClass) : Travel

A flight leg.

HttpEngine

interface HttpEngine

The SDK's one outbound seam.

HttpResponse

data class HttpResponse(val status: Int, val body: String)

A raw HTTP response, before any status interpretation.

OkHttpEngine

class OkHttpEngine(client: OkHttpClient = defaultClient()) : HttpEngine

Default HttpEngine, backed by OkHttp.

SeatClass

@Serializable

enum SeatClass : Enum<SeatClass>

Cabin class on a flight.

Signal

@Serializable

data class Signal(val externalCustomerId: String, val signalType: String, val occurredAt: String = nowIso(), val clientSignalId: String = UUID.randomUUID().toString(), val properties: Map<String, String> = emptyMap())

One behavioural event about a customer.

SignalIngestResult

@Serializable

data class SignalIngestResult(val accepted: Int = 0, val rejected: Int = 0, val errors: List<SignalRejection> = emptyList())

What ingest did with a batch.

SignalRejection

@Serializable

data class SignalRejection(val clientSignalId: String? = null, val field: String? = null, val error: String? = null)

Why one signal was rejected at ingest.

ThanklyCatalog

class ThanklyCatalog(config: ThanklyConfig, engine: HttpEngine = OkHttpEngine())

Catalog reads and asset uploads.

ThanklyClient

class ThanklyClient(config: ThanklyConfig, engine: HttpEngine = OkHttpEngine())

Entry point for the Experience API.

ThanklyConfig

class ThanklyConfig(apiHost: String, val tokenProvider: TokenProvider, val pollIntervalMs: Long, val maxPollAttempts: Int = 60)

How this client reaches Thankly.

ThanklyException

sealed class ThanklyException : Exception

Every error this SDK raises.

ThanklyLifecycle

class ThanklyLifecycle(config: ThanklyConfig, engine: HttpEngine = OkHttpEngine())

Lifecycle marketing: signals in, engagement decisions out, outcomes back.

Token

data class Token(val value: String, val expiresIn: Duration)

An access token and how long it remains valid.

TokenProvider

fun interface TokenProvider

Supplies a Cognito access token for the X-Authorization header.

Topic

data class Topic(val topic: String, val questions: List<String>, val additionalContext: Map<String, String>? = null, val vibes: List<Vibe>? = null) : ExperienceContext

A subject the customer is interested in, with questions to answer about it.

Travel

@Serializable

sealed interface Travel

How a customer is travelling.

Trip

data class Trip(val travel: Travel? = null, val location: TripLocation? = null, val additionalContext: Map<String, String>? = null, val vibes: List<Vibe>? = null) : ExperienceContext

A journey, a place, or both.

TripLocation

data class TripLocation(val placeName: String? = null, val latitude: Double? = null, val longitude: Double? = null, val radiusMeters: Int? = null)

A place to bias discovery toward.

Vibe

@Serializable

enum Vibe : Enum<Vibe>

Mood applied to recommendations. Mirrors Vibe in api/domains/experiences.py.

Widget

@Serializable

data class Widget(val capabilityId: String, val type: String? = null, val status: String, val currentVersion: Int = 0, val heading: String? = null, val errorMessage: String? = null, val data: JsonObject? = null)

One capability's output within an experience.

Functions

caching

fun TokenProvider.Companion.caching(safetyMargin: Duration = 60.seconds, now: () -> Long = { System.currentTimeMillis() }, fetch: suspend () -> Token): TokenProvider

Wrap a token source in caching, early refresh, and refresh coalescing.

clientCredentials

fun TokenProvider.Companion.clientCredentials(clientId: String, clientSecret: String, apiHost: String, engine: HttpEngine = OkHttpEngine()): TokenProvider

Exchange client credentials for an access token, with caching.