Class TemplateRole

java.lang.Object

com.boldsign.model.TemplateRole

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.8.0")
public class TemplateRole
extends Object

TemplateRole

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateRole.CustomTypeAdapterFactory
static enum	TemplateRole.DeliveryModeEnum	Gets or Sets deliveryMode
static enum	TemplateRole.ImposeAuthenticationEnum	Gets or Sets imposeAuthentication
static enum	TemplateRole.LanguageEnum	<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>
static enum	TemplateRole.LocaleEnum	Gets or Sets locale
static enum	TemplateRole.SignerTypeEnum	Gets or Sets signerType

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
static final String	SERIALIZED_NAME_ALLOW_ROLE_DELETE
static final String	SERIALIZED_NAME_ALLOW_ROLE_EDIT
static final String	SERIALIZED_NAME_DEFAULT_SIGNER_EMAIL
static final String	SERIALIZED_NAME_DEFAULT_SIGNER_NAME
static final String	SERIALIZED_NAME_DELIVERY_MODE
static final String	SERIALIZED_NAME_ENABLE_QES
static final String	SERIALIZED_NAME_FORM_FIELDS
static final String	SERIALIZED_NAME_HOST_EMAIL
static final String	SERIALIZED_NAME_IMPOSE_AUTHENTICATION
static final String	SERIALIZED_NAME_INDEX
static final String	SERIALIZED_NAME_LANGUAGE
static final String	SERIALIZED_NAME_LOCALE
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_PHONE_NUMBER
static final String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static final String	SERIALIZED_NAME_SIGNER_ORDER
static final String	SERIALIZED_NAME_SIGNER_TYPE

Constructor Summary

Constructors

Constructor	Description
TemplateRole()

Method Summary

Modifier and Type	Method	Description
TemplateRole	addFormFieldsItem(FormField formFieldsItem)
TemplateRole	allowFieldConfiguration(Boolean allowFieldConfiguration)
TemplateRole	allowRoleDelete(Boolean allowRoleDelete)
TemplateRole	allowRoleEdit(Boolean allowRoleEdit)
Map<String,Object>	createFormData()
TemplateRole	defaultSignerEmail(String defaultSignerEmail)
TemplateRole	defaultSignerName(String defaultSignerName)
TemplateRole	deliveryMode(TemplateRole.DeliveryModeEnum deliveryMode)
TemplateRole	enableQes(Boolean enableQes)
boolean	equals(Object o)
TemplateRole	formFields(List<FormField> formFields)
static TemplateRole	fromJson(String jsonString)	Create an instance of TemplateRole given an JSON string
Boolean	getAllowFieldConfiguration()	Get allowFieldConfiguration
Boolean	getAllowRoleDelete()	Get allowRoleDelete
Boolean	getAllowRoleEdit()	Get allowRoleEdit
String	getDefaultSignerEmail()	Get defaultSignerEmail
String	getDefaultSignerName()	Get defaultSignerName
TemplateRole.DeliveryModeEnum	getDeliveryMode()	Get deliveryMode
Boolean	getEnableQes()	Get enableQes
List<FormField>	getFormFields()	Get formFields
String	getHostEmail()	Get hostEmail
TemplateRole.ImposeAuthenticationEnum	getImposeAuthentication()	Get imposeAuthentication
Integer	getIndex()	Get index minimum: 1 maximum: 50
TemplateRole.LanguageEnum	getLanguage()	<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>
TemplateRole.LocaleEnum	getLocale()	Get locale
String	getName()	Get name
PhoneNumber	getPhoneNumber()	Get phoneNumber
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
Integer	getSignerOrder()	Get signerOrder
TemplateRole.SignerTypeEnum	getSignerType()	Get signerType
int	hashCode()
TemplateRole	hostEmail(String hostEmail)
TemplateRole	imposeAuthentication(TemplateRole.ImposeAuthenticationEnum imposeAuthentication)
TemplateRole	index(Integer index)
TemplateRole	language(TemplateRole.LanguageEnum language)
TemplateRole	locale(TemplateRole.LocaleEnum locale)
TemplateRole	name(String name)
TemplateRole	phoneNumber(PhoneNumber phoneNumber)
TemplateRole	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setAllowFieldConfiguration(Boolean allowFieldConfiguration)
void	setAllowRoleDelete(Boolean allowRoleDelete)
void	setAllowRoleEdit(Boolean allowRoleEdit)
void	setDefaultSignerEmail(String defaultSignerEmail)
void	setDefaultSignerName(String defaultSignerName)
void	setDeliveryMode(TemplateRole.DeliveryModeEnum deliveryMode)
void	setEnableQes(Boolean enableQes)
void	setFormFields(List<FormField> formFields)
void	setHostEmail(String hostEmail)
void	setImposeAuthentication(TemplateRole.ImposeAuthenticationEnum imposeAuthentication)
void	setIndex(Integer index)
void	setLanguage(TemplateRole.LanguageEnum language)
void	setLocale(TemplateRole.LocaleEnum locale)
void	setName(String name)
void	setPhoneNumber(PhoneNumber phoneNumber)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setSignerOrder(Integer signerOrder)
void	setSignerType(TemplateRole.SignerTypeEnum signerType)
TemplateRole	signerOrder(Integer signerOrder)
TemplateRole	signerType(TemplateRole.SignerTypeEnum signerType)
String	toJson()	Convert an instance of TemplateRole to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_INDEX

