Class Applications

Nylas Applications API

This endpoint allows for getting application details as well as redirect URI operations.

Index

Constructors

constructor

new Applications(apiClient: APIClient): Applications
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Applications
Overrides Resource.constructor
- Defined in src/resources/applications.ts:33

Properties

`Protected`apiClient

apiClient: APIClient

redirectUris

redirectUris: RedirectUris

Access the collection of redirect URI related API endpoints.

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

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

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

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

`Protected`_getStream

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

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

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

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

getDetails

getDetails(
__namedParameters?: Overrides,
): Promise<NylasResponse<ApplicationDetails>>
Get application details
Parameters
- __namedParameters: Overrides = {}
Returns Promise<NylasResponse<ApplicationDetails>>
The application details
- Defined in src/resources/applications.ts:42

update

update(
__namedParameters: UpdateApplicationParams & Overrides,
): Promise<NylasResponse<ApplicationDetails>>
Update application details.

Each supplied nested object is a full replace, not a deep merge. Callback URIs cannot be updated here — manage them via redirectUris.
Parameters
- __namedParameters: UpdateApplicationParams & Overrides
Returns Promise<NylasResponse<ApplicationDetails>>
The updated application details
- Defined in src/resources/applications.ts:58

Class Applications

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Applications

Properties

ProtectedapiClient

redirectUris

Methods

Protected_create

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_destroy

Type Parameters

Parameters

Returns Promise<T>

Protected_find

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_getRaw

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Protected_getStream

Parameters

Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

Protected_list

Type Parameters

Parameters

Returns AsyncListResponse<T>

Protected_update

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_updatePatch

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

getDetails

Parameters

Returns Promise<NylasResponse<ApplicationDetails>>

update

Parameters

Returns Promise<NylasResponse<ApplicationDetails>>

Settings

On This Page

`Protected`apiClient

`Protected`_create

`Protected`_destroy

`Protected`_find

`Protected`_getRaw

`Protected`_getStream

`Protected`_list

`Protected`_update

`Protected`_updatePatch