FrameSDK/com.framepayments.framesdk.customers/CustomerEndpoints

CustomerEndpoints

sealed class CustomerEndpoints : FrameNetworkingEndpoints

Defines all HTTP endpoints used by the customers API.

Each case maps to a distinct API route and HTTP method. Construct the appropriate case and pass it to com.framepayments.framesdk.FrameNetworking to execute the request.

Inheritors

Types

BlockCustomerWith

data class BlockCustomerWith(val customerId: String) : CustomerEndpoints

Endpoint for blocking a customer via POST /v1/customers/{customerId}/block.

CreateCustomer

object CreateCustomer : CustomerEndpoints

Endpoint for creating a new customer via POST /v1/customers.

DeleteCustomer

data class DeleteCustomer(val customerId: String) : CustomerEndpoints

Endpoint for deleting a customer via DELETE /v1/customers/{customerId}.

GetCustomers

data class GetCustomers(val perPage: Int? = null, val page: Int? = null) : CustomerEndpoints

Endpoint for retrieving a paginated list of customers via GET /v1/customers.

GetCustomerWith

data class GetCustomerWith(val customerId: String) : CustomerEndpoints

Endpoint for fetching a single customer by ID via GET /v1/customers/{customerId}.

SearchCustomers

data class SearchCustomers(val q: String? = null, val email: String? = null, val createdAfter: Int? = null, val page: Int? = null, val perPage: Int? = null) : CustomerEndpoints

Endpoint for searching customers via GET /v1/customers/search.

UnblockCustomerWith

data class UnblockCustomerWith(val customerId: String) : CustomerEndpoints

Endpoint for unblocking a customer via POST /v1/customers/{customerId}/unblock.

UpdateCustomer

data class UpdateCustomer(val customerId: String) : CustomerEndpoints

Endpoint for updating an existing customer via PATCH /v1/customers/{customerId}.

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.

endpointURL

open override val endpointURL: String

Returns the relative URL path for this endpoint.

httpMethod

open override val httpMethod: String

Returns the HTTP method string for this endpoint.

queryItems

open override val queryItems: List<QueryItem>?

Returns the URL query parameters for this endpoint, or null if none apply.