Class TemplateSignerDetails

java.lang.Object

com.boldsign.model.TemplateSignerDetails

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

TemplateSignerDetails

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateSignerDetails.CustomTypeAdapterFactory
static enum	TemplateSignerDetails.DeliveryModeEnum	Gets or Sets deliveryMode
static enum	TemplateSignerDetails.ImposeAuthenticationEnum	Gets or Sets imposeAuthentication
static enum	TemplateSignerDetails.SignerTypeEnum	Gets or Sets signerType
static enum	TemplateSignerDetails.SignTypeEnum	Gets or Sets signType
static enum	TemplateSignerDetails.StatusEnum	Gets or Sets status

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_DELIVERY_MODE
static final String	SERIALIZED_NAME_ENABLE_ACCESS_CODE
static final String	SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
static final String	SERIALIZED_NAME_HOST_EMAIL
static final String	SERIALIZED_NAME_HOST_NAME
static final String	SERIALIZED_NAME_HOST_USER_ID
static final String	SERIALIZED_NAME_IMPOSE_AUTHENTICATION
static final String	SERIALIZED_NAME_ORDER
static final String	SERIALIZED_NAME_PHONE_NUMBER
static final String	SERIALIZED_NAME_SIGN_TYPE
static final String	SERIALIZED_NAME_SIGNER_EMAIL
static final String	SERIALIZED_NAME_SIGNER_NAME
static final String	SERIALIZED_NAME_SIGNER_ROLE
static final String	SERIALIZED_NAME_SIGNER_TYPE
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_USER_ID

Constructor Summary

Constructors

Constructor	Description
TemplateSignerDetails()

Method Summary

Modifier and Type	Method	Description
TemplateSignerDetails	allowFieldConfiguration(Boolean allowFieldConfiguration)
Map<String,Object>	createFormData()
TemplateSignerDetails	deliveryMode(TemplateSignerDetails.DeliveryModeEnum deliveryMode)
TemplateSignerDetails	enableAccessCode(Boolean enableAccessCode)
TemplateSignerDetails	enableEmailOTP(Boolean enableEmailOTP)
boolean	equals(Object o)
static TemplateSignerDetails	fromJson(String jsonString)	Create an instance of TemplateSignerDetails given an JSON string
Boolean	getAllowFieldConfiguration()	Get allowFieldConfiguration
TemplateSignerDetails.DeliveryModeEnum	getDeliveryMode()	Get deliveryMode
Boolean	getEnableAccessCode()	Get enableAccessCode
Boolean	getEnableEmailOTP()	Get enableEmailOTP
String	getHostEmail()	Get hostEmail
String	getHostName()	Get hostName
String	getHostUserId()	Get hostUserId
TemplateSignerDetails.ImposeAuthenticationEnum	getImposeAuthentication()	Get imposeAuthentication
Integer	getOrder()	Get order
PhoneNumber	getPhoneNumber()	Get phoneNumber
String	getSignerEmail()	Get signerEmail
String	getSignerName()	Get signerName
String	getSignerRole()	Get signerRole
TemplateSignerDetails.SignerTypeEnum	getSignerType()	Get signerType
TemplateSignerDetails.SignTypeEnum	getSignType()	Get signType
TemplateSignerDetails.StatusEnum	getStatus()	Get status
String	getUserId()	Get userId
int	hashCode()
TemplateSignerDetails	hostEmail(String hostEmail)
TemplateSignerDetails	hostName(String hostName)
TemplateSignerDetails	hostUserId(String hostUserId)
TemplateSignerDetails	imposeAuthentication(TemplateSignerDetails.ImposeAuthenticationEnum imposeAuthentication)
TemplateSignerDetails	order(Integer order)
TemplateSignerDetails	phoneNumber(PhoneNumber phoneNumber)
void	setAllowFieldConfiguration(Boolean allowFieldConfiguration)
void	setDeliveryMode(TemplateSignerDetails.DeliveryModeEnum deliveryMode)
void	setEnableAccessCode(Boolean enableAccessCode)
void	setEnableEmailOTP(Boolean enableEmailOTP)
void	setHostEmail(String hostEmail)
void	setHostName(String hostName)
void	setHostUserId(String hostUserId)
void	setImposeAuthentication(TemplateSignerDetails.ImposeAuthenticationEnum imposeAuthentication)
void	setOrder(Integer order)
void	setPhoneNumber(PhoneNumber phoneNumber)
void	setSignerEmail(String signerEmail)
void	setSignerName(String signerName)
void	setSignerRole(String signerRole)
void	setSignerType(TemplateSignerDetails.SignerTypeEnum signerType)
void	setSignType(TemplateSignerDetails.SignTypeEnum signType)
void	setStatus(TemplateSignerDetails.StatusEnum status)
void	setUserId(String userId)
TemplateSignerDetails	signerEmail(String signerEmail)
TemplateSignerDetails	signerName(String signerName)
TemplateSignerDetails	signerRole(String signerRole)
TemplateSignerDetails	signerType(TemplateSignerDetails.SignerTypeEnum signerType)
TemplateSignerDetails	signType(TemplateSignerDetails.SignTypeEnum signType)
TemplateSignerDetails	status(TemplateSignerDetails.StatusEnum status)
String	toJson()	Convert an instance of TemplateSignerDetails to an JSON string
String	toString()
TemplateSignerDetails	userId(String userId)
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_SIGNER_NAME

