Class Contacts

Nylas Contacts API

The Nylas Contacts API allows you to create, update, and delete contacts.

Index

Constructors

Properties

Methods

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

Constructors

constructor

new Contacts(apiClient: APIClient): Contacts
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Contacts
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: CreateContactParams & Overrides,
): Promise<NylasResponse<Contact>>
Create a Contact
Parameters
- __namedParameters: CreateContactParams & Overrides
Returns Promise<NylasResponse<Contact>>
The created Contact
- Defined in src/resources/contacts.ts:122

destroy

destroy(
__namedParameters: DestroyContactParams & Overrides,
): Promise<NylasBaseResponse>
Delete a Contact
Parameters
- __namedParameters: DestroyContactParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response
- Defined in src/resources/contacts.ts:158

find

find(
__namedParameters: FindContactParams & Overrides,
): Promise<NylasResponse<Contact>>
Return a Contact
Parameters
- __namedParameters: FindContactParams & Overrides
Returns Promise<NylasResponse<Contact>>
The Contact
- Defined in src/resources/contacts.ts:102

groups

groups(
__namedParameters: ListContactGroupParams & Overrides,
): Promise<NylasListResponse<ContactGroup>>
Return a Contact Group
Parameters
- __namedParameters: ListContactGroupParams & Overrides
Returns Promise<NylasListResponse<ContactGroup>>
The list of Contact Groups
- Defined in src/resources/contacts.ts:176

list

list(
__namedParameters: ListContactParams & Overrides,
): AsyncListResponse<NylasListResponse<Contact>>
Return all Contacts
Parameters
- __namedParameters: ListContactParams & Overrides
Returns AsyncListResponse<NylasListResponse<Contact>>
The list of Contacts
- Defined in src/resources/contacts.ts:84

update

update(
__namedParameters: UpdateContactParams & Overrides,
): Promise<NylasResponse<Contact>>
Update a Contact
Parameters
- __namedParameters: UpdateContactParams & Overrides
Returns Promise<NylasResponse<Contact>>
The updated Contact
- Defined in src/resources/contacts.ts:138