Class Bookings

Hierarchy

Resource
- Bookings

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch confirm create destroy find reschedule

Constructors

constructor

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

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:170

`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:184

`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:144

`Protected` _getRaw

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

`Protected` _getStream

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

`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:124

`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:174

`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:178

confirm

confirm(__namedParameters): Promise<NylasResponse<Booking>>
Confirm a Booking
Parameters
- __namedParameters: ConfirmBookingParams & Overrides
Returns Promise<NylasResponse<Booking>>
The confirmed Booking
- Defined in src/resources/bookings.ts:115

create

create(__namedParameters): Promise<NylasResponse<Booking>>
Create a Booking
Parameters
- __namedParameters: CreateBookingParams & Overrides
Returns Promise<NylasResponse<Booking>>
The created booking
- Defined in src/resources/bookings.ts:98

destroy

destroy(__namedParameters): Promise<NylasBaseResponse>
Delete a Booking
Parameters
- __namedParameters: DestroyBookingParams & Overrides
Returns Promise<NylasBaseResponse>
The deleted Booking
- Defined in src/resources/bookings.ts:151

find

find(__namedParameters): Promise<NylasResponse<Booking>>
Return a Booking
Parameters
- __namedParameters: FindBookingParams & Overrides
Returns Promise<NylasResponse<Booking>>
The booking
- Defined in src/resources/bookings.ts:82

reschedule

reschedule(__namedParameters): Promise<NylasResponse<Booking>>
Reschedule a Booking
Parameters
- __namedParameters: RescheduleBookingParams & Overrides
Returns Promise<NylasResponse<Booking>>
The rescheduled Booking
- Defined in src/resources/bookings.ts:133

Generated using TypeDoc