Class Calendars

Nylas Calendar API

The Nylas calendar API allows you to create new calendars or manage existing ones. A calendar can be accessed by one, or several people, and can contain events.

Index

Constructors

Properties

Methods

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

Constructors

constructor

new Calendars(apiClient: APIClient): Calendars
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Calendars
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: CreateCalendarParams & Overrides,
): Promise<NylasResponse<Calendar>>
Create a Calendar
Parameters
- __namedParameters: CreateCalendarParams & Overrides
Returns Promise<NylasResponse<Calendar>>
The created calendar
- Defined in src/resources/calendars.ts:137

destroy

destroy(
__namedParameters: DestroyCalendarParams & Overrides,
): Promise<NylasBaseResponse>
Delete a Calendar
Parameters
- __namedParameters: DestroyCalendarParams & Overrides
Returns Promise<NylasBaseResponse>
The deleted Calendar
- Defined in src/resources/calendars.ts:173

find

find(
__namedParameters: FindCalendarParams & Overrides,
): Promise<NylasResponse<Calendar>>
Return a Calendar
Parameters
- __namedParameters: FindCalendarParams & Overrides
Returns Promise<NylasResponse<Calendar>>
The calendar
- Defined in src/resources/calendars.ts:119

getAvailability

getAvailability(
__namedParameters: GetAvailabilityParams & Overrides,
): Promise<NylasResponse<GetAvailabilityResponse>>
Get Availability for a given account / accounts
Parameters
- __namedParameters: GetAvailabilityParams & Overrides
Returns Promise<NylasResponse<GetAvailabilityResponse>>
The availability response
- Defined in src/resources/calendars.ts:191

getFreeBusy

getFreeBusy(
__namedParameters: GetFreeBusyParams & Overrides,
): Promise<NylasResponse<GetFreeBusyResponse[]>>
Get the free/busy schedule for a list of email addresses
Parameters
- __namedParameters: GetFreeBusyParams & Overrides
Returns Promise<NylasResponse<GetFreeBusyResponse[]>>
The free/busy response
- Defined in src/resources/calendars.ts:209

list

list(
__namedParameters: ListCalendersParams & ListCalendersQueryParams & Overrides,
): AsyncListResponse<NylasListResponse<Calendar>>
Return all Calendars
Parameters
- __namedParameters: ListCalendersParams & ListCalendersQueryParams & Overrides
Returns AsyncListResponse<NylasListResponse<Calendar>>
A list of calendars
- Defined in src/resources/calendars.ts:101

update

update(
__namedParameters: UpdateCalendarParams & Overrides,
): Promise<NylasResponse<Calendar>>
Update a Calendar
Parameters
- __namedParameters: UpdateCalendarParams & Overrides
Returns Promise<NylasResponse<Calendar>>
The updated Calendar
- Defined in src/resources/calendars.ts:153