contextbase-plugin-microsoft-calendar 0.5.0__py3-none-any.whl

plugin_microsoft_calendar/models/ctx.py

@@ -0,0 +1,515 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import AwareDatetime, Field
+from shared_plugins.models import CtxModel, IdStr, NonNegativeInt
+
+
+class CalendarRow(CtxModel):
+    ctx_deleted: bool = Field(default=False, alias="_ctx_deleted")
+    id: IdStr
+    odata_type: str | None = None
+    additional_data: dict[str, Any] = Field(default_factory=dict)
+    allowed_online_meeting_providers: list[str] = Field(default_factory=list)
+    calendar_group_id: str | None = None
+    can_edit: bool | None = None
+    can_share: bool | None = None
+    can_view_private_items: bool | None = None
+    change_key: str | None = None
+    color: str | None = None
+    default_online_meeting_provider: str | None = None
+    group_class_id: str | None = None
+    hex_color: str | None = None
+    is_default_calendar: bool | None = None
+    is_removable: bool | None = None
+    is_shared: bool | None = None
+    is_shared_with_me: bool | None = None
+    is_tallying_responses: bool | None = None
+    name: str | None = None
+    owner_name: str | None = None
+    owner_address: str | None = None
+
+
+class EventRow(CtxModel):
+    """Row in the `events` table.
+
+    One row per calendarView/delta item, all four Graph event types:
+    full-fidelity `singleInstance`/`seriesMaster`/`exception` rows, and
+    `occurrence` rows that are sparse by design (their payload lives on the
+    series master — only the merge keys, `type`, `series_master_id`,
+    `etag`, and the concrete start/end slot are populated).
+
+    `calendar_id` is pinned from the calendar whose delta produced the row
+    (event payloads carry no calendar field); tombstones
+    (`ctx_deleted=True`) carry only the merge keys.
+    """
+
+    ctx_deleted: bool = Field(default=False, alias="_ctx_deleted")
+    calendar_id: IdStr
+    id: IdStr
+    type: str | None = None
+    odata_type: str | None = None
+    etag: str | None = None
+    additional_data: dict[str, Any] = Field(default_factory=dict)
+    series_master_id: str | None = None
+    occurrence_id: str | None = None
+    subject: str | None = None
+    body: dict[str, Any] | None = None
+    body_preview: str | None = None
+    categories: list[str] = Field(default_factory=list)
+    attendees: list[dict[str, Any]] = Field(default_factory=list)
+    organizer_name: str | None = None
+    organizer_address: str | None = None
+    location: dict[str, Any] | None = None
+    locations: list[dict[str, Any]] = Field(default_factory=list)
+    start_date_time: AwareDatetime | None = None
+    start_time_zone: str | None = None
+    end_date_time: AwareDatetime | None = None
+    end_time_zone: str | None = None
+    original_start_time_zone: str | None = None
+    original_end_time_zone: str | None = None
+    is_all_day: bool | None = None
+    is_cancelled: bool | None = None
+    is_draft: bool | None = None
+    is_online_meeting: bool | None = None
+    is_organizer: bool | None = None
+    is_reminder_on: bool | None = None
+    has_attachments: bool | None = None
+    hide_attendees: bool | None = None
+    allow_new_time_proposals: bool | None = None
+    response_requested: bool | None = None
+    importance: str | None = None
+    sensitivity: str | None = None
+    show_as: str | None = None
+    created_date_time: AwareDatetime | None = None
+    last_modified_date_time: AwareDatetime | None = None
+    change_key: str | None = None
+    i_cal_uid: str | None = None
+    i_cal_uid_v2: str | None = None
+    uid: str | None = None
+    online_meeting: dict[str, Any] | None = None
+    online_meeting_provider: str | None = None
+    online_meeting_url: str | None = None
+    recurrence: dict[str, Any] | None = None
+    reminder_minutes_before_start: NonNegativeInt | None = None
+    response_status: dict[str, Any] | None = None
+    transaction_id: str | None = None
+    web_link: str | None = None
+
+
+CALENDAR_COLUMN_DESCRIPTIONS = {
+    "allowed_online_meeting_providers": {
+        "description": (
+            "Represent the online meeting service providers that can be used to "
+            "create online meetings in this calendar. The possible values are: "
+            "`unknown`, `skypeForBusiness`, `skypeForConsumer`, `teamsForBusiness`."
+        )
+    },
+    "calendar_group_id": {
+        "description": (
+            "The calendarGroup in which to create the calendar. If the user has "
+            "never explicitly set a group for the calendar, this property is null."
+        )
+    },
+    "can_edit": {
+        "description": (
+            "`true` if the user can write to the calendar, `false` otherwise. This "
+            "property is `true` for the user who created the calendar. This "
+            "property is also `true` for a user who has been shared a calendar and "
+            "granted write access, through an Outlook client or the corresponding "
+            "calendarPermission resource. Read-only."
+        )
+    },
+    "can_share": {
+        "description": (
+            "`true` if the user has the permission to share the calendar, `false` "
+            "otherwise. Only the user who created the calendar can share it. "
+            "Read-only."
+        )
+    },
+    "can_view_private_items": {
+        "description": (
+            "`true` if the user can read calendar items that have been marked "
+            "private, `false` otherwise. This property is set through an Outlook "
+            "client or the corresponding calendarPermission resource. Read-only."
+        )
+    },
+    "change_key": {
+        "description": (
+            "Identifies the version of the calendar object. Every time the "
+            "calendar is changed, changeKey changes as well. This allows Exchange "
+            "to apply changes to the correct version of the object. Read-only."
+        )
+    },
+    "color": {
+        "description": (
+            "Specifies the color theme to distinguish the calendar from other "
+            "calendars in a UI. The property values are: `auto`, `lightBlue`, "
+            "`lightGreen`, `lightOrange`, `lightGray`, `lightYellow`, `lightTeal`, "
+            "`lightPink`, `lightBrown`, `lightRed`, `maxColor`."
+        )
+    },
+    "default_online_meeting_provider": {
+        "description": (
+            "The default online meeting provider for meetings sent from this "
+            "calendar. The possible values are: `unknown`, `skypeForBusiness`, "
+            "`skypeForConsumer`, `teamsForBusiness`."
+        )
+    },
+    "hex_color": {
+        "description": (
+            "The calendar color, expressed in a hex color code of three "
+            "hexadecimal values, each ranging from 00 to FF and representing the "
+            "red, green, or blue components of the color in the RGB color space. "
+            "If the user has never explicitly set a color for the calendar, this "
+            "property is empty."
+        )
+    },
+    "id": {"description": "The calendar's unique identifier. Read-only."},
+    "is_default_calendar": {
+        "description": (
+            "`true` if this is the default calendar where new events are created "
+            "by default, `false` otherwise."
+        )
+    },
+    "is_removable": {
+        "description": (
+            "Indicates whether this user calendar can be deleted from the user mailbox."
+        )
+    },
+    "is_shared": {
+        "description": (
+            "`true` if the user has shared the calendar with other users, `false` "
+            "otherwise. Since only the user who created the calendar can share it, "
+            "**isShared** and **isSharedWithMe** cannot be `true` for the same "
+            "user. This property is set when sharing is initiated in an Outlook "
+            "client, and can be reset when the sharing is cancelled through the "
+            "client or the corresponding calendarPermission resource. Read-only."
+        )
+    },
+    "is_shared_with_me": {
+        "description": (
+            "`true` if the user has been shared this calendar, `false` otherwise. "
+            "This property is always `false` for a calendar owner. This property "
+            "is set when sharing is initiated in an Outlook client, and can be "
+            "reset when the sharing is cancelled through the client or the "
+            "corresponding calendarPermission resource. Read-only."
+        )
+    },
+    "is_tallying_responses": {
+        "description": (
+            "Indicates whether this user calendar supports tracking of meeting "
+            "responses. Only meeting invites sent from users' primary calendars "
+            "support tracking of meeting responses."
+        )
+    },
+    "name": {"description": "The calendar name."},
+    "owner_name": {
+        "description": (
+            "If set, this represents the user who created or added the calendar. "
+            "For a calendar that the user created or added, the **owner** property "
+            "is set to the user. For a calendar shared with the user, the "
+            "**owner** property is set to the person who shared that calendar with "
+            "the user. Read-only."
+        )
+    },
+    "owner_address": {
+        "description": (
+            "If set, this represents the user who created or added the calendar. "
+            "For a calendar that the user created or added, the **owner** property "
+            "is set to the user. For a calendar shared with the user, the "
+            "**owner** property is set to the person who shared that calendar with "
+            "the user. Read-only."
+        )
+    },
+}
+
+EVENT_COLUMN_DESCRIPTIONS = {
+    "calendar_id": {
+        "description": (
+            "ContextLayer: the id of the calendar whose delta produced this row "
+            "(event payloads carry no calendar field). Part of the primary key."
+        )
+    },
+    "type": {
+        "description": (
+            "The event type. The possible values are: `singleInstance`, "
+            "`occurrence`, `exception`, `seriesMaster`. Read-only"
+        )
+    },
+    "series_master_id": {
+        "description": (
+            "The ID for the recurring series master item, if this event is part "
+            "of a recurring series."
+        )
+    },
+    "occurrence_id": {
+        "description": (
+            "An identifier for an occurrence in a recurring event series. Null if "
+            "the event isn't part of a recurring series.The format of the property "
+            "value is OID.{seriesMasterId-value}.{occurrence-start-date}. The time "
+            "zone for {occurrence-start-date} is the recurrenceTimeZone property "
+            "defined for the corresponding recurrenceRange.This property can "
+            "identify any occurrence in a recurring series, including an "
+            "occurrence that has been modified or canceled. You can use this "
+            "property to perform all operations supported by occurrences in the "
+            "recurring series."
+        )
+    },
+    "id": {
+        "description": (
+            "Unique identifier for the event. By default, this value changes when "
+            "the item is moved from one container (such as a folder or calendar) "
+            "to another. To change this behavior, use the `Prefer: "
+            'IdType="ImmutableId"` header. See Get immutable identifiers for '
+            "Outlook resources for more information. Case-sensitive and read-only."
+        )
+    },
+    "subject": {"description": "The text of the event's subject line."},
+    "body": {
+        "description": (
+            "The body of the message associated with the event. It can be in HTML "
+            "or text format."
+        )
+    },
+    "body_preview": {
+        "description": (
+            "The preview of the message associated with the event. It is in text "
+            "format."
+        )
+    },
+    "categories": {
+        "description": (
+            "The categories associated with the event. Each category corresponds "
+            "to the **displayName** property of an outlookCategory defined for "
+            "the user."
+        )
+    },
+    "attendees": {"description": "The collection of attendees for the event."},
+    "organizer_name": {"description": "The organizer of the event."},
+    "organizer_address": {"description": "The organizer of the event."},
+    "location": {"description": "The location of the event."},
+    "locations": {
+        "description": (
+            "The locations where the event is held or attended from. The "
+            "**location** and **locations** properties always correspond with "
+            "each other. If you update the **location** property, any prior "
+            "locations in the **locations** collection would be removed and "
+            "replaced by the new **location** value."
+        )
+    },
+    "start_date_time": {
+        "description": (
+            "The start date, time, and time zone of the event. By default, the "
+            "start time is in UTC."
+        )
+    },
+    "start_time_zone": {
+        "description": (
+            "The start date, time, and time zone of the event. By default, the "
+            "start time is in UTC."
+        )
+    },
+    "end_date_time": {
+        "description": (
+            "The date, time, and time zone that the event ends. By default, the "
+            "end time is in UTC."
+        )
+    },
+    "end_time_zone": {
+        "description": (
+            "The date, time, and time zone that the event ends. By default, the "
+            "end time is in UTC."
+        )
+    },
+    "original_start_time_zone": {
+        "description": (
+            "The start time zone that was set when the event was created. A value "
+            "of `tzone://Microsoft/Custom` indicates that a legacy custom time "
+            "zone was set in desktop Outlook."
+        )
+    },
+    "original_end_time_zone": {
+        "description": (
+            "The end time zone that was set when the event was created. A value "
+            "of `tzone://Microsoft/Custom` indicates that a legacy custom time "
+            "zone was set in desktop Outlook."
+        )
+    },
+    "is_all_day": {
+        "description": (
+            "Set to true if the event lasts all day. If true, regardless of "
+            "whether it's a single-day or multi-day event, start and end time "
+            "must be set to midnight and be in the same time zone."
+        )
+    },
+    "is_cancelled": {"description": "Set to true if the event has been canceled."},
+    "is_draft": {
+        "description": (
+            "Set to true if the user has updated the meeting in Outlook but "
+            "hasn't sent the updates to attendees. Set to false if all changes "
+            "have been sent, or if the event is an appointment without any "
+            "attendees."
+        )
+    },
+    "is_online_meeting": {
+        "description": (
+            "`True` if this event has online meeting information (that is, "
+            "**onlineMeeting** points to an onlineMeetingInfo resource), `false` "
+            "otherwise. Default is `false` (**onlineMeeting** is `null`). "
+            "Optional.  After you set **isOnlineMeeting** to `true`, Microsoft "
+            "Graph initializes **onlineMeeting**. Outlook then ignores any "
+            "further changes to **isOnlineMeeting**, and the meeting remains "
+            "available online."
+        )
+    },
+    "is_organizer": {
+        "description": (
+            "Set to true if the calendar owner (specified by the **owner** "
+            "property of the calendar) is the organizer of the event (specified "
+            "by the **organizer** property of the **event**). This also applies "
+            "if a delegate organized the event on behalf of the owner."
+        )
+    },
+    "is_reminder_on": {
+        "description": (
+            "Set to true if an alert is set to remind the user of the event."
+        )
+    },
+    "has_attachments": {"description": "Set to true if the event has attachments."},
+    "hide_attendees": {
+        "description": (
+            "When set to `true`, each attendee only sees themselves in the "
+            "meeting request and meeting **Tracking** list. Default is false."
+        )
+    },
+    "allow_new_time_proposals": {
+        "description": (
+            "`true` if the meeting organizer allows invitees to propose a new "
+            "time when responding; otherwise `false`. Optional. Default is `true`."
+        )
+    },
+    "response_requested": {
+        "description": (
+            "Default is true, which represents the organizer would like an "
+            "invitee to send a response to the event."
+        )
+    },
+    "importance": {
+        "description": (
+            "The importance of the event. The possible values are: `low`, "
+            "`normal`, `high`."
+        )
+    },
+    "sensitivity": {
+        "description": (
+            "The possible values are: `normal`, `personal`, `private`, `confidential`."
+        )
+    },
+    "show_as": {
+        "description": (
+            "The status to show. The possible values are: `free`, `tentative`, "
+            "`busy`, `oof`, `workingElsewhere`, `unknown`."
+        )
+    },
+    "created_date_time": {
+        "description": (
+            "The Timestamp type represents date and time information using ISO "
+            "8601 format and is always in UTC time. For example, midnight UTC on "
+            "Jan 1, 2014 is `2014-01-01T00:00:00Z`"
+        )
+    },
+    "last_modified_date_time": {
+        "description": (
+            "The Timestamp type represents date and time information using ISO "
+            "8601 format and is always in UTC time. For example, midnight UTC on "
+            "Jan 1, 2014 is `2014-01-01T00:00:00Z`"
+        )
+    },
+    "change_key": {
+        "description": (
+            "Identifies the version of the event object. Every time the event is "
+            "changed, ChangeKey changes as well. This allows Exchange to apply "
+            "changes to the correct version of the object."
+        )
+    },
+    "i_cal_uid": {
+        "description": (
+            "A unique identifier for an event across calendars. This ID is "
+            "different for each occurrence in a recurring series. Read-only."
+        )
+    },
+    "uid": {
+        "description": (
+            "A unique identifier for calendar events. For recurring events, the "
+            "value is the same for the series master and all of its occurrences "
+            "including exceptions."
+        )
+    },
+    "online_meeting": {
+        "description": (
+            "Details for an attendee to join the meeting online. Default is null. "
+            "Read-only. After you set the **isOnlineMeeting** and "
+            "**onlineMeetingProvider** properties to enable a meeting online, "
+            "Microsoft Graph initializes **onlineMeeting**. When set, the meeting "
+            "remains available online, and you can't change the "
+            "**isOnlineMeeting**, **onlineMeetingProvider**, and **onlneMeeting** "
+            "properties again."
+        )
+    },
+    "online_meeting_provider": {
+        "description": (
+            "Represents the online meeting service provider. By default, "
+            "**onlineMeetingProvider** is `unknown`. The possible values are "
+            "`unknown`, `teamsForBusiness`, `skypeForBusiness`, and "
+            "`skypeForConsumer`. Optional.  After you set "
+            "**onlineMeetingProvider**, Microsoft Graph initializes "
+            "**onlineMeeting**. Subsequently you can't change "
+            "**onlineMeetingProvider** again, and the meeting remains available "
+            "online."
+        )
+    },
+    "online_meeting_url": {
+        "description": (
+            "A URL for an online meeting. The property is set only when an "
+            "organizer specifies in Outlook that an event is an online meeting "
+            "such as Skype. Read-only.To access the URL to join an online "
+            "meeting, use **joinUrl** which is exposed via the **onlineMeeting** "
+            "property of the **event**. The **onlineMeetingUrl** property will "
+            "be deprecated in the future."
+        )
+    },
+    "recurrence": {"description": "The recurrence pattern for the event."},
+    "reminder_minutes_before_start": {
+        "description": (
+            "The number of minutes before the event start time that the reminder "
+            "alert occurs."
+        )
+    },
+    "response_status": {
+        "description": (
+            "Indicates the type of response sent in response to an event message."
+        )
+    },
+    "transaction_id": {
+        "description": (
+            "A custom identifier specified by a client app for the server to "
+            "avoid redundant POST operations if the client retries to create the "
+            "same event. This is useful when low network connectivity causes the "
+            "client to time out before receiving a response from the server for "
+            "the client's prior create-event request. After you set "
+            "**transactionId** when creating an event, you can't change "
+            "**transactionId** in a subsequent update. This property is only "
+            "returned in a response payload if an app has set it. Optional."
+        )
+    },
+    "web_link": {
+        "description": (
+            "The URL to open the event in Outlook on the web.Outlook on the web "
+            "opens the event in the browser if you're signed in to your mailbox. "
+            "Otherwise, Outlook on the web prompts you to sign in.This URL can't "
+            "be accessed from within an iFrame."
+        )
+    },
+}