public static final String SERIALIZED_NAME_SIGNER_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_ROLE

public static final String SERIALIZED_NAME_SIGNER_ROLE

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_EMAIL

public static final String SERIALIZED_NAME_SIGNER_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_PHONE_NUMBER

public static final String SERIALIZED_NAME_PHONE_NUMBER

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLE_ACCESS_CODE

public static final String SERIALIZED_NAME_ENABLE_ACCESS_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLE_EMAIL_O_T_P

public static final String SERIALIZED_NAME_ENABLE_EMAIL_O_T_P

See Also:

• Constant Field Values

SERIALIZED_NAME_IMPOSE_AUTHENTICATION

public static final String SERIALIZED_NAME_IMPOSE_AUTHENTICATION

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_USER_ID

public static final String SERIALIZED_NAME_USER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_ORDER

public static final String SERIALIZED_NAME_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_HOST_NAME

public static final String SERIALIZED_NAME_HOST_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_HOST_USER_ID

public static final String SERIALIZED_NAME_HOST_USER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGN_TYPE

public static final String SERIALIZED_NAME_SIGN_TYPE

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TemplateSignerDetails

public TemplateSignerDetails()

Method Details

signerName

public TemplateSignerDetails signerName(String signerName)

getSignerName

@Nullable
public String getSignerName()

Get signerName

Returns:

signerName

setSignerName

public void setSignerName(String signerName)

signerRole

public TemplateSignerDetails signerRole(String signerRole)

getSignerRole

@Nullable
public String getSignerRole()

Get signerRole

Returns:

signerRole

setSignerRole

public void setSignerRole(String signerRole)

signerEmail

public TemplateSignerDetails signerEmail(String signerEmail)

getSignerEmail

@Nullable
public String getSignerEmail()

Get signerEmail

Returns:

signerEmail

setSignerEmail

public void setSignerEmail(String signerEmail)

phoneNumber

public TemplateSignerDetails phoneNumber(PhoneNumber phoneNumber)

getPhoneNumber

@Nullable
public PhoneNumber getPhoneNumber()

Get phoneNumber

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(PhoneNumber phoneNumber)

status

public TemplateSignerDetails status(TemplateSignerDetails.StatusEnum status)

getStatus

@Nullable
public TemplateSignerDetails.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(TemplateSignerDetails.StatusEnum status)

enableAccessCode

public TemplateSignerDetails enableAccessCode(Boolean enableAccessCode)

