Class Grants

Nylas Grants API

The Nylas Grants API allows for the management of grants.

Index

Constructors

Properties

Methods

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

Constructors

constructor

new Grants(apiClient: APIClient): Grants
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Grants
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:52

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

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

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

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

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

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

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

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

destroy

destroy(
__namedParameters: DestroyGrantParams & Overrides,
): Promise<NylasBaseResponse>
Delete a Grant
Parameters
- __namedParameters: DestroyGrantParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response
- Defined in src/resources/grants.ts:103

find

find(
__namedParameters: FindGrantParams & Overrides,
): Promise<NylasResponse<Grant>>
Return a Grant
Parameters
- __namedParameters: FindGrantParams & Overrides
Returns Promise<NylasResponse<Grant>>
The Grant
- Defined in src/resources/grants.ts:73

list

list(
__namedParameters?: Overrides & ListGrantsParams,
_queryParams?: ListQueryParams,
): Promise<NylasListResponse<Grant>>
Return all Grants
Parameters
- __namedParameters: Overrides & ListGrantsParams = {}
- Optional_queryParams: ListQueryParams
  
  Deprecated
  Use queryParams instead.
Returns Promise<NylasListResponse<Grant>>
The list of Grants
- Defined in src/resources/grants.ts:55

update

update(
__namedParameters: UpdateGrantParams & Overrides,
): Promise<NylasResponse<Grant>>
Update a Grant
Parameters
- __namedParameters: UpdateGrantParams & Overrides
Returns Promise<NylasResponse<Grant>>
The updated Grant
- Defined in src/resources/grants.ts:87