FrameSDK/com.framepayments.framesdk.products/ProductEndpoints

ProductEndpoints

sealed class ProductEndpoints : FrameNetworkingEndpoints

Defines the API endpoints available for product operations.

Each case maps to a specific URL, HTTP method, and optional query parameters used by the networking layer to build requests.

Inheritors

Types

object CreateProduct : ProductEndpoints

Endpoint for creating a new product (POST /v1/products).

data class DeleteProduct(val productId: String) : ProductEndpoints

Endpoint for deleting a product (DELETE /v1/products/{productId}).

data class GetProducts(val perPage: Int? = null, val page: Int? = null) : ProductEndpoints

Endpoint for retrieving a paginated list of products (GET /v1/products).

data class GetProductWith(val productId: String) : ProductEndpoints

Endpoint for retrieving a single product by identifier (GET /v1/products/{productId}).

data class SearchProducts(val name: String? = null, val active: Boolean? = null, val shippable: Boolean? = null) : ProductEndpoints

Endpoint for searching products by filter criteria (GET /v1/products/search).

data class UpdateProduct(val productId: String) : ProductEndpoints

Endpoint for updating an existing product (PATCH /v1/products/{productId}).

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 fully qualified URL string for this endpoint.

open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.