Skip to content

Commit 05ae1ad

Browse files
committed
Clarify list-events query param documentation
1 parent c04c3d8 commit 05ae1ad

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Unreleased
55
* UAS multi-credential update
66
* Added `specific_time_availability` field to `AvailabilityParticipant` for overriding open hours on specific dates
77
* Added `smtp_required` option to hosted authentication config to require users to enter SMTP settings during IMAP authentication
8+
* Clarified `ListEventQueryParams` documentation (attribute order, field descriptions, and `expand_recurring` wording)
89

910
v6.14.2
1011
----------

nylas/models/events.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -818,21 +818,21 @@ class ListEventQueryParams(ListQueryParams):
818818
expand_recurring: If true, the response will include an event for each occurrence of a recurring event within
819819
the requested time range.
820820
If false, only a single primary event will be returned for each recurring event.
821-
Cannot be used when filtering on metadata. Defaults to false.
821+
Cannot be used when filtering on metadata.
822822
busy: Returns events with a busy status of true.
823823
order_by: Order results by the specified field.
824824
Currently only start is supported.
825-
event_type (NotRequired[List[EventType]]): (Google only) Filter events by event type.
825+
event_type: (Google only) Filter events by event type.
826826
You can pass the query parameter multiple times to select or exclude multiple event types.
827-
master_event_id (NotRequired[str]): Filter for instances of recurring events with the
828-
specified master_event_id. Not respected by metadata filtering.
829-
tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
830-
Only applicable for Microsoft and EWS calendar providers. Defaults to true.
827+
master_event_id: Filter for instances of recurring events with the given
828+
master event ID. Not respected by metadata filtering.
831829
select: Comma-separated list of fields to return in the response.
832830
This allows you to receive only the portion of object data that you're interested in.
833-
limit (NotRequired[int]): The maximum number of objects to return.
831+
tentative_as_busy: When set to false, treats tentative calendar events as busy:false.
832+
Only applicable for Microsoft and EWS calendar providers. Defaults to true.
833+
limit: The maximum number of objects to return.
834834
This field defaults to 50. The maximum allowed value is 200.
835-
page_token (NotRequired[str]): An identifier that specifies which page of data to return.
835+
page_token: An identifier that specifies which page of data to return.
836836
This value should be taken from a ListResponse object's next_cursor parameter.
837837
"""
838838

0 commit comments

Comments
 (0)