masterplan-optimizer-frontend / eventsApi

Variable: eventsApi¶

const eventsApi: object

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

Client wrapper for event records and event-scoped capability settings.

Type Declaration¶

create¶

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

Create a new event.

Parameters¶

data¶

Partial\<Event>

Returns¶

Promise\<Event>

delete¶

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

Delete an event and its scoped data.

Parameters¶

id¶

number

Returns¶

Promise\<void>

getAll¶

getAll: () => Promise\<Event[]>

Fetch all events known to the local backend.

Returns¶

Promise\<Event[]>

getById¶

getById: (id) => Promise\<Event>

Fetch one event by id.

Parameters¶

id¶

number

Returns¶

Promise\<Event>

getPdfExportSettings¶

getPdfExportSettings: (eventId) => Promise\<{ customised: boolean; title: string; }>

Read the event-specific title used for local PDF schedule exports.

Parameters¶

eventId¶

number

Returns¶

Promise\<{ customised: boolean; title: string; }>

setPdfExportSettings¶

setPdfExportSettings: (eventId, title) => Promise\<{ customised: boolean; title: string; }>

Save the event-specific PDF title without replacing other event metadata.

Parameters¶

eventId¶

number

title¶

string

Returns¶

Promise\<{ customised: boolean; title: string; }>

update¶

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

Replace core fields for an existing event.

Parameters¶

id¶

number

data¶

Partial\<Event>

Returns¶

Promise\<Event>

updateCapabilities¶

updateCapabilities: (eventId, enabledCapabilityIds) => Promise\<void>

Update the set of capabilities enabled for one event.

Parameters¶

eventId¶

number

enabledCapabilityIds¶

number[] | null

Returns¶

Promise\<void>