com.okta.sdk.resource.brands

Interface EmailTemplate

All Superinterfaces:

ExtensibleResource, Map<String,Object>, PropertyRetriever, Resource

All Known Implementing Classes:

DefaultEmailTemplate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface EmailTemplate
extends ExtensibleResource

EmailTemplate

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
EmailTemplateCustomization	createEmailTemplateCustomization(String brandId, String templateName, EmailTemplateCustomizationRequest customization) Create Email Template Customization Create an email customization
void	deleteEmailTemplateCustomization(String brandId, String templateName, String customizationId) Delete Email Customization Delete an email customization
void	deleteEmailTemplateCustomizations(String brandId, String templateName) Delete Email Template Customization Delete all customizations for an email template.
EmailTemplate	getEmailTemplate(String brandId, String templateName) Get Email Template Fetch an email template by templateName
EmailTemplateCustomization	getEmailTemplateCustomization(String brandId, String templateName, String customizationId) Get Email Template Customization Fetch an email customization by id.
EmailTemplateContent	getEmailTemplateCustomizationPreview(String brandId, String templateName, String customizationId) Get Preview Content of Email Customization Get a preview of an email template customization.
EmailTemplateContent	getEmailTemplateDefaultContent(String brandId, String templateName) Get Default Content of Email Template Fetch the default content for an email template.
EmailTemplateContent	getEmailTemplateDefaultContentPreview(String brandId, String templateName) Get Preview of Email Template Default Content Fetch a preview of an email template's default content by populating velocity references with the current user's environment.
Map<String,Object>	getLinks()
String	getName()
EmailTemplateCustomizationList	listEmailTemplateCustomizations(String brandId, String templateName) List Email Template Customization List all email customizations for an email template
void	sendTestEmail(String brandId, String templateName, EmailTemplateTestRequest customization) Get Preview of Email Template Default Content Send a test email to the current users primary and secondary email addresses.
EmailTemplateCustomization	updateEmailTemplateCustomization(String brandId, String templateName, String customizationId, EmailTemplateCustomizationRequest customization) Update Email Customization Update an email customization

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getLinks

Map<String,Object> getLinks()

getName

String getName()

deleteEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}")
void deleteEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                      String templateName,
                                                                                                                                                                                                                                                                                      String customizationId)

Delete Email Customization Delete an email customization

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

sendTestEmail

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/brands/{brandId}/templates/email/{templateName}/test")
void sendTestEmail(String brandId,
                                                                                                                                                                                                                                     String templateName,
                                                                                                                                                                                                                                     EmailTemplateTestRequest customization)

Get Preview of Email Template Default Content Send a test email to the current users primary and secondary email addresses. The email content is selected based on the following priority: An email customization specifically for the users locale. The default language of email customizations. The email templates default content.

Parameters:

brandId - (required)

templateName - (required)

customization - (required)

getEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}")
EmailTemplateCustomization getEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                                      String templateName,
                                                                                                                                                                                                                                                                                                      String customizationId)

Get Email Template Customization Fetch an email customization by id.

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

Returns:

EmailTemplateCustomization

getEmailTemplateCustomizationPreview

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview")
EmailTemplateContent getEmailTemplateCustomizationPreview(String brandId,
                                                                                                                                                                                                                                                                                                               String templateName,
                                                                                                                                                                                                                                                                                                               String customizationId)

Get Preview Content of Email Customization Get a preview of an email template customization.

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

Returns:

EmailTemplateContent

createEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations")
EmailTemplateCustomization createEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                        String templateName,
                                                                                                                                                                                                                                                                                        EmailTemplateCustomizationRequest customization)

Create Email Template Customization Create an email customization

Parameters:

brandId - (required)

templateName - (required)

customization - (required)

Returns:

EmailTemplateCustomization

getEmailTemplateDefaultContentPreview

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview")
EmailTemplateContent getEmailTemplateDefaultContentPreview(String brandId,
                                                                                                                                                                                                                                                                                               String templateName)

Get Preview of Email Template Default Content Fetch a preview of an email template's default content by populating velocity references with the current user's environment.

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplateContent

deleteEmailTemplateCustomizations

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations")
void deleteEmailTemplateCustomizations(String brandId,
                                                                                                                                                                                                                                                                     String templateName)

Delete Email Template Customization Delete all customizations for an email template. Also known as “Reset to Default”.

Parameters:

brandId - (required)

templateName - (required)

listEmailTemplateCustomizations

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations")
EmailTemplateCustomizationList listEmailTemplateCustomizations(String brandId,
                                                                                                                                                                                                                                                                                          String templateName)

List Email Template Customization List all email customizations for an email template

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplateCustomizationList

updateEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}")
EmailTemplateCustomization updateEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                                         String templateName,
                                                                                                                                                                                                                                                                                                         String customizationId,
                                                                                                                                                                                                                                                                                                         EmailTemplateCustomizationRequest customization)

Update Email Customization Update an email customization

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

customization - (required)

Returns:

EmailTemplateCustomization

getEmailTemplateDefaultContent

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/default-content")
EmailTemplateContent getEmailTemplateDefaultContent(String brandId,
                                                                                                                                                                                                                                                                                String templateName)

Get Default Content of Email Template Fetch the default content for an email template.

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplateContent

getEmailTemplate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}")
EmailTemplate getEmailTemplate(String brandId,
                                                                                                                                                                                                                                           String templateName)

Get Email Template Fetch an email template by templateName

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplate