com.auth0.client.mgmt

Class EmailTemplatesEntity

java.lang.Object

com.auth0.client.mgmt.EmailTemplatesEntity

public class EmailTemplatesEntity
extends java.lang.Object

Class that provides an implementation of the Email Templates methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Email_Templates

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiToken
protected okhttp3.HttpUrl	baseUrl
protected okhttp3.OkHttpClient	client
static java.lang.String	TEMPLATE_BLOCKED_ACCOUNT
static java.lang.String	TEMPLATE_CHANGE_PASSWORD
static java.lang.String	TEMPLATE_ENROLLMENT_EMAIL
static java.lang.String	TEMPLATE_MFA_OOB_CODE
static java.lang.String	TEMPLATE_PASSWORD_RESET
static java.lang.String	TEMPLATE_RESET_EMAIL
static java.lang.String	TEMPLATE_STOLEN_CREDENTIALS
static java.lang.String	TEMPLATE_VERIFY_EMAIL
static java.lang.String	TEMPLATE_WELCOME_EMAIL

Method Summary

Modifier and Type	Method and Description
Request<EmailTemplate>	create(EmailTemplate template) Create an Email Template.
Request<EmailTemplate>	get(java.lang.String templateName) Request the Email Templates.
Request<EmailTemplate>	update(java.lang.String templateName, EmailTemplate template) Patches the existing Email Template.

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_VERIFY_EMAIL

public static final java.lang.String TEMPLATE_VERIFY_EMAIL

See Also:

Constant Field Values

TEMPLATE_RESET_EMAIL

public static final java.lang.String TEMPLATE_RESET_EMAIL

See Also:

Constant Field Values

TEMPLATE_WELCOME_EMAIL

public static final java.lang.String TEMPLATE_WELCOME_EMAIL

See Also:

Constant Field Values

TEMPLATE_BLOCKED_ACCOUNT

public static final java.lang.String TEMPLATE_BLOCKED_ACCOUNT

See Also:

Constant Field Values

TEMPLATE_STOLEN_CREDENTIALS

public static final java.lang.String TEMPLATE_STOLEN_CREDENTIALS

See Also:

Constant Field Values

TEMPLATE_ENROLLMENT_EMAIL

public static final java.lang.String TEMPLATE_ENROLLMENT_EMAIL

See Also:

Constant Field Values

TEMPLATE_CHANGE_PASSWORD

public static final java.lang.String TEMPLATE_CHANGE_PASSWORD

See Also:

Constant Field Values

TEMPLATE_PASSWORD_RESET

public static final java.lang.String TEMPLATE_PASSWORD_RESET

See Also:

Constant Field Values

TEMPLATE_MFA_OOB_CODE

public static final java.lang.String TEMPLATE_MFA_OOB_CODE

See Also:

Constant Field Values

client

protected final okhttp3.OkHttpClient client

baseUrl

protected final okhttp3.HttpUrl baseUrl

apiToken

protected final java.lang.String apiToken

Method Detail

get

public Request<EmailTemplate> get(java.lang.String templateName)

Request the Email Templates. A token with scope read:email_templates is needed. See https://auth0.com/docs/api/management/v2#!/Email_Templates/get_email_templates_by_templateName

Parameters:

templateName - the template name to request. You can use any of the constants defined in EmailTemplatesEntity

Returns:

a Request to execute.

create

public Request<EmailTemplate> create(EmailTemplate template)

Create an Email Template. A token with scope create:email_templates is needed. See https://auth0.com/docs/api/management/v2#!/Email_Templates/post_email_templates

Parameters:

template - the template data to set

Returns:

a Request to execute.

update

public Request<EmailTemplate> update(java.lang.String templateName,
                                     EmailTemplate template)

Patches the existing Email Template. A token with scope update:email_templates is needed. See https://auth0.com/docs/api/management/v2#!/Email_Templates/patch_email_templates_by_templateName

Parameters:

templateName - the name of the template to update. You can use any of the constants defined in EmailTemplatesEntity

template - the email template data to set.

Returns:

a Request to execute.