CustomerEndpoints

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.

Types

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

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

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

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

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

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

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.

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

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

open override val endpointURL: String

Returns the relative URL path for this endpoint.

open override val httpMethod: String

Returns the HTTP method string for this endpoint.

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