FrameSDK/com.framepayments.framesdk

Package-level declarations

Types

DefaultURLSession

class DefaultURLSession(client: OkHttpClient) : URLSessionProtocol

Default URLSessionProtocol implementation backed by OkHttp.

EmptyRequest

data class EmptyRequest(val description: String?)

An empty request body placeholder used for API calls that require a POST with no payload.

FileUpload

data class FileUpload(val bitmap: Bitmap, val fieldName: FileUploadFieldName)

A bitmap image prepared for upload to the Frame document verification endpoint.

FileUploadFieldName

enum FileUploadFieldName : Enum<FileUploadFieldName>

The multipart form-data field name for a document image upload.

FrameConfigurationError

class FrameConfigurationError(message: String) : RuntimeException

Thrown when FrameNetworking.initializeWithAPIKey has not been called before a Frame SDK component is used, or when required configuration values are missing or invalid.

FrameMetadata

data class FrameMetadata(val page: Int?, val url: String?, val hasMore: Boolean?)

Pagination metadata returned by Frame list endpoints.

FrameNetworking

object FrameNetworking

Central SDK singleton. Initialize once with initializeWithAPIKey from your Application.onCreate before using any Frame UI component or API client.

FrameNetworkingEndpoints

interface FrameNetworkingEndpoints

Describes a single Frame API endpoint: its URL, HTTP method, and optional query parameters.

FrameObjects

object FrameObjects

Common Frame API domain objects shared across multiple SDK modules.

FrameResult

sealed class FrameResult

Outcome of a Frame UI flow (checkout, cart, onboarding).

NetworkingConstants

class NetworkingConstants

Base URL constants used by FrameNetworking when constructing API requests.

NetworkingError

sealed class NetworkingError : Exception

Errors that the Frame SDK network layer can surface to callers.

QueryItem

data class QueryItem(val name: String, val value: String?)

A single URL query-string parameter.

URLSessionProtocol

interface URLSessionProtocol

HTTP execution abstraction used by all Frame SDK API clients.