Skip to content

Reference

phil/reservation
TypeRole
IntervalA span of time, its end excluded, read to the second; from and until are its Unix timestamps
BookingA booking that holds units of a resource for a span
BookingRequestA booking asked for: span, moment asked, units, booking replaced
BookableA resource: capacity, buffers, availability, rules, time zone; checks, units free, slots
DecisionThe answer to a request: its violations and the bookings it meets
ViolationA reason a request is refused, with its parameters
ViolationCodeThe reasons, with stable string values
LoadProfileThe units held at each moment, and the peak of a span
ReminderScheduleThe offsets of a booking's reminders, their moments and the one due
Contract\AvailabilityThe port of the open spans of a resource
Contract\RuleThe port of a rule a request follows
Availability\AlwaysAvailableOpen at every moment
Availability\WeeklyAvailabilityOpen by weekday on a clock, with days closed
Rule\MinimumNoticeA notice before the start
Rule\MaximumAdvanceA booking window that slides
Rule\DurationLimitsA shortest and a longest length
Rule\SlotGridStarts and lengths on a grid of minutes
Exception\ReservationExceptionThe marker of every exception of the library
Exception\InvalidIntervalA span that cannot be, or one longer than the library reads
Exception\InvalidDefinitionA resource, rule, booking or schedule defined with a value it cannot take