Add tentative_as_busy flag to the availability request (#415)

* Add tentative_as_busy flag to the availability request

* Added changelog and fix lint issues

* Fix tests

* Update the tentative_as_busy property to the availability request

* Updated changelog

---------

Co-authored-by: Aaron de Mello <[email protected]>

Author: kraju3

CHANGELOG.md

@@ -3,6 +3,8 @@ nylas-python Changelog
 
 Unreleased
 ----------------
+* Support for tentative_as_busy parameter that controls whether tentative events are treated as busy time. 
+* Available as a query parameter for Events requests and as a property in Availability request bodies
 * Added support for Notetaker APIs
 * Added support for Notetaker via the calendar and event APIs
 

nylas/models/availability.py

@@ -90,12 +90,16 @@ class AvailabilityRules(TypedDict):
         round_robin_group_id: The ID on events that Nylas considers when calculating the order of
             round-robin participants.
             This is used for both max-fairness and max-availability methods.
+        tentative_as_busy: Controls whether tentative calendar events should be treated as busy time.
+            When set to false, tentative events will be considered as free in availability calculations.
+            Defaults to true. Only applicable for Microsoft and EWS calendar providers.
     """
 
     availability_method: NotRequired[AvailabilityMethod]
     buffer: NotRequired[MeetingBuffer]
     default_open_hours: NotRequired[List[OpenHours]]
     round_robin_group_id: NotRequired[str]
+    tentative_as_busy: NotRequired[bool]
 
 
 class AvailabilityParticipant(TypedDict):

nylas/models/events.py

@@ -822,6 +822,8 @@ class ListEventQueryParams(ListQueryParams):
             You can pass the query parameter multiple times to select or exclude multiple event types.
         master_event_id (NotRequired[str]): Filter for instances of recurring events with the
             specified master_event_id. Not respected by metadata filtering.
+        tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
+            Only applicable for Microsoft and EWS calendar providers. Defaults to true.
         select: Comma-separated list of fields to return in the response.
             This allows you to receive only the portion of object data that you're interested in.
         limit (NotRequired[int]): The maximum number of objects to return.
@@ -844,6 +846,7 @@ class ListEventQueryParams(ListQueryParams):
     event_type: NotRequired[List[EventType]]
     master_event_id: NotRequired[str]
     select: NotRequired[str]
+    tentative_as_busy: NotRequired[bool]
 
 
 class CreateEventQueryParams(TypedDict):
@@ -853,10 +856,13 @@ class CreateEventQueryParams(TypedDict):
     Attributes:
         calendar_id: The ID of the calendar to create the event in.
         notify_participants: Email notifications containing the calendar event is sent to all event participants.
+        tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
+            Only applicable for Microsoft and EWS calendar providers. Defaults to true.
     """
 
     calendar_id: str
     notify_participants: NotRequired[bool]
+    tentative_as_busy: NotRequired[bool]
 
 
 class FindEventQueryParams(TypedDict):
@@ -866,9 +872,12 @@ class FindEventQueryParams(TypedDict):
     Attributes:
         calendar_id: Calendar ID to find the event in.
             "primary" is a supported value indicating the user's primary calendar.
+        tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
+            Only applicable for Microsoft and EWS calendar providers. Defaults to true.
     """
 
     calendar_id: str
+    tentative_as_busy: NotRequired[bool]
 
 
 UpdateEventQueryParams = CreateEventQueryParams

nylas/resources/calendars.py

@@ -163,8 +163,7 @@ def destroy(
             path=f"/v3/grants/{identifier}/calendars/{calendar_id}", overrides=overrides
         )
 
-    def get_availability(
-        self, request_body: GetAvailabilityRequest, overrides: RequestOverrides = None
+    def get_availability(self, request_body: GetAvailabilityRequest, overrides: RequestOverrides = None
     ) -> Response[GetAvailabilityResponse]:
         """
         Get availability for a Calendar.

tests/resources/test_calendars.py

@@ -342,26 +342,27 @@ def test_get_availability(self, http_client_response):
                     ],
                 }
             ],
-            "locale": "en",
+            "duration_minutes": 60,
+            "interval_minutes": 30,
+            "round_to_30_minutes": True,
+            "availability_rules": {
+                "availability_method": "max-availability",
+                "buffer": {"before": 10, "after": 10},
+                "default_open_hours": [
+                    {
+                        "days": [0],
+                        "timezone": "America/Los_Angeles",
+                        "start": "09:00",
+                        "end": "17:00",
+                        "exdates": ["2021-03-01"],
+                    }
+                ],
+                "round_robin_group_id": "event-123",
+                "tentative_as_busy": False
+            },
         }
 
-        # Set up mock response data
-        http_client_response._execute.return_value = ({
-            "availability": [
-                {
-                    "end_time": 1497960800,
-                    "start_time": 1497960600,
-                    "status": "free",
-                    "object": "availability_status",
-                }
-            ],
-            "object": "availability",
-            "time_slots": [
-                {"end_time": 1497960800, "start_time": 1497960600, "status": "free"}
-            ],
-        }, {})
-
-        calendars.get_availability(request_body=request_body)
+        calendars.get_availability(request_body,overrides=None,)
 
         http_client_response._execute.assert_called_once_with(
             "POST",