Skip to content

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 ​

ts
new EventService(): EventService;

Returns ​

EventService

Methods ​

asBaseEventAnswerResponse() ​

ts
static asBaseEventAnswerResponse(entity): BaseEventAnswerResponse;

Parameters ​

ParameterType
entityEventShiftAnswer

Returns ​

BaseEventAnswerResponse


asBaseEventResponse() ​

ts
static asBaseEventResponse(entity): BaseEventResponse;

Parameters ​

ParameterType
entityEvent

Returns ​

BaseEventResponse


asBaseEventShiftResponse() ​

ts
static asBaseEventShiftResponse(entity): BaseEventShiftResponse;

Parameters ​

ParameterType
entityEventShift

Returns ​

BaseEventShiftResponse


asEventResponse() ​

ts
static asEventResponse(entity): EventResponse;

Parameters ​

ParameterType
entityEvent

Returns ​

EventResponse


asEventShiftResponse() ​

ts
static asEventShiftResponse(entity): EventShiftResponse;

Parameters ​

ParameterType
entityEventShift

Returns ​

EventShiftResponse


asShiftInEventResponse() ​

ts
static asShiftInEventResponse(
   event, 
   shift, 
   answers): EventInShiftResponse;

Parameters ​

ParameterType
eventEvent
shiftEventShift
answersEventShiftAnswer[]

Returns ​

EventInShiftResponse


createEvent() ​

ts
static createEvent(params): Promise<Event>;

Create a new event.

Parameters ​

ParameterType
paramsCreateEventParams

Returns ​

Promise<Event>


createEventShift() ​

ts
static createEventShift(eventShiftRequest): Promise<EventShiftResponse>;

Create borrel schema shift.

Parameters ​

ParameterType
eventShiftRequestEventShiftRequest

Returns ​

Promise<EventShiftResponse>


deleteEvent() ​

ts
static deleteEvent(id): Promise<void>;

Delete borrel schema.

Parameters ​

ParameterType
idnumber

Returns ​

Promise<void>


deleteEventShift() ​

ts
static deleteEventShift(id): Promise<void>;

Delete an event shift. Soft remove it if it has at least one corresponding answer

Parameters ​

ParameterType
idnumber

Returns ​

Promise<void>


getEvents() ​

ts
static getEvents(params?, __namedParameters?): Promise<[Event[], number]>;

Get all borrel schemas.

Parameters ​

ParameterType
paramsEventFilterParameters
__namedParametersPaginationParameters

Returns ​

Promise<[Event[], number]>


getEventShifts() ​

ts
static getEventShifts(__namedParameters): Promise<[EventShift[], number]>;

Get all event shifts

Parameters ​

ParameterType
__namedParametersPaginationParameters

Returns ​

Promise<[EventShift[], number]>


getShiftSelectedCount() ​

ts
static getShiftSelectedCount(shiftId, eventType?): Promise<EventPlanningSelectedCount[]>;

Get amount of times a user was selected for the given shift in the given time interval

Parameters ​

ParameterTypeDescription
shiftIdnumber-
eventTypeShiftSelectedCountParams-

Returns ​

Promise<EventPlanningSelectedCount[]>


getSingleEvent() ​

ts
static getSingleEvent(id): Promise<Event>;

Get a single event with its corresponding shifts and answers

Parameters ​

ParameterTypeDescription
idnumber-

Returns ​

Promise<Event>


sendEventPlanningReminders() ​

ts
static sendEventPlanningReminders(date?): Promise<void>;

Send a reminder

Parameters ​

ParameterTypeDescription
dateDate-

Returns ​

Promise<void>


syncAllEventShiftAnswers() ​

ts
static syncAllEventShiftAnswers(): Promise<void>;

Synchronize all answer sheets with the corresponding users and shifts

Returns ​

Promise<void>


syncEventShiftAnswers() ​

ts
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 ​

ParameterTypeDescription
eventEvent-
shiftIds?number[]-

Returns ​

Promise<EventShiftAnswer[]>


updateEvent() ​

ts
static updateEvent(id, params): Promise<Event>;

Update an existing event.

Parameters ​

ParameterType
idnumber
paramsPartial<UpdateEventParams>

Returns ​

Promise<Event>


updateEventShift() ​

ts
static updateEventShift(id, update): Promise<EventShiftResponse>;

Update borrel schema shift.

Parameters ​

ParameterType
idnumber
updatePartial<EventShiftRequest>

Returns ​

Promise<EventShiftResponse>


updateEventShiftAnswer() ​

ts
static updateEventShiftAnswer(
   eventId, 
   shiftId, 
   userId, 
update): Promise<BaseEventAnswerResponse>;

Update borrel schema answer

Parameters ​

ParameterType
eventIdnumber
shiftIdnumber
userIdnumber
updatePartial<UpdateEventAnswerParams>

Returns ​

Promise<BaseEventAnswerResponse>