Class Events

Nylas Events API

The Nylas Events API allows you to create, update, and delete events on user calendars.

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch create destroy find list listImportEvents sendRsvp update

Constructors

constructor

new Events(apiClient: APIClient): Events
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Events
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:170

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:184

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:144

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:199

`Protected`_getStream

_getStream(__namedParameters: FindParams<void>): Promise<ReadableStream>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:212

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:124

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:174

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:178

create

create(
__namedParameters: CreateEventParams & Overrides,
): Promise<NylasResponse<Event>>
Create an Event
Parameters
- __namedParameters: CreateEventParams & Overrides
Returns Promise<NylasResponse<Event>>
The created Event
- Defined in src/resources/events.ts:168

destroy

destroy(
__namedParameters: DestroyEventParams & Overrides,
): Promise<NylasBaseResponse>
Delete an Event
Parameters
- __namedParameters: DestroyEventParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response
- Defined in src/resources/events.ts:208

find

find(
__namedParameters: FindEventParams & Overrides,
): Promise<NylasResponse<Event>>
Return an Event
Parameters
- __namedParameters: FindEventParams & Overrides
Returns Promise<NylasResponse<Event>>
The Event
- Defined in src/resources/events.ts:148

list

list(
__namedParameters: ListEventParams & Overrides,
): AsyncListResponse<NylasListResponse<Event>>
Return all Events
Parameters
- __namedParameters: ListEventParams & Overrides
Returns AsyncListResponse<NylasListResponse<Event>>
The list of Events
- Defined in src/resources/events.ts:111

listImportEvents

listImportEvents(
__namedParameters: ListImportEventParams & Overrides,
): AsyncListResponse<NylasListResponse<Event>>
(Beta) Import events from a 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
- __namedParameters: ListImportEventParams & Overrides
Returns AsyncListResponse<NylasListResponse<Event>>
The list of imported Events
- Defined in src/resources/events.ts:128

sendRsvp

sendRsvp(
__namedParameters: SendRsvpParams & Overrides,
): Promise<SendRsvpResponse>
Send RSVP. Allows users to respond to events they have been added to as an attendee. You cannot send RSVP as an event owner/organizer. You cannot directly update events as an invitee, since you are not the owner/organizer.
Parameters
- __namedParameters: SendRsvpParams & Overrides
Returns Promise<SendRsvpResponse>
The send-rsvp response
- Defined in src/resources/events.ts:230

update

update(
__namedParameters: UpdateEventParams & Overrides,
): Promise<NylasResponse<Event>>
Update an Event
Parameters
- __namedParameters: UpdateEventParams & Overrides
Returns Promise<NylasResponse<Event>>
The updated Event
- Defined in src/resources/events.ts:186

Class Events

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Events

Properties

ProtectedapiClient

Methods

Protected_create

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_destroy

Type Parameters

Parameters

Returns Promise<T>

Protected_find

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_getRaw

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Protected_getStream

Parameters

Returns Promise<ReadableStream>

Protected_list

Type Parameters

Parameters

Returns AsyncListResponse<T>

Protected_update

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_updatePatch

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

create

Parameters

Returns Promise<NylasResponse<Event>>

destroy

Parameters

Returns Promise<NylasBaseResponse>

find

Parameters

Returns Promise<NylasResponse<Event>>

list

Parameters

Returns AsyncListResponse<NylasListResponse<Event>>

listImportEvents

Parameters

Returns AsyncListResponse<NylasListResponse<Event>>

sendRsvp

Parameters

Returns Promise<SendRsvpResponse>

update

Parameters

Returns Promise<NylasResponse<Event>>

Settings

On This Page

`Protected`apiClient

`Protected`_create

`Protected`_destroy

`Protected`_find

`Protected`_getRaw

`Protected`_getStream

`Protected`_list

`Protected`_update

`Protected`_updatePatch