FrameSDK/com.framepayments.framesdk.capabilities/CapabilitiesAPI

CapabilitiesAPI

object CapabilitiesAPI

Provides coroutine-based and callback-based methods for managing account capabilities.

All methods require a non-empty accountId; calls with an empty ID return (null, null) without making a network request.

Functions

Link copied to clipboard
suspend fun disableCapabilityWith(accountId: String, name: String): Pair<CapabilityObjects.Capability?, NetworkingError?>

Disables a single capability by name for the given account.

fun disableCapabilityWith(accountId: String, name: String, completionHandler: (CapabilityObjects.Capability?, NetworkingError?) -> Unit)

Disables a single capability by name for the given account and delivers the result via a callback.

Link copied to clipboard
suspend fun getCapabilities(accountId: String): Pair<CapabilityResponses.ListCapabilitiesResponse?, NetworkingError?>

Fetches all capabilities for the given account.

fun getCapabilities(accountId: String, completionHandler: (CapabilityResponses.ListCapabilitiesResponse?, NetworkingError?) -> Unit)

Fetches all capabilities for the given account and delivers the result via a callback.

Link copied to clipboard
suspend fun getCapabilityWith(accountId: String, name: String): Pair<CapabilityObjects.Capability?, NetworkingError?>

Fetches a single capability by name for the given account.

fun getCapabilityWith(accountId: String, name: String, completionHandler: (CapabilityObjects.Capability?, NetworkingError?) -> Unit)

Fetches a single capability by name for the given account and delivers the result via a callback.

Link copied to clipboard
suspend fun requestCapabilities(accountId: String, request: CapabilityRequests.RequestCapabilitiesRequest): Pair<List<CapabilityObjects.Capability>?, NetworkingError?>

Requests one or more capabilities for the given account.

fun requestCapabilities(accountId: String, request: CapabilityRequests.RequestCapabilitiesRequest, completionHandler: (List<CapabilityObjects.Capability>?, NetworkingError?) -> Unit)

Requests one or more capabilities for the given account and delivers the result via a callback.