Class AutoReplyTemplatesClient

Tenant auto-reply template collection.

Index

Constructors

Methods

create get getByRef list

Constructors

constructor

new AutoReplyTemplatesClient(
options: AutoReplyTemplatesClientOptions,
): AutoReplyTemplatesClient
Parameters
- options: AutoReplyTemplatesClientOptions
  The underlying admin client and tenant slug.
Returns AutoReplyTemplatesClient
- Defined in auto-reply-templates/client.ts:93

Methods

create

create(
request: CreateAutoReplyTemplateRequest,
options?: RequestOptions,
): Promise<AutoReplyTemplate>
Creates an auto-reply template.
Parameters
- request: CreateAutoReplyTemplateRequest
  The template fields.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<AutoReplyTemplate>
The created template.

Throws
Error When a field fails local validation.
- Defined in auto-reply-templates/client.ts:160

get

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

Throws
NotFoundException When the template is not visible.
- Defined in auto-reply-templates/client.ts:126

getByRef

getByRef(
templateRef: string,
options?: RequestOptions,
): Promise<AutoReplyTemplate>
Gets a template by its immutable reference.
Parameters
- templateRef: string
  The template reference.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<AutoReplyTemplate>
The hydrated template.

Throws
NotFoundException When the template is not visible.
- Defined in auto-reply-templates/client.ts:142

list

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

Throws
ApiException When the control plane returns a non-success status.
- Defined in auto-reply-templates/client.ts:107