Class Grants

Nylas Grants API

The Nylas Grants API allows for the management of grants.

Hierarchy

Resource
- Grants

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` apiClient

apiClient: default

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

destroy

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

find

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

list

list(__namedParameters?, queryParams?): Promise<NylasListResponse<Grant>>
Return all Grants
Parameters
- __namedParameters: Overrides = {}
- Optional queryParams: ListGrantsQueryParams
Returns Promise<NylasListResponse<Grant>>
The list of Grants
- Defined in src/resources/grants.ts:47

update

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

Generated using TypeDoc