Class Events

Nylas Events API

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

Hierarchy

Resource
- Events

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` apiClient

apiClient: default

Methods

`Protected` _create

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

`Protected` _destroy

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

`Protected` _find

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

`Protected` _getRaw

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

`Protected` _getStream

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

`Protected` _list

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

`Protected` _update

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

`Protected` _updatePatch

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

create

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

destroy

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

find

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

list

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

sendRsvp

sendRsvp(__namedParameters): 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:189

update

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

Generated using TypeDoc