From 05ae1ad4abab3f6f048d28a6cced72159d4070d8 Mon Sep 17 00:00:00 2001 From: pengfeiye Date: Thu, 2 Apr 2026 17:53:49 -0400 Subject: [PATCH] Clarify list-events query param documentation --- CHANGELOG.md | 1 + nylas/models/events.py | 16 ++++++++-------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c8ef131..99230eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ Unreleased * UAS multi-credential update * Added `specific_time_availability` field to `AvailabilityParticipant` for overriding open hours on specific dates * Added `smtp_required` option to hosted authentication config to require users to enter SMTP settings during IMAP authentication +* Clarified `ListEventQueryParams` documentation (attribute order, field descriptions, and `expand_recurring` wording) v6.14.2 ---------- diff --git a/nylas/models/events.py b/nylas/models/events.py index c4a2045..3fa7686 100644 --- a/nylas/models/events.py +++ b/nylas/models/events.py @@ -818,21 +818,21 @@ class ListEventQueryParams(ListQueryParams): expand_recurring: If true, the response will include an event for each occurrence of a recurring event within the requested time range. If false, only a single primary event will be returned for each recurring event. - Cannot be used when filtering on metadata. Defaults to false. + Cannot be used when filtering on metadata. busy: Returns events with a busy status of true. order_by: Order results by the specified field. Currently only start is supported. - event_type (NotRequired[List[EventType]]): (Google only) Filter events by event type. + event_type: (Google only) Filter events by event type. 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. + master_event_id: Filter for instances of recurring events with the given + master event ID. Not respected by metadata filtering. 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. + 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. + limit: The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200. - page_token (NotRequired[str]): An identifier that specifies which page of data to return. + page_token: An identifier that specifies which page of data to return. This value should be taken from a ListResponse object's next_cursor parameter. """