Client

interface Client

Interface representing a client that can perform various operations related to users and plans.

Functions

Link copied to clipboard
abstract suspend fun cancelPlan(planId: UUID): Plan

Cancels a plan based on the provided plan ID.

Link copied to clipboard
abstract suspend fun close()

Closes the client and releases any resources held by it.

Link copied to clipboard
abstract suspend fun createUser(request: CreateUserRequest): User

Creates a new user based on the provided request.

Link copied to clipboard
abstract suspend fun getPlan(planId: UUID): GetPlanResponse

Retrieves the details of a plan based on the provided plan ID.

Link copied to clipboard
abstract suspend fun getSummary(planId: UUID): GetSummaryResponse

Retrieves a summary of the plan based on the provided plan ID.

Link copied to clipboard
abstract suspend fun getUser(username: String): User

Get user by username

Link copied to clipboard
abstract suspend fun listPlans(userId: UUID, page: Long): ListPlansResponse

List plans submitted by a user

Link copied to clipboard
abstract suspend fun submitPlan(request: SubmitPlanRequest): Plan

Submits a new plan based on the provided request.

Link copied to clipboard
abstract suspend fun updatePlan(request: UpdatePlanRequest): Plan

Updates an existing plan based on the provided request.