availability
AvailabilityMethod = Literal['max-fairness', 'max-availability']
module-attribute
Literal representing the method used to determine availability for a meeting.
AvailabilityParticipant
Bases: TypedDict
Interface of participant details to check availability for.
Attributes:
Name | Type | Description |
---|---|---|
email |
str
|
The email address of the participant. |
calendar_ids |
NotRequired[List[str]]
|
An optional list of the calendar IDs associated with each participant's email address. If not provided, Nylas uses the primary calendar ID. |
open_hours |
NotRequired[List[OpenHours]]
|
Open hours for this participant. The endpoint searches for free time slots during these open hours. |
Source code in nylas/models/availability.py
100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
AvailabilityRules
Bases: TypedDict
Interface for the availability rules for a Nylas calendar.
Attributes:
Name | Type | Description |
---|---|---|
availability_method |
NotRequired[AvailabilityMethod]
|
The method used to determine availability for a meeting. |
buffer |
NotRequired[MeetingBuffer]
|
The buffer to add to the start and end of a meeting. |
default_open_hours |
NotRequired[List[OpenHours]]
|
A default set of open hours to apply to all participants. You can overwrite these open hours for individual participants by specifying open_hours on the participant object. |
round_robin_event_id |
NotRequired[str]
|
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. |
Source code in nylas/models/availability.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
|
GetAvailabilityRequest
Bases: TypedDict
Interface for a Nylas get availability request
Attributes:
Name | Type | Description |
---|---|---|
start_time |
int
|
Unix timestamp for the start time to check availability for. |
end_time |
int
|
Unix timestamp for the end time to check availability for. |
participants |
List[AvailabilityParticipant]
|
Participant details to check availability for. |
duration_minutes |
int
|
The total number of minutes the event should last. |
interval_minutes |
NotRequired[int]
|
Nylas checks from the nearest interval of the passed start time. For example, to schedule 30-minute meetings with 15 minutes between them. If you have a meeting starting at 9:59, the API returns times starting at 10:00. 10:00-10:30, 10:15-10:45. |
round_to_30_minutes |
NotRequired[bool]
|
When set to true, the availability time slots will start at 30 minutes past or on the hour. For example, a free slot starting at 16:10 is considered available only from 16:30. |
availability_rules |
NotRequired[AvailabilityRules]
|
The rules to apply when checking availability. |
Source code in nylas/models/availability.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
|
GetAvailabilityResponse
dataclass
Interface for a Nylas get availability response
Attributes:
Name | Type | Description |
---|---|---|
order |
List[str]
|
This property is only populated for round-robin events. It will contain the order in which the accounts would be next in line to attend the proposed meeting. |
time_slots |
List[TimeSlot]
|
The available time slots where a new meeting can be created for the requested preferences. |
Source code in nylas/models/availability.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
|
MeetingBuffer
Bases: TypedDict
Interface for the meeting buffer object within an availability request.
Attributes:
Name | Type | Description |
---|---|---|
before |
int
|
The amount of buffer time in increments of 5 minutes to add before existing meetings. Defaults to 0. |
after |
int
|
The amount of buffer time in increments of 5 minutes to add after existing meetings. Defaults to 0. |
Source code in nylas/models/availability.py
44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
OpenHours
Bases: TypedDict
Interface of a participant's open hours.
Attributes:
Name | Type | Description |
---|---|---|
days |
List[int]
|
The days of the week that the open hour settings will be applied to. Sunday corresponds to 0 and Saturday corresponds to 6. |
timezone |
str
|
IANA time zone database formatted string (e.g. America/New_York). |
start |
str
|
Start time in 24-hour time format. Leading 0's are left off. |
end |
str
|
End time in 24-hour time format. Leading 0's are left off. |
extdates |
List[str]
|
A list of dates that will be excluded from the open hours. Dates should be formatted as YYYY-MM-DD. |
Source code in nylas/models/availability.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
|
TimeSlot
dataclass
Interface for a Nylas availability time slot
Attributes:
Name | Type | Description |
---|---|---|
emails |
List[str]
|
The emails of the participants who are available for the time slot. |
start_time |
int
|
Unix timestamp for the start of the slot. |
end_time |
int
|
Unix timestamp for the end of the slot. |
Source code in nylas/models/availability.py
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|