Class Providers

Hierarchy

Resource
- Providers

Index

Constructors

Properties

apiClient clientId clientSecret

Methods

_create _destroy _find _list _update _updatePatch checkAuthCredentials detect list

Constructors

constructor

new Providers(apiClient, clientId, clientSecret): Providers
Parameters
- apiClient: default
- clientId: string
- clientSecret: string
Returns Providers
Overrides Resource.constructor
- Defined in src/resources/providers.ts:14

Properties

`Protected` apiClient

apiClient: default

clientId

clientId: string

clientSecret

clientSecret: string

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

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

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

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

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

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

`Private` checkAuthCredentials

checkAuthCredentials(): void
Returns void
- Defined in src/resources/providers.ts:20

detect

detect(params): Promise<NylasResponse<ProviderDetectResponse>>
Detects provider for passed email (if allProviderTypes set to true tries to detect provider based on all supported providers)
Parameters
- params: ProviderDetectParams
Returns Promise<NylasResponse<ProviderDetectResponse>>
Information about the passed provider email
- Defined in src/resources/providers.ts:45

list

list(): Promise<NylasListResponse<Provider>>
Lists created providers(integrations)

Returns Promise<NylasListResponse<Provider>>
List of created providers with type & settings if supported
- Defined in src/resources/providers.ts:30

Generated using TypeDoc