Class EmailTemplatesClient
- Namespace
- Auth0.ManagementApi.Clients
- Assembly
- Auth0.ManagementApi.dll
Contains methods to access the /email-templates endpoints.
public class EmailTemplatesClient : BaseClient, IEmailTemplatesClient
- Inheritance
-
EmailTemplatesClient
- Implements
- Inherited Members
Constructors
EmailTemplatesClient(IManagementConnection, Uri, IDictionary<string, string>)
Creates a new instance of EmailTemplatesClient.
public EmailTemplatesClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)
Parameters
connection
IManagementConnectionIManagementConnection used to make all API calls.
baseUri
UriUri of the endpoint to use in making API calls.
defaultHeaders
IDictionary<string, string>Dictionary containing default headers included with every request this client makes.
Methods
CreateAsync(EmailTemplateCreateRequest, CancellationToken)
Creates a new email template.
public Task<EmailTemplate> CreateAsync(EmailTemplateCreateRequest request, CancellationToken cancellationToken = default)
Parameters
request
EmailTemplateCreateRequestThe EmailTemplateCreateRequest containing details of the template to create.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<EmailTemplate>
The newly created EmailTemplate.
GetAsync(EmailTemplateName, CancellationToken)
Gets an email template.
public Task<EmailTemplate> GetAsync(EmailTemplateName templateName, CancellationToken cancellationToken = default)
Parameters
templateName
EmailTemplateNameThe name of email template you wish to retrieve.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<EmailTemplate>
The EmailTemplate that was requested.
PatchAsync(EmailTemplateName, EmailTemplatePatchRequest, CancellationToken)
Updates an email template.
public Task<EmailTemplate> PatchAsync(EmailTemplateName templateName, EmailTemplatePatchRequest request, CancellationToken cancellationToken = default)
Parameters
templateName
EmailTemplateNameThe name of the email template to update.
request
EmailTemplatePatchRequestThe EmailTemplatePatchRequest containing details of the template to patch.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<EmailTemplate>
The newly updated EmailTemplate.
UpdateAsync(EmailTemplateName, EmailTemplateUpdateRequest, CancellationToken)
Updates an email template.
public Task<EmailTemplate> UpdateAsync(EmailTemplateName templateName, EmailTemplateUpdateRequest request, CancellationToken cancellationToken = default)
Parameters
templateName
EmailTemplateNameThe name of the email template to patch.
request
EmailTemplateUpdateRequestThe EmailTemplateUpdateRequest containing details of the template to update.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<EmailTemplate>
The newly updated EmailTemplate.