Class Rules

Nylas Agent Account Rules API

Rules define inbound and outbound filtering logic for Agent Accounts.

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

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

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

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

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

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

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

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

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

create

create(
__namedParameters: CreateRuleParams & Overrides,
): Promise<NylasResponse<Rule>>
Create a rule.
Parameters
- __namedParameters: CreateRuleParams & Overrides
Returns Promise<NylasResponse<Rule>>
The created rule.
- Defined in src/resources/rules.ts:105

destroy

destroy(
__namedParameters: DestroyRuleParams & Overrides,
): Promise<NylasBaseResponse>
Delete a rule.
Parameters
- __namedParameters: DestroyRuleParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response.
- Defined in src/resources/rules.ts:136

find

find(
__namedParameters: FindRuleParams & Overrides,
): Promise<NylasResponse<Rule>>
Return a rule.
Parameters
- __namedParameters: FindRuleParams & Overrides
Returns Promise<NylasResponse<Rule>>
The rule.
- Defined in src/resources/rules.ts:91

list

list(
__namedParameters?: ListRulesParams & Overrides,
): AsyncListResponse<NylasListResponse<Rule>>
Return all rules.
Parameters
- __namedParameters: ListRulesParams & Overrides = {}
Returns AsyncListResponse<NylasListResponse<Rule>>
The list of rules.
- Defined in src/resources/rules.ts:74

listEvaluations

listEvaluations(
__namedParameters: ListRuleEvaluationsParams & Overrides,
): AsyncListResponse<NylasListResponse<RuleEvaluation>>
Return rule evaluation records for a grant.
Parameters
- __namedParameters: ListRuleEvaluationsParams & Overrides
Returns AsyncListResponse<NylasListResponse<RuleEvaluation>>
The list of rule evaluation records.
- Defined in src/resources/rules.ts:150

update

update(
__namedParameters: UpdateRuleParams & Overrides,
): Promise<NylasResponse<Rule>>
Update a rule.
Parameters
- __namedParameters: UpdateRuleParams & Overrides
Returns Promise<NylasResponse<Rule>>
The updated rule.
- Defined in src/resources/rules.ts:120