public static final String SERIALIZED_NAME_INDEX

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DEFAULT_SIGNER_NAME

public static final String SERIALIZED_NAME_DEFAULT_SIGNER_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DEFAULT_SIGNER_EMAIL

public static final String SERIALIZED_NAME_DEFAULT_SIGNER_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_ORDER

public static final String SERIALIZED_NAME_SIGNER_ORDER

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_TYPE

public static final String SERIALIZED_NAME_SIGNER_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_HOST_EMAIL

public static final String SERIALIZED_NAME_HOST_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_LANGUAGE

public static final String SERIALIZED_NAME_LANGUAGE

See Also:

• Constant Field Values

SERIALIZED_NAME_LOCALE

public static final String SERIALIZED_NAME_LOCALE

See Also:

• Constant Field Values

SERIALIZED_NAME_IMPOSE_AUTHENTICATION

public static final String SERIALIZED_NAME_IMPOSE_AUTHENTICATION

See Also:

• Constant Field Values

SERIALIZED_NAME_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

See Also:

• Constant Field Values

SERIALIZED_NAME_DELIVERY_MODE

public static final String SERIALIZED_NAME_DELIVERY_MODE

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION

public static final String SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION

See Also:

• Constant Field Values

SERIALIZED_NAME_FORM_FIELDS

public static final String SERIALIZED_NAME_FORM_FIELDS

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_ROLE_EDIT

public static final String SERIALIZED_NAME_ALLOW_ROLE_EDIT

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_ROLE_DELETE

public static final String SERIALIZED_NAME_ALLOW_ROLE_DELETE

See Also:

• Constant Field Values

SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

public static final String SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLE_QES

public static final String SERIALIZED_NAME_ENABLE_QES

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TemplateRole

public TemplateRole()

Method Details

index

public TemplateRole index(Integer index)

getIndex

@Nonnull
public Integer getIndex()

Get index minimum: 1 maximum: 50

Returns:

index

setIndex

public void setIndex(Integer index)

name

public TemplateRole name(String name)

getName

@Nullable
public String getName()

Get name

Returns:

name

setName

public void setName(String name)

defaultSignerName

public TemplateRole defaultSignerName(String defaultSignerName)

getDefaultSignerName

@Nullable
public String getDefaultSignerName()

Get defaultSignerName

Returns:

defaultSignerName

setDefaultSignerName

public void setDefaultSignerName(String defaultSignerName)

defaultSignerEmail

public TemplateRole defaultSignerEmail(String defaultSignerEmail)

getDefaultSignerEmail

@Nullable
public String getDefaultSignerEmail()

Get defaultSignerEmail

Returns:

defaultSignerEmail

setDefaultSignerEmail

public void setDefaultSignerEmail(String defaultSignerEmail)

signerOrder

public TemplateRole signerOrder(Integer signerOrder)

getSignerOrder

@Nullable
public Integer getSignerOrder()

Get signerOrder

Returns:

signerOrder

setSignerOrder

public void setSignerOrder(Integer signerOrder)

