Skip to content

bookings

Bookings

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, UpdatablePatchApiResource, DestroyableApiResource

Nylas Bookings API

The Nylas Bookings API allows you to create new bookings or manage existing ones, as well as getting bookings details for a user.

A booking can be accessed by one, or several people, and can contain events.

Source code in nylas/resources/bookings.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
class Bookings(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    UpdatablePatchApiResource,
    DestroyableApiResource,
):
    """
    Nylas Bookings API

    The Nylas Bookings API allows you to create new bookings or manage existing ones, as well as getting
    bookings details for a user.

    A booking can be accessed by one, or several people, and can contain events.
    """

    def find(
        self,
        booking_id: str,
        query_params: FindBookingQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> Response[Booking]:
        """
        Return a Booking.

        Args:
                identifier: The identifier of the Grant to act upon.
                booking_id: The identifier of the Booking to get.
                query_params: The query parameters to include in the request.
                overrides: The request overrides to use for the request.

        Returns:
                The Booking.
        """

        return super().find(
            path=f"/v3/scheduling/bookings/{booking_id}",
            query_params=query_params,
            response_type=Booking,
            overrides=overrides,
        )

    def create(
        self,
        request_body: CreateBookingRequest,
        query_params: CreateBookingQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> Response[Booking]:
        """
        Create a Booking.

        Args:
                request_body: The values to create booking with.
                overrides: The request overrides to use for the request.
                query_params: The query parameters to include in the request.
                overrides: The request overrides to use for the request.

        Returns:
                The created Booking.
        """

        return super().create(
            path="/v3/scheduling/bookings",
            request_body=request_body,
            query_params=query_params,
            response_type=Booking,
            overrides=overrides,
        )

    def confirm(
        self,
        booking_id: str,
        request_body: ConfirmBookingRequest,
        query_params: ConfirmBookingQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> Response[Booking]:
        """
        Confirm a Booking.

        Args:
                booking_id: The identifier of the Booking to confirm.
                request_body: The values to confirm booking with.
                query_params: The query parameters to include in the request.
                overrides: The request overrides to use for the request.

        Returns:
                The confirmed Booking.
        """

        return super().update(
            path=f"/v3/scheduling/bookings/{booking_id}",
            request_body=request_body,
            query_params=query_params,
            response_type=Booking,
            overrides=overrides,
        )

    def reschedule(
        self,
        booking_id: str,
        request_body: RescheduleBookingRequest,
        query_params: RescheduleBookingQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> Response[Booking]:
        """
        Reschedule a Booking.

        Args:
                booking_id: The identifier of the Booking to reschedule.
                request_body: The values to reschedule booking with.
                query_params: The query parameters to include in the request.
                overrides: The request overrides to use for the request.

        Returns:
                The rescheduled Booking.
        """

        return super().patch(
            path=f"/v3/scheduling/bookings/{booking_id}",
            request_body=request_body,
            query_params=query_params,
            response_type=Booking,
            overrides=overrides,
        )

    def destroy(
        self,
        booking_id: str,
        request_body: DeleteBookingRequest,
        query_params: DestroyBookingQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> DeleteResponse:
        """
        Delete a Booking.

        Args:
                booking_id: The identifier of the Booking to delete.
                request_body: The reason to delete booking with.
                query_params: The query parameters to include in the request.
                overrides: The request overrides to use for the request.

        Returns:
                None.
        """

        return super().destroy(
            path=f"/v3/scheduling/bookings/{booking_id}",
            request_body=request_body,
            query_params=query_params,
            overrides=overrides,
        )

confirm(booking_id, request_body, query_params=None, overrides=None)

Confirm a Booking.

Parameters:

Name Type Description Default
booking_id str

The identifier of the Booking to confirm.

 required
request_body ConfirmBookingRequest

The values to confirm booking with.

 required
query_params ConfirmBookingQueryParams

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Booking]

The confirmed Booking.
Source code in nylas/resources/bookings.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def confirm(
    self,
    booking_id: str,
    request_body: ConfirmBookingRequest,
    query_params: ConfirmBookingQueryParams = None,
    overrides: RequestOverrides = None,
) -> Response[Booking]:
    """
    Confirm a Booking.

    Args:
            booking_id: The identifier of the Booking to confirm.
            request_body: The values to confirm booking with.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

    Returns:
            The confirmed Booking.
    """

    return super().update(
        path=f"/v3/scheduling/bookings/{booking_id}",
        request_body=request_body,
        query_params=query_params,
        response_type=Booking,
        overrides=overrides,
    )

create(request_body, query_params=None, overrides=None)

Create a Booking.

Parameters:

Name Type Description Default
request_body CreateBookingRequest

The values to create booking with.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None
query_params CreateBookingQueryParams

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Booking]

The created Booking.
Source code in nylas/resources/bookings.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def create(
    self,
    request_body: CreateBookingRequest,
    query_params: CreateBookingQueryParams = None,
    overrides: RequestOverrides = None,
) -> Response[Booking]:
    """
    Create a Booking.

    Args:
            request_body: The values to create booking with.
            overrides: The request overrides to use for the request.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

    Returns:
            The created Booking.
    """

    return super().create(
        path="/v3/scheduling/bookings",
        request_body=request_body,
        query_params=query_params,
        response_type=Booking,
        overrides=overrides,
    )

destroy(booking_id, request_body, query_params=None, overrides=None)

Delete a Booking.

Parameters:

Name Type Description Default
booking_id str

The identifier of the Booking to delete.

 required
request_body DeleteBookingRequest

The reason to delete booking with.

 required
query_params DestroyBookingQueryParams

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
DeleteResponse

None.
Source code in nylas/resources/bookings.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def destroy(
    self,
    booking_id: str,
    request_body: DeleteBookingRequest,
    query_params: DestroyBookingQueryParams = None,
    overrides: RequestOverrides = None,
) -> DeleteResponse:
    """
    Delete a Booking.

    Args:
            booking_id: The identifier of the Booking to delete.
            request_body: The reason to delete booking with.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

    Returns:
            None.
    """

    return super().destroy(
        path=f"/v3/scheduling/bookings/{booking_id}",
        request_body=request_body,
        query_params=query_params,
        overrides=overrides,
    )

find(booking_id, query_params=None, overrides=None)

Return a Booking.

Parameters:

Name Type Description Default
identifier

The identifier of the Grant to act upon.

 required
booking_id str

The identifier of the Booking to get.

 required
query_params FindBookingQueryParams

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Booking]

The Booking.
Source code in nylas/resources/bookings.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
def find(
    self,
    booking_id: str,
    query_params: FindBookingQueryParams = None,
    overrides: RequestOverrides = None,
) -> Response[Booking]:
    """
    Return a Booking.

    Args:
            identifier: The identifier of the Grant to act upon.
            booking_id: The identifier of the Booking to get.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

    Returns:
            The Booking.
    """

    return super().find(
        path=f"/v3/scheduling/bookings/{booking_id}",
        query_params=query_params,
        response_type=Booking,
        overrides=overrides,
    )

reschedule(booking_id, request_body, query_params=None, overrides=None)

Reschedule a Booking.

Parameters:

Name Type Description Default
booking_id str

The identifier of the Booking to reschedule.

 required
request_body RescheduleBookingRequest

The values to reschedule booking with.

 required
query_params RescheduleBookingQueryParams

The query parameters to include in the request.

 None
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Booking]

The rescheduled Booking.
Source code in nylas/resources/bookings.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def reschedule(
    self,
    booking_id: str,
    request_body: RescheduleBookingRequest,
    query_params: RescheduleBookingQueryParams = None,
    overrides: RequestOverrides = None,
) -> Response[Booking]:
    """
    Reschedule a Booking.

    Args:
            booking_id: The identifier of the Booking to reschedule.
            request_body: The values to reschedule booking with.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

    Returns:
            The rescheduled Booking.
    """

    return super().patch(
        path=f"/v3/scheduling/bookings/{booking_id}",
        request_body=request_body,
        query_params=query_params,
        response_type=Booking,
        overrides=overrides,
    )