Class SendingDomainPoliciesClient

The sending-domain policy of a single listener.

This is a singleton: get reads it and update replaces the complete grant set atomically.

Index

Constructors

Methods

Constructors

constructor

new SendingDomainPoliciesClient(
options: SendingDomainPoliciesClientOptions,
): SendingDomainPoliciesClient
Parameters
- options: SendingDomainPoliciesClientOptions
  The underlying admin client and policy path.
Returns SendingDomainPoliciesClient
- Defined in listeners/sending-domain-policy.ts:44

Methods

get

get(options?: RequestOptions): Promise<SendingDomainPolicy>
Reads the effective policy.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SendingDomainPolicy>
The policy.
- Defined in listeners/sending-domain-policy.ts:57

update

update(
grants: readonly SendingDomainPolicyGrantRequest[],
options?: RequestOptions,
): Promise<SendingDomainPolicy>
Replaces the complete grant set.
Parameters
- grants: readonly SendingDomainPolicyGrantRequest[]
  The grants, or a replacement request.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SendingDomainPolicy>
The updated policy.
- Defined in listeners/sending-domain-policy.ts:72
update(
request: ReplaceSendingDomainPolicyRequest,
options?: RequestOptions,
): Promise<SendingDomainPolicy>
Replaces the complete grant set.
Parameters
- request: ReplaceSendingDomainPolicyRequest
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SendingDomainPolicy>
The updated policy.
- Defined in listeners/sending-domain-policy.ts:76