Class Notetakers

Nylas Notetakers API

The Nylas Notetakers API allows you to invite a Notetaker bot to meetings.

Hierarchy

Resource
- Notetakers

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch cancel create downloadMedia find leave list update

Constructors

constructor

new Notetakers(apiClient): Notetakers
Parameters
- apiClient: default
  
  client The configured Nylas API client
Returns Notetakers
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

cancel

cancel(params): Promise<NylasBaseResponse>
Cancel a scheduled Notetaker
Parameters
- params: CancelNotetakerParams & Overrides
  
  The parameters to cancel the Notetaker with
Returns Promise<NylasBaseResponse>
Promise resolving to the base response with request ID
- Defined in src/resources/notetakers.ts:168

create

create(params): Promise<NylasResponse<Notetaker>>
Invite a Notetaker to a meeting
Parameters
- params: CreateNotetakerParams & Overrides
  
  The parameters to create the Notetaker with
Returns Promise<NylasResponse<Notetaker>>
Promise resolving to the created Notetaker
- Defined in src/resources/notetakers.ts:111

downloadMedia

downloadMedia(params): Promise<NylasResponse<NotetakerMedia>>
Download media (recording and transcript) from a Notetaker session
Parameters
- params: DownloadNotetakerMediaParams & Overrides
  
  The parameters to download the Notetaker media
Returns Promise<NylasResponse<NotetakerMedia>>
Promise resolving to the media download response with URLs and sizes
- Defined in src/resources/notetakers.ts:207

find

find(params): Promise<NylasResponse<Notetaker>>
Return a single Notetaker
Parameters
- params: FindNotetakerParams & Overrides
  
  The parameters to find the Notetaker with
Returns Promise<NylasResponse<Notetaker>>
Promise resolving to the Notetaker
- Defined in src/resources/notetakers.ts:130

leave

leave(params): Promise<NylasResponse<NotetakerLeaveResponse>>
Remove a Notetaker from a meeting
Parameters
- params: LeaveNotetakerParams & Overrides
  
  The parameters to remove the Notetaker from the meeting
Returns Promise<NylasResponse<NotetakerLeaveResponse>>
Promise resolving to a response containing the Notetaker ID and a message
- Defined in src/resources/notetakers.ts:186

list

list(params): AsyncListResponse<ListNotetakersResponse>
Return all Notetakers
Parameters
- params: ListNotetakersParams & Overrides
  
  The parameters to list Notetakers with
Returns AsyncListResponse<ListNotetakersResponse>
The list of Notetakers
- Defined in src/resources/notetakers.ts:90

update

update(params): Promise<NylasResponse<Notetaker>>
Update a Notetaker
Parameters
- params: UpdateNotetakerParams & Overrides
  
  The parameters to update the Notetaker with
Returns Promise<NylasResponse<Notetaker>>
Promise resolving to the updated Notetaker
- Defined in src/resources/notetakers.ts:148

Generated using TypeDoc