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.

Hierarchy

Resource
- Calendars

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

destroy

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

find

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

getAvailability

getAvailability(__namedParameters): 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:181

getFreeBusy

getFreeBusy(__namedParameters): 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:199

list

list(__namedParameters): 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:100

update

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

Generated using TypeDoc