signerType

public TemplateRole signerType(TemplateRole.SignerTypeEnum signerType)

getSignerType

@Nullable
public TemplateRole.SignerTypeEnum getSignerType()

Get signerType

Returns:

signerType

setSignerType

public void setSignerType(TemplateRole.SignerTypeEnum signerType)

hostEmail

public TemplateRole hostEmail(String hostEmail)

getHostEmail

@Nullable
public String getHostEmail()

Get hostEmail

Returns:

hostEmail

setHostEmail

public void setHostEmail(String hostEmail)

language

public TemplateRole language(TemplateRole.LanguageEnum language)

getLanguage

@Nullable
public TemplateRole.LanguageEnum getLanguage()

<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>

Returns:

language

setLanguage

public void setLanguage(TemplateRole.LanguageEnum language)

locale

public TemplateRole locale(TemplateRole.LocaleEnum locale)

getLocale

@Nullable
public TemplateRole.LocaleEnum getLocale()

Get locale

Returns:

locale

setLocale

public void setLocale(TemplateRole.LocaleEnum locale)

imposeAuthentication

public TemplateRole imposeAuthentication(TemplateRole.ImposeAuthenticationEnum imposeAuthentication)

getImposeAuthentication

@Nullable
public TemplateRole.ImposeAuthenticationEnum getImposeAuthentication()

Get imposeAuthentication

Returns:

imposeAuthentication

setImposeAuthentication

public void setImposeAuthentication(TemplateRole.ImposeAuthenticationEnum imposeAuthentication)

phoneNumber

public TemplateRole phoneNumber(PhoneNumber phoneNumber)

getPhoneNumber

@Nullable
public PhoneNumber getPhoneNumber()

Get phoneNumber

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(PhoneNumber phoneNumber)

deliveryMode

public TemplateRole deliveryMode(TemplateRole.DeliveryModeEnum deliveryMode)

getDeliveryMode

@Nullable
public TemplateRole.DeliveryModeEnum getDeliveryMode()

Get deliveryMode

Returns:

deliveryMode

setDeliveryMode

public void setDeliveryMode(TemplateRole.DeliveryModeEnum deliveryMode)

allowFieldConfiguration

public TemplateRole allowFieldConfiguration(Boolean allowFieldConfiguration)

getAllowFieldConfiguration

@Nullable
public Boolean getAllowFieldConfiguration()

Get allowFieldConfiguration

Returns:

allowFieldConfiguration

setAllowFieldConfiguration

public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)

formFields

public TemplateRole formFields(List<FormField> formFields)

addFormFieldsItem

public TemplateRole addFormFieldsItem(FormField formFieldsItem)

getFormFields

@Nullable
public List<FormField> getFormFields()

Get formFields

Returns:

formFields

setFormFields

public void setFormFields(List<FormField> formFields)

allowRoleEdit

public TemplateRole allowRoleEdit(Boolean allowRoleEdit)

getAllowRoleEdit

@Nullable
public Boolean getAllowRoleEdit()

Get allowRoleEdit

Returns:

allowRoleEdit

setAllowRoleEdit

public void setAllowRoleEdit(Boolean allowRoleEdit)

allowRoleDelete

public TemplateRole allowRoleDelete(Boolean allowRoleDelete)

getAllowRoleDelete

@Nullable
public Boolean getAllowRoleDelete()

Get allowRoleDelete

Returns:

allowRoleDelete

setAllowRoleDelete

public void setAllowRoleDelete(Boolean allowRoleDelete)

recipientNotificationSettings

public TemplateRole recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

enableQes

public TemplateRole enableQes(Boolean enableQes)

getEnableQes

@Nullable
public Boolean getEnableQes()

Get enableQes

Returns:

enableQes

setEnableQes

public void setEnableQes(Boolean enableQes)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createFormData

public Map<String,Object> createFormData()
                                  throws ApiException

Throws:

ApiException

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to TemplateRole

fromJson

public static TemplateRole fromJson(String jsonString)
                             throws IOException

Create an instance of TemplateRole given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TemplateRole

Throws:

IOException - if the JSON string is invalid with respect to TemplateRole

toJson

public String toJson()

Convert an instance of TemplateRole to an JSON string

Returns:

JSON string