masterplan-optimizer-frontend / generalScheduleApi

Variable: generalScheduleApi¶

const generalScheduleApi: object

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

Type Declaration¶

bulkCreateElements¶

bulkCreateElements: (eventId, items) => Promise\<SessionElement[]>

Create a collection of schedule items in one validated transaction.

Parameters¶

eventId¶

number

items¶

Omit\<Partial\<SessionElement>, "id" | "event_id"> & object[]

Returns¶

Promise\<SessionElement[]>

bulkUpdateElements¶

bulkUpdateElements: (eventId, elementIds, changes) => Promise\<SessionElement[]>

Replace Public Schedule views or audiences on a selected element set.

Parameters¶

eventId¶

number

elementIds¶

number[]

changes¶

BulkSessionElementChanges

Returns¶

Promise\<SessionElement[]>

copyElements¶

copyElements: (eventId, elementIds, targetDates) => Promise\<SessionElement[]>

Parameters¶

eventId¶

number

elementIds¶

number[]

targetDates¶

string[]

Returns¶

Promise\<SessionElement[]>

createCategory¶

createCategory: (eventId, data) => Promise\<AudienceCategory>

Parameters¶

eventId¶

number

data¶

Partial\<AudienceCategory> & object

Returns¶

Promise\<AudienceCategory>

createElement¶

createElement: (eventId, data) => Promise\<SessionElement>

Parameters¶

eventId¶

number

data¶

Omit\<Partial\<SessionElement>, "id" | "event_id"> & object

Returns¶

Promise\<SessionElement>

createScheduleView¶

createScheduleView: (eventId, data) => Promise\<ScheduleView>

Parameters¶

eventId¶

number

data¶

Partial\<ScheduleView> & object

Returns¶

Promise\<ScheduleView>

createSessionElementType¶

createSessionElementType: (eventId, data) => Promise\<SessionElementType>

Parameters¶

eventId¶

number

data¶

Partial\<SessionElementType> & object

Returns¶

Promise\<SessionElementType>

createTeam¶

createTeam: (eventId, data) => Promise\<AudienceTeam>

Parameters¶

eventId¶

number

data¶

Partial\<AudienceTeam> & object

Returns¶

Promise\<AudienceTeam>

deleteCategory¶

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

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

deleteElement¶

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

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

deleteScheduleView¶

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

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

deleteSessionElementType¶

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

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

deleteTeam¶

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

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<void>

duplicateElement¶

duplicateElement: (eventId, id) => Promise\<SessionElement>

Parameters¶

eventId¶

number

id¶

number

Returns¶

Promise\<SessionElement>

getCategories¶

getCategories: (eventId) => Promise\<AudienceCategory[]>

Parameters¶

eventId¶

number

Returns¶

Promise\<AudienceCategory[]>

getElements¶

getElements: (eventId) => Promise\<SessionElement[]>

Parameters¶

eventId¶

number

Returns¶

Promise\<SessionElement[]>

getPublishState¶

getPublishState: (eventId) => Promise\<GeneralSchedulePublishState>

Parameters¶

eventId¶

number

Returns¶

Promise\<GeneralSchedulePublishState>

getScheduleViews¶

getScheduleViews: (eventId) => Promise\<ScheduleView[]>

Parameters¶

eventId¶

number

Returns¶

Promise\<ScheduleView[]>

getSessionElementTypes¶

getSessionElementTypes: (eventId) => Promise\<SessionElementType[]>

Parameters¶

eventId¶

number

Returns¶

Promise\<SessionElementType[]>

getTeams¶

getTeams: (eventId) => Promise\<AudienceTeam[]>

Parameters¶

eventId¶

number

Returns¶

Promise\<AudienceTeam[]>

reorderTeams¶

reorderTeams: (eventId, items) => Promise\<void>

Parameters¶

eventId¶

number

items¶

object[]

Returns¶

Promise\<void>

updateCategory¶

updateCategory: (eventId, id, data) => Promise\<AudienceCategory>

Parameters¶

eventId¶

number

id¶

number

data¶

Partial\<AudienceCategory>

Returns¶

Promise\<AudienceCategory>

updateElement¶

updateElement: (eventId, id, data) => Promise\<SessionElement>

Parameters¶

eventId¶

number

id¶

number

data¶

Partial\<SessionElement>

Returns¶

Promise\<SessionElement>

updateScheduleView¶

updateScheduleView: (eventId, id, data) => Promise\<ScheduleView>

Parameters¶

eventId¶

number

id¶

number

data¶

Partial\<ScheduleView>

Returns¶

Promise\<ScheduleView>

updateSessionElementType¶

updateSessionElementType: (eventId, id, data) => Promise\<SessionElementType>

Parameters¶

eventId¶

number

id¶

number

data¶

Partial\<SessionElementType>

Returns¶

Promise\<SessionElementType>

updateTeam¶

updateTeam: (eventId, id, data) => Promise\<AudienceTeam>

Parameters¶

eventId¶

number

id¶

number

data¶

Partial\<AudienceTeam>

Returns¶

Promise\<AudienceTeam>