FrameSDK/com.framepayments.framesdk.capabilities/CapabilityEndpoints

CapabilityEndpoints

sealed class CapabilityEndpoints : FrameNetworkingEndpoints

Defines all network endpoints for the capabilities API.

Each case maps to a specific HTTP method and URL path under /v1/accounts/{accountId}/capabilities.

Inheritors

GetCapabilities

RequestCapabilities

GetCapabilityWith

DisableCapabilityWith

Types

DisableCapabilityWith

data class DisableCapabilityWith(val accountId: String, val name: String) : CapabilityEndpoints

Disables a single capability by name for the given account (DELETE).

GetCapabilities

data class GetCapabilities(val accountId: String) : CapabilityEndpoints

Retrieves all capabilities for the given account (GET).

GetCapabilityWith

data class GetCapabilityWith(val accountId: String, val name: String) : CapabilityEndpoints

Retrieves a single capability by name for the given account (GET).

RequestCapabilities

data class RequestCapabilities(val accountId: String) : CapabilityEndpoints

Requests one or more capabilities for the given account (POST).

Properties

additionalHeaders

open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

open override val endpointURL: String

The relative URL path for this endpoint.

open override val httpMethod: String

The HTTP method for this endpoint (GET, POST, or DELETE).

open override val queryItems: List<QueryItem>? = null

Query parameters for this endpoint; always null for capability endpoints.