Class EmailTemplates

Index

Constructors

constructor

new EmailTemplates(_options: EmailTemplates.Options): EmailTemplates
Parameters
- _options: EmailTemplates.Options
Returns EmailTemplates

Methods

create

create(
request: Management.CreateEmailTemplateRequestContent,
requestOptions?: EmailTemplates.RequestOptions,
): HttpResponsePromise<CreateEmailTemplateResponseContent>
Create an email template.
Parameters
- request: Management.CreateEmailTemplateRequestContent
- OptionalrequestOptions: EmailTemplates.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateEmailTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.emailTemplates.create({
        template: "verify_email"
    })
```

get

get(
templateName: Management.EmailTemplateNameEnum,
requestOptions?: EmailTemplates.RequestOptions,
): HttpResponsePromise<GetEmailTemplateResponseContent>
Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, and async_approval. The names change_password, and password_reset are also supported for legacy scenarios.
Parameters
- templateName: Management.EmailTemplateNameEnum
  Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).
- OptionalrequestOptions: EmailTemplates.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetEmailTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.emailTemplates.get("verify_email")
```

set

set(
    templateName: Management.EmailTemplateNameEnum,
    request: Management.SetEmailTemplateRequestContent,
    requestOptions?: EmailTemplates.RequestOptions,
): HttpResponsePromise<SetEmailTemplateResponseContent>
Update an email template.
Parameters
- templateName: Management.EmailTemplateNameEnum
  Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).
- request: Management.SetEmailTemplateRequestContent
- OptionalrequestOptions: EmailTemplates.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<SetEmailTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.emailTemplates.set("verify_email", {
        template: "verify_email"
    })
```

update

update(
    templateName: Management.EmailTemplateNameEnum,
    request?: Management.UpdateEmailTemplateRequestContent,
    requestOptions?: EmailTemplates.RequestOptions,
): HttpResponsePromise<UpdateEmailTemplateResponseContent>
Modify an email template.
Parameters
- templateName: Management.EmailTemplateNameEnum
  Template name. Can be verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, async_approval, change_password (legacy), or password_reset (legacy).
- request: Management.UpdateEmailTemplateRequestContent = {}
- OptionalrequestOptions: EmailTemplates.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateEmailTemplateResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.emailTemplates.update("verify_email")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: EmailTemplates.Options

Class EmailTemplates

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns EmailTemplates

Methods

create

Parameters

Returns HttpResponsePromise<CreateEmailTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetEmailTemplateResponseContent>

Throws

Throws

Throws

Throws

Example

set

Parameters

Returns HttpResponsePromise<SetEmailTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateEmailTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options