com.okta.sdk.impl.resource.brands

Class DefaultEmailTemplate

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<EmailTemplate>

com.okta.sdk.impl.resource.brands.DefaultEmailTemplate

All Implemented Interfaces:

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

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00")
public class DefaultEmailTemplate
extends AbstractInstanceResource<EmailTemplate>
implements EmailTemplate

EmailTemplate

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultEmailTemplate(InternalDataStore dataStore)
DefaultEmailTemplate(InternalDataStore dataStore, Map<String,Object> properties)

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()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
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 class com.okta.sdk.impl.resource.AbstractInstanceResource

delete, save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

DefaultEmailTemplate

public DefaultEmailTemplate(InternalDataStore dataStore)

DefaultEmailTemplate

public DefaultEmailTemplate(InternalDataStore dataStore,
                            Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<EmailTemplate>

Returns:

The type of resource this class represents.

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface EmailTemplate

getName

public String getName()

Specified by:

getName in interface EmailTemplate

deleteEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}")
public void deleteEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                              String templateName,
                                                                                                                                                                                                                                                                                              String customizationId)

Delete Email Customization Delete an email customization

Specified by:

deleteEmailTemplateCustomization in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

sendTestEmail

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/brands/{brandId}/templates/email/{templateName}/test")
public 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.

Specified by:

sendTestEmail in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

customization - (required)

getEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}")
public EmailTemplateCustomization getEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                                              String templateName,
                                                                                                                                                                                                                                                                                                              String customizationId)

Get Email Template Customization Fetch an email customization by id.

Specified by:

getEmailTemplateCustomization in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

Returns:

EmailTemplateCustomization

getEmailTemplateCustomizationPreview

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}/preview")
public EmailTemplateContent getEmailTemplateCustomizationPreview(String brandId,
                                                                                                                                                                                                                                                                                                                       String templateName,
                                                                                                                                                                                                                                                                                                                       String customizationId)

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

Specified by:

getEmailTemplateCustomizationPreview in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

Returns:

EmailTemplateContent

createEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations")
public EmailTemplateCustomization createEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                                String templateName,
                                                                                                                                                                                                                                                                                                EmailTemplateCustomizationRequest customization)

Create Email Template Customization Create an email customization

Specified by:

createEmailTemplateCustomization in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

customization - (required)

Returns:

EmailTemplateCustomization

getEmailTemplateDefaultContentPreview

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/default-content/preview")
public 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.

Specified by:

getEmailTemplateDefaultContentPreview in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplateContent

deleteEmailTemplateCustomizations

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations")
public void deleteEmailTemplateCustomizations(String brandId,
                                                                                                                                                                                                                                                                             String templateName)

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

Specified by:

deleteEmailTemplateCustomizations in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

listEmailTemplateCustomizations

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations")
public EmailTemplateCustomizationList listEmailTemplateCustomizations(String brandId,
                                                                                                                                                                                                                                                                                                  String templateName)

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

Specified by:

listEmailTemplateCustomizations in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplateCustomizationList

updateEmailTemplateCustomization

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="PUT - /api/v1/brands/{brandId}/templates/email/{templateName}/customizations/{customizationId}")
public EmailTemplateCustomization updateEmailTemplateCustomization(String brandId,
                                                                                                                                                                                                                                                                                                                 String templateName,
                                                                                                                                                                                                                                                                                                                 String customizationId,
                                                                                                                                                                                                                                                                                                                 EmailTemplateCustomizationRequest customization)

Update Email Customization Update an email customization

Specified by:

updateEmailTemplateCustomization in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

customizationId - (required)

customization - (required)

Returns:

EmailTemplateCustomization

getEmailTemplateDefaultContent

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}/default-content")
public EmailTemplateContent getEmailTemplateDefaultContent(String brandId,
                                                                                                                                                                                                                                                                                        String templateName)

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

Specified by:

getEmailTemplateDefaultContent in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplateContent

getEmailTemplate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email/{templateName}")
public EmailTemplate getEmailTemplate(String brandId,
                                                                                                                                                                                                                                                   String templateName)

Get Email Template Fetch an email template by templateName

Specified by:

getEmailTemplate in interface EmailTemplate

Parameters:

brandId - (required)

templateName - (required)

Returns:

EmailTemplate