FrameSDK/com.framepayments.framesdk.accountevents

Package-level declarations

Types

Link copied to clipboard
object AccountEventDetail

Fixed developer-facing detail strings reused across account events. Dynamic details stay inline at the call site.

Link copied to clipboard
object AccountEventEmitter

Builds and queues account/diagnostic events for the backend's merchant dashboard.

Link copied to clipboard
enum AccountEventName : Enum<AccountEventName>

The wire name for an account event. Values must match the shared cross-SDK naming contract in docs/ACCOUNT_EVENTS.md (FRA-6548) — do not rename a value's wire string without updating that catalog too.

Link copied to clipboard
class AccountEventQueue(maxQueueSize: Int = 200, flushSizeThreshold: Int = 20, flushIntervalMillis: Long, flushHandler: suspend (List<AccountEventsRequests.Event>) -> Pair<RecordResponse?, NetworkingError?> = { events -> AccountEventsAPI.record(events) })

Buffers account/diagnostic events and flushes them to the backend in batches.

Link copied to clipboard
enum AccountEventScreen : Enum<AccountEventScreen>

The screen/flow an account event happened on. Values must match the shared cross-SDK naming contract in docs/ACCOUNT_EVENTS.md (FRA-6548) — do not rename a value's wire string without updating that catalog too.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class RecordResponse(val recorded: Int, val rejected: List<Rejection>)

Response body for POST /v1/client/account_events.

Link copied to clipboard
data class Rejection(val index: Int, val name: String, val error: String)

One rejected event from a batch, identified by its index in the submitted request.