Skip to content

free_busy

FreeBusy dataclass

Interface for an individual Nylas free/busy response

Attributes:

Name Type Description
email str

The email address of the participant.
time_slots List[TimeSlot]

List of time slots for the participant.
Source code in nylas/models/free_busy.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
@dataclass_json
@dataclass
class FreeBusy:
    """
    Interface for an individual Nylas free/busy response

    Attributes:
        email: The email address of the participant.
        time_slots: List of time slots for the participant.
    """

    email: str
    time_slots: List[TimeSlot]

FreeBusyError dataclass

Interface for a Nylas free/busy call error

Attributes:

Name Type Description
email str

The email address of the participant who had an error.
error str

The provider's error message.
Source code in nylas/models/free_busy.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
@dataclass_json
@dataclass
class FreeBusyError:
    """
    Interface for a Nylas free/busy call error

    Attributes:
        email: The email address of the participant who had an error.
        error: The provider's error message.
    """

    email: str
    error: str

GetFreeBusyRequest

Bases: TypedDict

Interface for a Nylas get free/busy request

Attributes:

Name Type Description
start_time int

Unix timestamp for the start time to check free/busy for.
end_time int

Unix timestamp for the end time to check free/busy for.
emails List[str]

List of email addresses to check free/busy for.
Source code in nylas/models/free_busy.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
class GetFreeBusyRequest(TypedDict):
    """
    Interface for a Nylas get free/busy request

    Attributes:
        start_time: Unix timestamp for the start time to check free/busy for.
        end_time: Unix timestamp for the end time to check free/busy for.
        emails: List of email addresses to check free/busy for.
    """

    start_time: int
    end_time: int
    emails: List[str]

GetFreeBusyResponse dataclass

Interface for a Nylas get free/busy response

A list of FreeBusy objects and FreeBusyError objects.

Source code in nylas/models/free_busy.py 
55
56
57
58
59
60
61
62
63
64
65
@dataclass_json
@dataclass
class GetFreeBusyResponse:
    """
    Interface for a Nylas get free/busy response

    A list of FreeBusy objects and FreeBusyError objects.

    """

    List[Union[FreeBusy, FreeBusyError]]

TimeSlot dataclass

Interface for a Nylas free/busy time slot

Attributes:

Name Type Description
start_time int

Unix timestamp for the start of the slot.
end_time int

Unix timestamp for the end of the slot.
status str

The status of the slot. Typically "busy"
Source code in nylas/models/free_busy.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@dataclass_json
@dataclass
class TimeSlot:
    """
    Interface for a Nylas free/busy time slot

    Attributes:
        start_time: Unix timestamp for the start of the slot.
        end_time: Unix timestamp for the end of the slot.
        status: The status of the slot. Typically "busy"
    """

    start_time: int
    end_time: int
    status: str