Class EmailTemplatesManager

Hierarchy

BaseAPI
- EmailTemplatesManager

Index

Constructors

constructor

new EmailTemplatesManager(configuration): EmailTemplatesManager
Parameters
- configuration: Configuration
Returns EmailTemplatesManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

create

create(bodyParameters, initOverrides?): Promise<ApiResponse<PostEmailTemplatesRequest>>
Create an email template. Create an email template

Throws
Parameters
- bodyParameters: PostEmailTemplatesRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostEmailTemplatesRequest>>
- Defined in src/management/__generated/managers/email-templates-manager.ts:84

get

get(requestParameters, initOverrides?): Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>
Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, and user_invitation. The names change_password, and password_reset are also supported for legacy scenarios. Get an email template

Throws
Parameters
- requestParameters: GetEmailTemplatesByTemplateNameRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>
- Defined in src/management/__generated/managers/email-templates-manager.ts:25

put

put(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<PostEmailTemplatesRequest>>
Update an email template. Update an email template

Throws
Parameters
- requestParameters: PutEmailTemplatesByTemplateNameRequest
- bodyParameters: EmailTemplateUpdate
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostEmailTemplatesRequest>>
- Defined in src/management/__generated/managers/email-templates-manager.ts:111

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

update

update(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>
Modify an email template. Patch an email template

Throws
Parameters
- requestParameters: PatchEmailTemplatesByTemplateNameOperationRequest
- bodyParameters: PatchEmailTemplatesByTemplateNameRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>
- Defined in src/management/__generated/managers/email-templates-manager.ts:51

Class EmailTemplatesManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns EmailTemplatesManager

Properties

Protected configuration

Methods

create

Throws

Parameters

bodyParameters: PostEmailTemplatesRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostEmailTemplatesRequest>>

get

Throws

Parameters

requestParameters: GetEmailTemplatesByTemplateNameRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>

put

Throws

Parameters

requestParameters: PutEmailTemplatesByTemplateNameRequest

bodyParameters: EmailTemplateUpdate

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostEmailTemplatesRequest>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

update

Throws

Parameters

requestParameters: PatchEmailTemplatesByTemplateNameOperationRequest

bodyParameters: PatchEmailTemplatesByTemplateNameRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: InitOverride