CalendarApi API

The calendarApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
completeEvent
completeEvents
completeTriggered
createEvent
deleteEvent
getEvent
getIndex
getRange
getStatus
getTriggered
getUpcoming
listEvents
rsvp
updateEvent

Methods

---

completeEvent

plugin.calendarApi.completeEvent(id: string, data?: CompleteEventRequest): Promise<void>

Parameter	Type	Required	Description
id	string	Yes
data	CompleteEventRequest	No

Returns: Promise<void>

Full reference →

---

completeEvents

plugin.calendarApi.completeEvents(data: BulkCompleteEventsRequest): Promise<void>

Parameter	Type	Required	Description
data	BulkCompleteEventsRequest	Yes

Returns: Promise<void>

Full reference →

---

completeTriggered

plugin.calendarApi.completeTriggered(data: CompleteTriggeredRequest): Promise<void>

Parameter	Type	Required	Description
data	CompleteTriggeredRequest	Yes

Returns: Promise<void>

Full reference →

---

createEvent

plugin.calendarApi.createEvent(data: CreateCalendarEventRequest): Promise<CalendarEvent>

Parameter	Type	Required	Description
data	CreateCalendarEventRequest	Yes

Returns: Promise<CalendarEvent>

Full reference →

---

deleteEvent

plugin.calendarApi.deleteEvent(id: string): Promise<void>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<void>

Full reference →

---

getEvent

plugin.calendarApi.getEvent(id: string): Promise<CalendarEvent>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<CalendarEvent>

Full reference →

---

getIndex

plugin.calendarApi.getIndex(params?: CalendarFilterOptions): Promise<CalendarIndexEntry[]>

Parameter	Type	Required	Description
params	CalendarFilterOptions	No

Returns: Promise<CalendarIndexEntry[]>

Full reference →

---

getRange

plugin.calendarApi.getRange(params?: CalendarFilterOptions): Promise<CalendarEvent[]>

Parameter	Type	Required	Description
params	CalendarFilterOptions	No

Returns: Promise<CalendarEvent[]>

Full reference →

---

getStatus

plugin.calendarApi.getStatus(): Promise<CalendarStatus>

No parameters.

Returns: Promise<CalendarStatus>

Full reference →

---

getTriggered

plugin.calendarApi.getTriggered(params?: CalendarFilterOptions): Promise<CalendarEvent[]>

Parameter	Type	Required	Description
params	CalendarFilterOptions	No

Returns: Promise<CalendarEvent[]>

Full reference →

---

getUpcoming

plugin.calendarApi.getUpcoming(params?: CalendarFilterOptions): Promise<CalendarEvent[]>

Parameter	Type	Required	Description
params	CalendarFilterOptions	No

Returns: Promise<CalendarEvent[]>

Full reference →

---

listEvents

plugin.calendarApi.listEvents(params?: CalendarFilterOptions): Promise<CalendarEventSummary[]>

Parameter	Type	Required	Description
params	CalendarFilterOptions	No

Returns: Promise<CalendarEventSummary[]>

Full reference →

---

rsvp

plugin.calendarApi.rsvp(id: string, data: CalendarRSVPRequest): Promise<void>

Parameter	Type	Required	Description
id	string	Yes
data	CalendarRSVPRequest	Yes

Returns: Promise<void>

Full reference →

---

updateEvent

plugin.calendarApi.updateEvent(id: string, data: UpdateCalendarEventRequest): Promise<CalendarEvent>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateCalendarEventRequest	Yes

Returns: Promise<CalendarEvent>

Full reference →