getEnableAccessCode

@Nullable
public Boolean getEnableAccessCode()

Get enableAccessCode

Returns:

enableAccessCode

setEnableAccessCode

public void setEnableAccessCode(Boolean enableAccessCode)

enableEmailOTP

public TemplateSignerDetails enableEmailOTP(Boolean enableEmailOTP)

getEnableEmailOTP

@Nullable
public Boolean getEnableEmailOTP()

Get enableEmailOTP

Returns:

enableEmailOTP

setEnableEmailOTP

public void setEnableEmailOTP(Boolean enableEmailOTP)

imposeAuthentication

public TemplateSignerDetails imposeAuthentication(TemplateSignerDetails.ImposeAuthenticationEnum imposeAuthentication)

getImposeAuthentication

@Nullable
public TemplateSignerDetails.ImposeAuthenticationEnum getImposeAuthentication()

Get imposeAuthentication

Returns:

imposeAuthentication

setImposeAuthentication

public void setImposeAuthentication(TemplateSignerDetails.ImposeAuthenticationEnum imposeAuthentication)

deliveryMode

public TemplateSignerDetails deliveryMode(TemplateSignerDetails.DeliveryModeEnum deliveryMode)

getDeliveryMode

@Nullable
public TemplateSignerDetails.DeliveryModeEnum getDeliveryMode()

Get deliveryMode

Returns:

deliveryMode

setDeliveryMode

public void setDeliveryMode(TemplateSignerDetails.DeliveryModeEnum deliveryMode)

allowFieldConfiguration

public TemplateSignerDetails allowFieldConfiguration(Boolean allowFieldConfiguration)

getAllowFieldConfiguration

@Nullable
public Boolean getAllowFieldConfiguration()

Get allowFieldConfiguration

Returns:

allowFieldConfiguration

setAllowFieldConfiguration

public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)

userId

public TemplateSignerDetails userId(String userId)

getUserId

@Nullable
public String getUserId()

Get userId

Returns:

userId

setUserId

public void setUserId(String userId)

order

public TemplateSignerDetails order(Integer order)

getOrder

@Nullable
public Integer getOrder()

Get order

Returns:

order

setOrder

public void setOrder(Integer order)

signerType

public TemplateSignerDetails signerType(TemplateSignerDetails.SignerTypeEnum signerType)

getSignerType

@Nullable
public TemplateSignerDetails.SignerTypeEnum getSignerType()

Get signerType

Returns:

signerType

setSignerType

public void setSignerType(TemplateSignerDetails.SignerTypeEnum signerType)

hostEmail

public TemplateSignerDetails hostEmail(String hostEmail)

getHostEmail

@Nullable
public String getHostEmail()

Get hostEmail

Returns:

hostEmail

setHostEmail

public void setHostEmail(String hostEmail)

hostName

public TemplateSignerDetails hostName(String hostName)

getHostName

@Nullable
public String getHostName()

Get hostName

Returns:

hostName

setHostName

public void setHostName(String hostName)

hostUserId

public TemplateSignerDetails hostUserId(String hostUserId)

getHostUserId

@Nullable
public String getHostUserId()

Get hostUserId

Returns:

hostUserId

setHostUserId

public void setHostUserId(String hostUserId)

signType

public TemplateSignerDetails signType(TemplateSignerDetails.SignTypeEnum signType)

getSignType

@Nullable
public TemplateSignerDetails.SignTypeEnum getSignType()

Get signType

Returns:

signType

setSignType

public void setSignType(TemplateSignerDetails.SignTypeEnum signType)

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 TemplateSignerDetails

fromJson

public static TemplateSignerDetails fromJson(String jsonString)
                                      throws IOException

Create an instance of TemplateSignerDetails given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TemplateSignerDetails

Throws:

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

toJson

public String toJson()

Convert an instance of TemplateSignerDetails to an JSON string

Returns:

JSON string