Add tentative_as_busy parameter (#631)

Author: kraju3

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### Unreleased
 * Add support for Notetaker API endpoints
 * Update calendar and event models with notetaker settings
+* Add support for `tentativeAsBusy` parameter in availability and event listing
 
 # Changelog
 

src/models/availability.ts

@@ -100,6 +100,12 @@ export interface AvailabilityRules {
    * This is used for both max-fairness and max-availability methods.
    */
   roundRobinEventId?: string;
+  /**
+   * 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.
+   */
+  tentativeAsBusy?: boolean;
 }
 
 /**

src/models/events.ts

@@ -316,6 +316,11 @@ export interface ListEventQueryParams extends ListQueryParams {
    * Master event id if recurring events.
    */
   masterEventId?: string;
+  /**
+   * When set to false, treats tentative calendar events as busy:false.
+   * Only applicable for Microsoft and EWS calendar providers. Defaults to true.
+   */
+  tentativeAsBusy?: boolean;
 }
 
 /**
@@ -330,6 +335,11 @@ export interface CreateEventQueryParams {
    * Email notifications containing the calendar event is sent to all event participants.
    */
   notifyParticipants?: boolean;
+  /**
+   * When set to false, treats tentative calendar events as busy:false.
+   * Only applicable for Microsoft and EWS calendar providers. Defaults to true.
+   */
+  tentativeAsBusy?: boolean;
 }
 
 /**
@@ -340,6 +350,11 @@ export interface FindEventQueryParams {
    * Calendar ID to find the event in. "primary" is a supported value indicating the user's primary calendar.
    */
   calendarId: string;
+  /**
+   * When set to false, treats tentative calendar events as busy:false.
+   * Only applicable for Microsoft and EWS calendar providers. Defaults to true.
+   */
+  tentativeAsBusy?: boolean;
 }
 
 /**

tests/resources/calendars.spec.ts

@@ -318,6 +318,74 @@ describe('Calendars', () => {
         },
       });
     });
+
+    it('should call apiClient.request with tentativeAsBusy parameter', async () => {
+      await calendars.getAvailability({
+        requestBody: {
+          startTime: 123,
+          endTime: 456,
+          participants: [],
+          durationMinutes: 30,
+          intervalMinutes: 15,
+          availabilityRules: {
+            availabilityMethod: AvailabilityMethod.MaxAvailability,
+            buffer: {
+              before: 15,
+              after: 15,
+            },
+            defaultOpenHours: [
+              {
+                days: [0],
+                timezone: 'America/Toronto',
+                start: '09:00',
+                end: '17:00',
+                exdates: ['2020-01-01'],
+              },
+            ],
+            roundRobinEventId: 'event123',
+            tentativeAsBusy: false, // Don't treat tentative events as busy
+          },
+        },
+        overrides: {
+          apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
+        },
+      });
+
+      expect(apiClient.request).toHaveBeenCalledWith({
+        method: 'POST',
+        path: '/v3/calendars/availability',
+        body: {
+          startTime: 123,
+          endTime: 456,
+          participants: [],
+          durationMinutes: 30,
+          intervalMinutes: 15,
+          availabilityRules: {
+            availabilityMethod: AvailabilityMethod.MaxAvailability,
+            buffer: {
+              before: 15,
+              after: 15,
+            },
+            defaultOpenHours: [
+              {
+                days: [0],
+                timezone: 'America/Toronto',
+                start: '09:00',
+                end: '17:00',
+                exdates: ['2020-01-01'],
+              },
+            ],
+            roundRobinEventId: 'event123',
+            tentativeAsBusy: false, // Don't treat tentative events as busy
+          },
+        },
+        overrides: {
+          apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
+        },
+      });
+    });
   });
 
   describe('getCollectiveAvailability', () => {

tests/resources/events.spec.ts

@@ -44,6 +44,33 @@ describe('Events', () => {
       });
     });
 
+    it('should call apiClient.request with tentativeAsBusy parameter', async () => {
+      await events.list({
+        identifier: 'id123',
+        queryParams: {
+          calendarId: 'calendar123',
+          tentativeAsBusy: false, // Don't treat tentative events as busy
+        },
+        overrides: {
+          apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
+        },
+      });
+
+      expect(apiClient.request).toHaveBeenCalledWith({
+        method: 'GET',
+        path: '/v3/grants/id123/events',
+        queryParams: {
+          calendarId: 'calendar123',
+          tentativeAsBusy: false, // Don't treat tentative events as busy
+        },
+        overrides: {
+          apiUri: 'https://test.api.nylas.com',
+          headers: { override: 'bar' },
+        },
+      });
+    });
+
     it('should paginate correctly if a nextCursor is present', async () => {
       apiClient.request.mockResolvedValueOnce({
         requestId: 'request123',