Class ListenersClient

Tenant listener collection.

Index

Constructors

Methods

create get list listMtaListeners listSubmissionListeners

Constructors

constructor

new ListenersClient(options: ListenersClientOptions): ListenersClient
Parameters
- options: ListenersClientOptions
  The underlying admin client and tenant slug.
Returns ListenersClient
- Defined in listeners/client.ts:92

Methods

create

create(
request: CreateListenerRequest,
options?: RequestOptions,
): Promise<Listener>
Creates a listener.
Parameters
- request: CreateListenerRequest
  The listener fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Listener>
The created listener.

Throws
Error When a field fails local validation.
- Defined in listeners/client.ts:147

get

get(listenerId: string, options?: RequestOptions): Promise<Listener>
Gets a listener by identifier.
Parameters
- listenerId: string
  The listener identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Listener>
The hydrated listener.

Throws
NotFoundException When the listener is not visible.
- Defined in listeners/client.ts:131

list

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

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

listMtaListeners

listMtaListeners(options?: ListOptions): Promise<Listener[]>
Lists every MTA listener.
Parameters
- options: ListOptions = {}
  Optional pagination and cancellation signal.
Returns Promise<Listener[]>
Every matching listener.
- Defined in listeners/client.ts:162

listSubmissionListeners

listSubmissionListeners(options?: ListOptions): Promise<Listener[]>
Lists every submission listener.
Parameters
- options: ListOptions = {}
  Optional pagination and cancellation signal.
Returns Promise<Listener[]>
Every matching listener.
- Defined in listeners/client.ts:174