Class Policies

Nylas Agent Account Policies API

Policies define limits, spam settings, options, and linked rules for Agent Accounts.

Index

Constructors

Properties

Methods

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

Constructors

constructor

new Policies(apiClient: APIClient): Policies
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Policies
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: CreatePolicyParams & Overrides,
): Promise<NylasResponse<Policy>>
Create a policy.
Parameters
- __namedParameters: CreatePolicyParams & Overrides
Returns Promise<NylasResponse<Policy>>
The created policy.
- Defined in src/resources/policies.ts:94

destroy

destroy(
__namedParameters: DestroyPolicyParams & Overrides,
): Promise<NylasBaseResponse>
Delete a policy.
Parameters
- __namedParameters: DestroyPolicyParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response.
- Defined in src/resources/policies.ts:125

find

find(
__namedParameters: FindPolicyParams & Overrides,
): Promise<NylasResponse<Policy>>
Return a policy.
Parameters
- __namedParameters: FindPolicyParams & Overrides
Returns Promise<NylasResponse<Policy>>
The policy.
- Defined in src/resources/policies.ts:80

list

list(
__namedParameters?: ListPoliciesParams & Overrides,
): AsyncListResponse<NylasListResponse<Policy>>
Return all policies.
Parameters
- __namedParameters: ListPoliciesParams & Overrides = {}
Returns AsyncListResponse<NylasListResponse<Policy>>
The list of policies.
- Defined in src/resources/policies.ts:63

update

update(
__namedParameters: UpdatePolicyParams & Overrides,
): Promise<NylasResponse<Policy>>
Update a policy.
Parameters
- __namedParameters: UpdatePolicyParams & Overrides
Returns Promise<NylasResponse<Policy>>
The updated policy.
- Defined in src/resources/policies.ts:109