FrameSDK/com.framepayments.framesdk.productphases/ProductPhaseEndpoints

ProductPhaseEndpoints

sealed class ProductPhaseEndpoints : FrameNetworkingEndpoints

Defines the API endpoints available for product phase operations.

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

Inheritors

Types

Link copied to clipboard
data class BulkUpdateProductPhases(val productId: String) : ProductPhaseEndpoints

Endpoint for replacing all phases on a product in a single request (PATCH /v1/products/{productId}/phases/bulk_update).

Link copied to clipboard
data class CreateProductPhase(val productId: String) : ProductPhaseEndpoints

Endpoint for creating a new phase on a product (POST /v1/products/{productId}/phases).

Link copied to clipboard
data class DeleteProductPhase(val productId: String, val phaseId: String) : ProductPhaseEndpoints

Endpoint for deleting a specific phase from a product (DELETE /v1/products/{productId}/phases/{phaseId}).

Link copied to clipboard
data class GetProductPhases(val productId: String) : ProductPhaseEndpoints

Endpoint for retrieving all phases of a product (GET /v1/products/{productId}/phases).

Link copied to clipboard
data class GetProductPhaseWith(val productId: String, val phaseId: String) : ProductPhaseEndpoints

Endpoint for retrieving a specific phase by identifier (GET /v1/products/{productId}/phases/{phaseId}).

Link copied to clipboard
data class UpdateProductPhase(val productId: String, val phaseId: String) : ProductPhaseEndpoints

Endpoint for updating a specific phase on a product (PATCH /v1/products/{productId}/phases/{phaseId}).

Properties

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
open override val httpMethod: String

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

Link copied to clipboard
open override val queryItems: List<QueryItem>? = null

Optional query-string parameters appended to endpointURL.