Class TenantSuppression

A suppressed recipient address.

Hierarchy (View Summary)

Entity<TenantSuppressionData>
- TenantSuppression

Index

Constructors

Properties

Accessors

data emailAddress isDeleted reason tenantId

Methods

delete reload update

Constructors

constructor

new TenantSuppression(
options: EntityOptions<TenantSuppressionData>,
): TenantSuppression
Parameters
- options: EntityOptions<TenantSuppressionData>
  The client, path, backing data, and delete state.
Returns TenantSuppression
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

emailAddress

get emailAddress(): string
The suppressed recipient address.

Returns string
- Defined in suppressions/entity.ts:21

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

reason

get reason(): SuppressionReason
Why the address is suppressed.

Returns SuppressionReason
- Defined in suppressions/entity.ts:26

tenantId

get tenantId(): string
The owning tenant identifier.

Returns string
- Defined in suppressions/entity.ts:16

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84

reload

reload(options?: RequestOptions): Promise<TenantSuppression>
Re-fetches this suppression and returns a fresh snapshot.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantSuppression>
A fresh suppression snapshot.

Throws
NotFoundException When the suppression is no longer visible.
- Defined in suppressions/entity.ts:39

update

update(
reason: SuppressionReason | null,
options?: RequestOptions,
): Promise<TenantSuppression>
Replaces the stored suppression reason.
Parameters
- reason: SuppressionReason | null
  The new reason, or null to clear it.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<TenantSuppression>
The updated suppression.
- Defined in suppressions/entity.ts:58