Class SuppressionsClient

Tenant suppression collection.

Index

Constructors

Methods

create get list

Constructors

constructor

new SuppressionsClient(options: SuppressionsClientOptions): SuppressionsClient
Parameters
- options: SuppressionsClientOptions
  The underlying admin client and tenant slug.
Returns SuppressionsClient
- Defined in suppressions/client.ts:50

Methods

create

create(
request: CreateTenantSuppressionRequest,
options?: RequestOptions,
): Promise<TenantSuppression>
Creates a suppression.
Parameters
- request: CreateTenantSuppressionRequest
  The address to suppress and, optionally, the reason.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantSuppression>
The created suppression.

Throws
ConflictException When the address is already suppressed.
- Defined in suppressions/client.ts:107

get

get(emailAddress: string, options?: RequestOptions): Promise<TenantSuppression>
Gets a suppression by recipient address.
Parameters
- emailAddress: string
  The suppressed address.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantSuppression>
The hydrated suppression.

Throws
NotFoundException When the suppression is not visible.
- Defined in suppressions/client.ts:91

list

list(options?: ListSuppressionsOptions): Promise<Paged<TenantSuppression>>
Lists suppressions with optional filters.
Parameters
- options: ListSuppressionsOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<TenantSuppression>>
A lazily paginating collection of suppressions.

Throws
ApiException When the control plane returns a non-success status.
- Defined in suppressions/client.ts:64