auth0
Version:
SDK for Auth0 API v2
39 lines (38 loc) • 2.08 kB
TypeScript
import * as runtime from '../../../lib/runtime.js';
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
import type { EmailTemplateUpdate, GetEmailTemplatesByTemplateName200Response, PatchEmailTemplatesByTemplateNameRequest, PostEmailTemplatesRequest, GetEmailTemplatesByTemplateNameRequest, PatchEmailTemplatesByTemplateNameOperationRequest, PutEmailTemplatesByTemplateNameRequest } from '../models/index.js';
declare const BaseAPI: typeof runtime.BaseAPI;
/**
*
*/
export declare class EmailTemplatesManager extends BaseAPI {
/**
* 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`, and `user_invitation`. The names `change_password`, and `password_reset` are also supported for legacy scenarios.
* Get an email template
*
* @throws {RequiredError}
*/
get(requestParameters: GetEmailTemplatesByTemplateNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>;
/**
* Modify an email template.
* Patch an email template
*
* @throws {RequiredError}
*/
update(requestParameters: PatchEmailTemplatesByTemplateNameOperationRequest, bodyParameters: PatchEmailTemplatesByTemplateNameRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetEmailTemplatesByTemplateName200Response>>;
/**
* Create an email template.
* Create an email template
*
* @throws {RequiredError}
*/
create(bodyParameters: PostEmailTemplatesRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostEmailTemplatesRequest>>;
/**
* Update an email template.
* Update an email template
*
* @throws {RequiredError}
*/
put(requestParameters: PutEmailTemplatesByTemplateNameRequest, bodyParameters: EmailTemplateUpdate, initOverrides?: InitOverride): Promise<ApiResponse<PostEmailTemplatesRequest>>;
}
export {};