Class InboundRoutesClient

Tenant inbound-route collection.

Index

Constructors

Methods

create get list

Constructors

constructor

new InboundRoutesClient(
options: InboundRoutesClientOptions,
): InboundRoutesClient
Parameters
- options: InboundRoutesClientOptions
  The underlying admin client and tenant slug.
Returns InboundRoutesClient
- Defined in inbound-routes/client.ts:50

Methods

create

create(
request: CreateInboundRouteRequest,
options?: RequestOptions,
): Promise<InboundRoute>
Creates an inbound route.
Parameters
- request: CreateInboundRouteRequest
  The MTA listener, recipient domain, and onboarding flag.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<InboundRoute>
The created route.

Throws
ConflictException When the route already exists.
- Defined in inbound-routes/client.ts:104

get

get(routeId: string, options?: RequestOptions): Promise<InboundRoute>
Gets an inbound route by identifier.
Parameters
- routeId: string
  The route identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<InboundRoute>
The hydrated route.

Throws
NotFoundException When the route is not visible.
- Defined in inbound-routes/client.ts:88

list

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

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