masterplan-optimizer-frontend / groupsApi

Variable: groupsApi¶

const groupsApi: object

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

Client wrapper for event-scoped groups and memberships.

Type Declaration¶

create¶

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

Create a group for an event.

Parameters¶

eventId¶

number

data¶

attributes?¶

Record\<string, string>

group_type_id?¶

number

members?¶

GroupMember[]

name¶

string

Returns¶

Promise\<Group>

delete¶

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

Delete a group from an event.

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

getAll¶

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

Fetch all groups for an event.

Parameters¶

eventId¶

number

Returns¶

Promise\<Group[]>

getById¶

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

Fetch one group by id within an event.

Parameters¶

id¶

number

eventId¶

number

Returns¶

Promise\<Group>

update¶

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

Update a group for an event.

Parameters¶

eventId¶

number

id¶

number

data¶

attributes?¶

Record\<string, string>

group_type_id?¶

number

members?¶

GroupMember[]

name?¶

string

Returns¶

Promise\<Group>