Class Connectors

Hierarchy

Resource
- Connectors

Index

Constructors

Properties

apiClient credentials

Methods

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

Constructors

constructor

new Connectors(apiClient): Connectors
Parameters
- apiClient: default
  
  client The configured Nylas API client
Returns Connectors
Overrides Resource.constructor
- Defined in src/resources/connectors.ts:69

Properties

`Protected` apiClient

apiClient: default

credentials

credentials: Credentials

Access the Credentials API

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<Connector>>
Create a connector
Parameters
- __namedParameters: CreateConnectorParams & Overrides
Returns Promise<NylasResponse<Connector>>
The created connector
- Defined in src/resources/connectors.ts:109

destroy

destroy(__namedParameters): Promise<NylasBaseResponse>
Delete a connector
Parameters
- __namedParameters: DestroyConnectorParams & Overrides
Returns Promise<NylasBaseResponse>
The deleted connector
- Defined in src/resources/connectors.ts:140

find

find(__namedParameters): Promise<NylasResponse<Connector>>
Return a connector
Parameters
- __namedParameters: FindConnectorParams & Overrides
Returns Promise<NylasResponse<Connector>>
The connector
- Defined in src/resources/connectors.ts:95

list

list(__namedParameters): AsyncListResponse<NylasListResponse<Connector>>
Return all connectors
Parameters
- __namedParameters: ListConnectorsParams & ListQueryParams & Overrides
Returns AsyncListResponse<NylasListResponse<Connector>>
A list of connectors
- Defined in src/resources/connectors.ts:78

update

update(__namedParameters): Promise<NylasResponse<Connector>>
Update a connector
Parameters
- __namedParameters: UpdateConnectorParams & Overrides
Returns Promise<NylasResponse<Connector>>
The updated connector
- Defined in src/resources/connectors.ts:124

Generated using TypeDoc