masterplan-optimizer-frontend / locationsApi

Variable: locationsApi¶

const locationsApi: object

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

Client wrapper for event-scoped locations.

Type Declaration¶

create¶

create: (eventId, data) => Promise\<Location>

Create a location for an event.

Parameters¶

eventId¶

number

data¶

address?¶

string

details?¶

Record\<string, any>

name¶

string

Returns¶

Promise\<Location>

delete¶

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

Delete a location from an event.

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

getAll¶

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

Fetch all locations for an event.

Parameters¶

eventId¶

number

Returns¶

Promise\<Location[]>

getById¶

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

Fetch one location by id within an event.

Parameters¶

id¶

number

eventId¶

number

Returns¶

Promise\<Location>

update¶

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

Update a location for an event.

Parameters¶

eventId¶

number

id¶

number

data¶

address?¶

string

details?¶

Record\<string, any>

name?¶

string

Returns¶

Promise\<Location>