masterplan-optimizer-frontend / tasksApi

Variable: tasksApi¶

const tasksApi: object

Defined in: src/lib/api.ts:352

Client wrapper for legacy task records and finalisation actions.

Type Declaration¶

create¶

create: (data) => Promise\<Task>

Create one legacy task record.

Parameters¶

data¶

TaskCreatePayload

Returns¶

Promise\<Task>

delete¶

delete: (id, eventId) => Promise\<void>

Delete one legacy task record.

Parameters¶

id¶

number

eventId¶

number

Returns¶

Promise\<void>

finalize¶

finalize: (data) => Promise\<FinalizeResponse>

Finalise the current schedule for an event.

Parameters¶

data¶

FinalizeRequest

Returns¶

Promise\<FinalizeResponse>

getAll¶

getAll: (eventId) => Promise\<Task[]>

Fetch legacy task records for an event.

Parameters¶

eventId¶

number

Returns¶

Promise\<Task[]>

getById¶

getById: (id, eventId) => Promise\<Task>

Fetch one task by id within an event.

Parameters¶

id¶

number

eventId¶

number

Returns¶

Promise\<Task>

swapPerson¶

swapPerson: (taskId, eventId, data) => Promise\<{ message: string; status: string; }>

Replace a person assignment on a legacy task.

Parameters¶

taskId¶

number

eventId¶

number

data¶

PersonSwapRequest

Returns¶

Promise\<{ message: string; status: string; }>

update¶

update: (id, eventId, data) => Promise\<Task>

Update one legacy task record.

Parameters¶

id¶

number

eventId¶

number

data¶

TaskUpdatePayload

Returns¶

Promise\<Task>