Class DomainsClient

Tenant domain collection.

Every read and creation returns a hydrated Domain entity whose operations (replace, delete, listenerGrants) act on that domain.

Example

const paged = await ws.domains().list({ status: domainStatus.verified });
for await (const domain of paged) {
  console.log(domain.domainName);
}

Index

Constructors

Methods

create get list

Constructors

constructor

new DomainsClient(options: DomainsClientOptions): DomainsClient
Parameters
- options: DomainsClientOptions
  The underlying admin client and tenant slug.
Returns DomainsClient
- Defined in domains/client.ts:82

Methods

create

create(
    domainName: string,
    dmarcReportAddress?: string,
    options?: RequestOptions,
): Promise<Domain>
Onboards a domain for outbound sending.
Parameters
- domainName: string
  The domain name to onboard.
- OptionaldmarcReportAddress: string
  Optional DMARC aggregate report mailbox.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Domain>
The created domain.

Throws
ConflictException When the domain already exists.
- Defined in domains/client.ts:135

get

get(domainId: string, options?: RequestOptions): Promise<Domain>
Gets a domain by its identifier.
Parameters
- domainId: string
  The domain identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Domain>
The hydrated domain.

Throws
NotFoundException When the domain is not visible.
- Defined in domains/client.ts:118

list

list(options?: ListDomainsOptions): Promise<Paged<Domain>>
Lists domains with optional typed filters.

The first page is fetched eagerly; remaining pages are fetched lazily as the collection is iterated.
Parameters
- options: ListDomainsOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<Domain>>
A lazily paginating collection of domains.

Throws
Error When a filter is invalid, such as a search term shorter than 3 characters.

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