projectal.entities.calendar

 1import copy
 2
 3from projectal.errors import UnsupportedException
 4
 5from projectal.entity import Entity
 6
 7
 8class CalendarItem(Entity):
 9    """
10    This object represents entries within a calendar, like holidays or leaves.
11    They are referred to as "Calendar Exceptions" in the web client.
12    """
13
14    _path = "calendar"
15    _name = "calendar"
16
17
18class Calendar(Entity):
19    """
20    Implementation of the [Calendar](https://projectal.com/docs/latest/#tag/Calendar) API.
21
22    The Calendar object acts as a "container" of calendar items based on type. Types of
23    calendars are distinguished by name ("base_calendar", "location", "staff") and
24    may contain a set of calendar items either for itself ("location", "staff") or
25    for its holder ("base_calendar").
26    """
27
28    _path = "calendar"
29    _name = "calendar"
30
31    def __init__(self, data):
32        super(Calendar, self).__init__(data)
33
34        # Override the inner "calendarList" with the expected type (they are CalendarItems
35        # within the Calendar). We have to do this because the built-in conversion assumes
36        # they are Calendars because of the name of the list.
37        if self.get("calendarList"):
38            cals_as_obj = []
39            for cal in self.get("calendarList", []):
40                cals_as_obj.append(CalendarItem(cal))
41            self["calendarList"] = cals_as_obj
42
43    @classmethod
44    def create(cls, holder, entity):
45        """Create a Calendar
46
47        `holder`: `uuId` of the owner
48
49        `entity`: The fields of the entity to be created
50        """
51        holder_id = holder["uuId"] if isinstance(holder, dict) else holder
52        params = "?holder=" + holder_id
53        out = super().create(entity, params)
54        # Calendars use "empty linkers" during creation which don't go through our
55        # usual linker pipeline where the internal list is updated. Do it here
56        # manually.
57        if isinstance(holder, Entity):
58            cl = holder.get("calendarList", [])
59            cl.append(out)
60            holder.set_readonly("calendarList", copy.deepcopy(cl))
61        return out
62
63    @classmethod
64    def list(cls, expand=False, links=None):
65        raise UnsupportedException("Calendar list is not supported by the API.")