Skip to content

events

Events

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Events API

The Events API allows you to find, create, update, and delete events on any calendar on your Nylas account.

Source code in nylas/resources/events.py 
 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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
class Events(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Nylas Events API

    The Events API allows you to find, create, update, and delete events on any calendar on your Nylas account.
    """

    def list(
        self,
        identifier: str,
        query_params: ListEventQueryParams,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Event]:
        """
        Return all Events.

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

        Returns:
            The list of Events.
        """

        return super().list(
            path=f"/v3/grants/{identifier}/events",
            response_type=Event,
            query_params=query_params,
            overrides=overrides,
        )

    def list_import_events(
        self,
        identifier: str,
        query_params: ListImportEventsQueryParams,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Event]:
        """
        Returns a list of recurring events, recurring event exceptions, and 
        single events from the specified calendar within a given time frame. 
        This is useful when you want to import, store, and synchronize events 
        from the time frame to your application

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

        Returns:
            The list of imported Events.
        """

        return super().list(
            path=f"/v3/grants/{identifier}/events/import",
            response_type=Event,
            query_params=query_params,
            overrides=overrides,
        )

    def find(
        self,
        identifier: str,
        event_id: str,
        query_params: FindEventQueryParams,
        overrides: RequestOverrides = None,
    ) -> Response[Event]:
        """
        Return an Event.

        Args:
            identifier: The identifier of the Grant to act upon.
            event_id: The ID of the Event to retrieve.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The Event.
        """

        return super().find(
            path=f"/v3/grants/{identifier}/events/{event_id}",
            response_type=Event,
            query_params=query_params,
            overrides=overrides,
        )

    def create(
        self,
        identifier: str,
        request_body: CreateEventRequest,
        query_params: CreateEventQueryParams,
        overrides: RequestOverrides = None,
    ) -> Response[Event]:
        """
        Create an Event.

        Args:
            identifier: The identifier of the Grant to act upon.
            request_body: The values to create the Event with.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The created Event.
        """

        return super().create(
            path=f"/v3/grants/{identifier}/events",
            response_type=Event,
            request_body=request_body,
            query_params=query_params,
            overrides=overrides,
        )

    def update(
        self,
        identifier: str,
        event_id: str,
        request_body: UpdateEventRequest,
        query_params: UpdateEventQueryParams,
        overrides: RequestOverrides = None,
    ) -> Response[Event]:
        """
        Update an Event.

        Args:
            identifier: The identifier of the Grant to act upon.
            event_id: The ID of the Event to update.
            request_body: The values to update the Event with.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The updated Event.
        """

        return super().update(
            path=f"/v3/grants/{identifier}/events/{event_id}",
            response_type=Event,
            request_body=request_body,
            query_params=query_params,
            overrides=overrides,
        )

    def destroy(
        self,
        identifier: str,
        event_id: str,
        query_params: DestroyEventQueryParams,
        overrides: RequestOverrides = None,
    ) -> DeleteResponse:
        """
        Delete an Event.

        Args:
            identifier: The identifier of the Grant to act upon.
            event_id: The ID of the Event to delete.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The deletion response.
        """

        return super().destroy(
            path=f"/v3/grants/{identifier}/events/{event_id}",
            query_params=query_params,
            overrides=overrides,
        )

    def send_rsvp(
        self,
        identifier: str,
        event_id: str,
        request_body: SendRsvpRequest,
        query_params: SendRsvpQueryParams,
        overrides: RequestOverrides = None,
    ) -> RequestIdOnlyResponse:
        """
        Send an RSVP for an event.

        Args:
            identifier: The grant ID or email account to send RSVP for.
            event_id: The event ID to send RSVP for.
            query_params: The query parameters to send to the API.
            request_body: The request body to send to the API.
            overrides: The request overrides to use for the request.

        Returns:
            Response: The RSVP response from the API.
        """
        json_response, headers = self._http_client._execute(
            method="POST",
            path=f"/v3/grants/{identifier}/events/{event_id}/send-rsvp",
            query_params=query_params,
            request_body=request_body,
            overrides=overrides,
        )

        return RequestIdOnlyResponse.from_dict(json_response, headers)

    def batch(
        self,
        identifier: str,
        request_body: BatchEventsRequest,
        query_params: BatchEventsQueryParams,
        overrides: RequestOverrides = None,
    ) -> Response[List[BatchEventResult]]:
        """
        Create, update, and delete Events in a single request.
        Only Google and Microsoft grants support batch operations.

        The response has one result for each operation, in the same order as the operations.
        If some or all of the operations fail, the API returns HTTP 207 and this method still
        returns the results, so check the status and error of each result.
        If the request itself is invalid, the API returns HTTP 400, runs none of the operations,
        and this method raises a NylasApiError.

        Args:
            identifier: The identifier of the Grant to act upon.
            request_body: The operations to run.
            query_params: The query parameters to include in the request. They apply to every operation.
            overrides: The request overrides to use for the request.

        Returns:
            The result of each operation.
        """
        json_response, headers = self._http_client._execute(
            "POST",
            f"/v3/grants/{identifier}/events/batch",
            None,
            query_params,
            request_body,
            overrides=overrides,
        )

        results = [
            BatchEventResult.from_dict(item, infer_missing=True)
            for item in json_response["data"]
        ]

        return Response(results, json_response["request_id"], headers)

batch(identifier, request_body, query_params, overrides=None)

Create, update, and delete Events in a single request. Only Google and Microsoft grants support batch operations.

The response has one result for each operation, in the same order as the operations. If some or all of the operations fail, the API returns HTTP 207 and this method still returns the results, so check the status and error of each result. If the request itself is invalid, the API returns HTTP 400, runs none of the operations, and this method raises a NylasApiError.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
request_body BatchEventsRequest

The operations to run.

 required
query_params BatchEventsQueryParams

The query parameters to include in the request. They apply to every operation.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[List[BatchEventResult]]

The result of each operation.
Source code in nylas/resources/events.py 
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
def batch(
    self,
    identifier: str,
    request_body: BatchEventsRequest,
    query_params: BatchEventsQueryParams,
    overrides: RequestOverrides = None,
) -> Response[List[BatchEventResult]]:
    """
    Create, update, and delete Events in a single request.
    Only Google and Microsoft grants support batch operations.

    The response has one result for each operation, in the same order as the operations.
    If some or all of the operations fail, the API returns HTTP 207 and this method still
    returns the results, so check the status and error of each result.
    If the request itself is invalid, the API returns HTTP 400, runs none of the operations,
    and this method raises a NylasApiError.

    Args:
        identifier: The identifier of the Grant to act upon.
        request_body: The operations to run.
        query_params: The query parameters to include in the request. They apply to every operation.
        overrides: The request overrides to use for the request.

    Returns:
        The result of each operation.
    """
    json_response, headers = self._http_client._execute(
        "POST",
        f"/v3/grants/{identifier}/events/batch",
        None,
        query_params,
        request_body,
        overrides=overrides,
    )

    results = [
        BatchEventResult.from_dict(item, infer_missing=True)
        for item in json_response["data"]
    ]

    return Response(results, json_response["request_id"], headers)

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

Create an Event.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
request_body CreateEventRequest

The values to create the Event with.

 required
query_params CreateEventQueryParams

The query parameters to include in the request.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Event]

The created Event.
Source code in nylas/resources/events.py 
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
def create(
    self,
    identifier: str,
    request_body: CreateEventRequest,
    query_params: CreateEventQueryParams,
    overrides: RequestOverrides = None,
) -> Response[Event]:
    """
    Create an Event.

    Args:
        identifier: The identifier of the Grant to act upon.
        request_body: The values to create the Event with.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The created Event.
    """

    return super().create(
        path=f"/v3/grants/{identifier}/events",
        response_type=Event,
        request_body=request_body,
        query_params=query_params,
        overrides=overrides,
    )

destroy(identifier, event_id, query_params, overrides=None)

Delete an Event.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
event_id str

The ID of the Event to delete.

 required
query_params DestroyEventQueryParams

The query parameters to include in the request.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/events.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def destroy(
    self,
    identifier: str,
    event_id: str,
    query_params: DestroyEventQueryParams,
    overrides: RequestOverrides = None,
) -> DeleteResponse:
    """
    Delete an Event.

    Args:
        identifier: The identifier of the Grant to act upon.
        event_id: The ID of the Event to delete.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The deletion response.
    """

    return super().destroy(
        path=f"/v3/grants/{identifier}/events/{event_id}",
        query_params=query_params,
        overrides=overrides,
    )

find(identifier, event_id, query_params, overrides=None)

Return an Event.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
event_id str

The ID of the Event to retrieve.

 required
query_params FindEventQueryParams

The query parameters to include in the request.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Event]

The Event.
Source code in nylas/resources/events.py 
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
def find(
    self,
    identifier: str,
    event_id: str,
    query_params: FindEventQueryParams,
    overrides: RequestOverrides = None,
) -> Response[Event]:
    """
    Return an Event.

    Args:
        identifier: The identifier of the Grant to act upon.
        event_id: The ID of the Event to retrieve.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The Event.
    """

    return super().find(
        path=f"/v3/grants/{identifier}/events/{event_id}",
        response_type=Event,
        query_params=query_params,
        overrides=overrides,
    )

list(identifier, query_params, overrides=None)

Return all Events.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
query_params ListEventQueryParams

The query parameters to include in the request.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
ListResponse[Event]

The list of Events.
Source code in nylas/resources/events.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def list(
    self,
    identifier: str,
    query_params: ListEventQueryParams,
    overrides: RequestOverrides = None,
) -> ListResponse[Event]:
    """
    Return all Events.

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

    Returns:
        The list of Events.
    """

    return super().list(
        path=f"/v3/grants/{identifier}/events",
        response_type=Event,
        query_params=query_params,
        overrides=overrides,
    )

list_import_events(identifier, query_params, overrides=None)

Returns a list of recurring events, recurring event exceptions, and single events from the specified calendar within a given time frame. This is useful when you want to import, store, and synchronize events from the time frame to your application

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
query_params ListImportEventsQueryParams

The query parameters to include in the request.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
ListResponse[Event]

The list of imported Events.
Source code in nylas/resources/events.py 
 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
def list_import_events(
    self,
    identifier: str,
    query_params: ListImportEventsQueryParams,
    overrides: RequestOverrides = None,
) -> ListResponse[Event]:
    """
    Returns a list of recurring events, recurring event exceptions, and 
    single events from the specified calendar within a given time frame. 
    This is useful when you want to import, store, and synchronize events 
    from the time frame to your application

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

    Returns:
        The list of imported Events.
    """

    return super().list(
        path=f"/v3/grants/{identifier}/events/import",
        response_type=Event,
        query_params=query_params,
        overrides=overrides,
    )

send_rsvp(identifier, event_id, request_body, query_params, overrides=None)

Send an RSVP for an event.

Parameters:

Name Type Description Default
identifier str

The grant ID or email account to send RSVP for.

 required
event_id str

The event ID to send RSVP for.

 required
query_params SendRsvpQueryParams

The query parameters to send to the API.

 required
request_body SendRsvpRequest

The request body to send to the API.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Name Type Description
Response RequestIdOnlyResponse

The RSVP response from the API.
Source code in nylas/resources/events.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
def send_rsvp(
    self,
    identifier: str,
    event_id: str,
    request_body: SendRsvpRequest,
    query_params: SendRsvpQueryParams,
    overrides: RequestOverrides = None,
) -> RequestIdOnlyResponse:
    """
    Send an RSVP for an event.

    Args:
        identifier: The grant ID or email account to send RSVP for.
        event_id: The event ID to send RSVP for.
        query_params: The query parameters to send to the API.
        request_body: The request body to send to the API.
        overrides: The request overrides to use for the request.

    Returns:
        Response: The RSVP response from the API.
    """
    json_response, headers = self._http_client._execute(
        method="POST",
        path=f"/v3/grants/{identifier}/events/{event_id}/send-rsvp",
        query_params=query_params,
        request_body=request_body,
        overrides=overrides,
    )

    return RequestIdOnlyResponse.from_dict(json_response, headers)

update(identifier, event_id, request_body, query_params, overrides=None)

Update an Event.

Parameters:

Name Type Description Default
identifier str

The identifier of the Grant to act upon.

 required
event_id str

The ID of the Event to update.

 required
request_body UpdateEventRequest

The values to update the Event with.

 required
query_params UpdateEventQueryParams

The query parameters to include in the request.

 required
overrides RequestOverrides

The request overrides to use for the request.

 None

Returns:

Type Description
Response[Event]

The updated Event.
Source code in nylas/resources/events.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def update(
    self,
    identifier: str,
    event_id: str,
    request_body: UpdateEventRequest,
    query_params: UpdateEventQueryParams,
    overrides: RequestOverrides = None,
) -> Response[Event]:
    """
    Update an Event.

    Args:
        identifier: The identifier of the Grant to act upon.
        event_id: The ID of the Event to update.
        request_body: The values to update the Event with.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The updated Event.
    """

    return super().update(
        path=f"/v3/grants/{identifier}/events/{event_id}",
        response_type=Event,
        request_body=request_body,
        query_params=query_params,
        overrides=overrides,
    )