Class AutoReplyTemplate

An auto-reply template.

Hierarchy (View Summary)

Entity<AutoReplyTemplateData>
- AutoReplyTemplate

Index

Constructors

Properties

Accessors

content data displayName fromAddress id isActive isDeleted senderReadiness templateRef tenantId

Methods

delete reload setActive update

Constructors

constructor

new AutoReplyTemplate(
options: EntityOptions<AutoReplyTemplateData>,
): AutoReplyTemplate
Parameters
- options: EntityOptions<AutoReplyTemplateData>
  The client, path, backing data, and delete state.
Returns AutoReplyTemplate
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

content

get content(): AutoReplyTemplateContentSummary
Content summary.

Returns AutoReplyTemplateContentSummary
- Defined in auto-reply-templates/entity.ts:79

data

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

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

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in auto-reply-templates/entity.ts:64

fromAddress

get fromAddress(): string
Sender address used for replies.

Returns string
- Defined in auto-reply-templates/entity.ts:69

id

get id(): string
Template identifier.

Returns string
- Defined in auto-reply-templates/entity.ts:49

isActive

get isActive(): boolean
Whether the template is active.

Returns boolean
- Defined in auto-reply-templates/entity.ts:74

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

senderReadiness

get senderReadiness(): AutoReplySenderReadiness
Sender readiness.

Returns AutoReplySenderReadiness
- Defined in auto-reply-templates/entity.ts:84

templateRef

get templateRef(): string
Immutable template reference.

Returns string
- Defined in auto-reply-templates/entity.ts:59

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in auto-reply-templates/entity.ts:54

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<AutoReplyTemplate>
Re-fetches this template.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<AutoReplyTemplate>
A fresh snapshot.

Throws
NotFoundException When the template is no longer visible.
- Defined in auto-reply-templates/entity.ts:97

setActive

setActive(
isActive: boolean,
options?: RequestOptions,
): Promise<AutoReplyTemplate>
Activates or deactivates the template.
Parameters
- isActive: boolean
  Whether the template should be active.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<AutoReplyTemplate>
The updated template.
- Defined in auto-reply-templates/entity.ts:157

update

update(
request: UpdateAutoReplyTemplateRequest,
options?: RequestOptions,
): Promise<AutoReplyTemplate>
Replaces all writable template fields.
Parameters
- request: UpdateAutoReplyTemplateRequest
  The new template fields; null bodies clear them.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<AutoReplyTemplate>
The updated template.

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