SudoSOS Back-end API / events / EventService
Class: EventService ​
Wrapper for all Borrel-schema related logic.
Deprecated ​
Events are out of scope for SudoSOS. Delete from 01/11/2026.
Constructors ​
Constructor ​
new EventService(): EventService;Returns ​
EventService
Methods ​
asBaseEventAnswerResponse() ​
static asBaseEventAnswerResponse(entity): BaseEventAnswerResponse;Parameters ​
| Parameter | Type |
|---|---|
entity | EventShiftAnswer |
Returns ​
asBaseEventResponse() ​
static asBaseEventResponse(entity): BaseEventResponse;Parameters ​
| Parameter | Type |
|---|---|
entity | Event |
Returns ​
asBaseEventShiftResponse() ​
static asBaseEventShiftResponse(entity): BaseEventShiftResponse;Parameters ​
| Parameter | Type |
|---|---|
entity | EventShift |
Returns ​
asEventResponse() ​
static asEventResponse(entity): EventResponse;Parameters ​
| Parameter | Type |
|---|---|
entity | Event |
Returns ​
asEventShiftResponse() ​
static asEventShiftResponse(entity): EventShiftResponse;Parameters ​
| Parameter | Type |
|---|---|
entity | EventShift |
Returns ​
asShiftInEventResponse() ​
static asShiftInEventResponse(
event,
shift,
answers): EventInShiftResponse;Parameters ​
| Parameter | Type |
|---|---|
event | Event |
shift | EventShift |
answers | EventShiftAnswer[] |
Returns ​
createEvent() ​
static createEvent(params): Promise<Event>;Create a new event.
Parameters ​
| Parameter | Type |
|---|---|
params | CreateEventParams |
Returns ​
Promise<Event>
createEventShift() ​
static createEventShift(eventShiftRequest): Promise<EventShiftResponse>;Create borrel schema shift.
Parameters ​
| Parameter | Type |
|---|---|
eventShiftRequest | EventShiftRequest |
Returns ​
Promise<EventShiftResponse>
deleteEvent() ​
static deleteEvent(id): Promise<void>;Delete borrel schema.
Parameters ​
| Parameter | Type |
|---|---|
id | number |
Returns ​
Promise<void>
deleteEventShift() ​
static deleteEventShift(id): Promise<void>;Delete an event shift. Soft remove it if it has at least one corresponding answer
Parameters ​
| Parameter | Type |
|---|---|
id | number |
Returns ​
Promise<void>
getEvents() ​
static getEvents(params?, __namedParameters?): Promise<[Event[], number]>;Get all borrel schemas.
Parameters ​
| Parameter | Type |
|---|---|
params | EventFilterParameters |
__namedParameters | PaginationParameters |
Returns ​
Promise<[Event[], number]>
getEventShifts() ​
static getEventShifts(__namedParameters): Promise<[EventShift[], number]>;Get all event shifts
Parameters ​
| Parameter | Type |
|---|---|
__namedParameters | PaginationParameters |
Returns ​
Promise<[EventShift[], number]>
getShiftSelectedCount() ​
static getShiftSelectedCount(shiftId, eventType?): Promise<EventPlanningSelectedCount[]>;Get amount of times a user was selected for the given shift in the given time interval
Parameters ​
| Parameter | Type | Description |
|---|---|---|
shiftId | number | - |
eventType | ShiftSelectedCountParams | - |
Returns ​
Promise<EventPlanningSelectedCount[]>
getSingleEvent() ​
static getSingleEvent(id): Promise<Event>;Get a single event with its corresponding shifts and answers
Parameters ​
| Parameter | Type | Description |
|---|---|---|
id | number | - |
Returns ​
Promise<Event>
sendEventPlanningReminders() ​
static sendEventPlanningReminders(date?): Promise<void>;Send a reminder
Parameters ​
| Parameter | Type | Description |
|---|---|---|
date | Date | - |
Returns ​
Promise<void>
syncAllEventShiftAnswers() ​
static syncAllEventShiftAnswers(): Promise<void>;Synchronize all answer sheets with the corresponding users and shifts
Returns ​
Promise<void>
syncEventShiftAnswers() ​
static syncEventShiftAnswers(event, shiftIds?): Promise<EventShiftAnswer[]>;Create and/or remove answer sheets given an event and a list of shifts that should belong to this event. If a shift is changed or a user loses a role that belongs to a shift, their answer sheet is removed from the database.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
event | Event | - |
shiftIds? | number[] | - |
Returns ​
Promise<EventShiftAnswer[]>
updateEvent() ​
static updateEvent(id, params): Promise<Event>;Update an existing event.
Parameters ​
| Parameter | Type |
|---|---|
id | number |
params | Partial<UpdateEventParams> |
Returns ​
Promise<Event>
updateEventShift() ​
static updateEventShift(id, update): Promise<EventShiftResponse>;Update borrel schema shift.
Parameters ​
| Parameter | Type |
|---|---|
id | number |
update | Partial<EventShiftRequest> |
Returns ​
Promise<EventShiftResponse>
updateEventShiftAnswer() ​
static updateEventShiftAnswer(
eventId,
shiftId,
userId,
update): Promise<BaseEventAnswerResponse>;Update borrel schema answer
Parameters ​
| Parameter | Type |
|---|---|
eventId | number |
shiftId | number |
userId | number |
update | Partial<UpdateEventAnswerParams> |
Returns ​
Promise<BaseEventAnswerResponse>