Package com.boldsign.model

Class DocumentSignerWebhookModel

java.lang.Object

com.boldsign.model.DocumentSignerWebhookModel

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

DocumentSignerWebhookModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentSignerWebhookModel.CustomTypeAdapterFactory
static class	DocumentSignerWebhookModel.StatusEnum	Gets or Sets status

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
static String	SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT
static String	SERIALIZED_NAME_AUTHENTICATION_SETTINGS
static String	SERIALIZED_NAME_AUTHENTICATION_TYPE
static String	SERIALIZED_NAME_DECLINE_MESSAGE
static String	SERIALIZED_NAME_ENABLE_ACCESS_CODE
static String	SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
static String	SERIALIZED_NAME_ID_VERIFICATION
static String	SERIALIZED_NAME_IS_AUTHENTICATION_FAILED
static String	SERIALIZED_NAME_IS_DELIVERY_FAILED
static String	SERIALIZED_NAME_IS_REASSIGNED
static String	SERIALIZED_NAME_IS_VIEWED
static String	SERIALIZED_NAME_LAST_ACTIVITY_DATE
static String	SERIALIZED_NAME_LAST_REMINDER_SENT_ON
static String	SERIALIZED_NAME_ORDER
static String	SERIALIZED_NAME_PHONE_NUMBER
static String	SERIALIZED_NAME_REASSIGN_MESSAGE
static String	SERIALIZED_NAME_SIGNER_EMAIL
static String	SERIALIZED_NAME_SIGNER_NAME
static String	SERIALIZED_NAME_SIGNER_ROLE
static String	SERIALIZED_NAME_SIGNER_TYPE
static String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor	Description
DocumentSignerWebhookModel()

Method Summary

Modifier and Type	Method	Description
DocumentSignerWebhookModel	allowFieldConfiguration(Boolean allowFieldConfiguration)
DocumentSignerWebhookModel	authenticationRetryCount(Integer authenticationRetryCount)
DocumentSignerWebhookModel	authenticationSettings(SignerAuthenticationSettings authenticationSettings)
DocumentSignerWebhookModel	authenticationType(String authenticationType)
Map<String,Object>	createFormData()
DocumentSignerWebhookModel	declineMessage(String declineMessage)
DocumentSignerWebhookModel	enableAccessCode(Boolean enableAccessCode)
DocumentSignerWebhookModel	enableEmailOTP(Boolean enableEmailOTP)
boolean	equals(Object o)
static DocumentSignerWebhookModel	fromJson(String jsonString)	Create an instance of DocumentSignerWebhookModel given an JSON string
Boolean	getAllowFieldConfiguration()	Get allowFieldConfiguration
Integer	getAuthenticationRetryCount()	Get authenticationRetryCount
SignerAuthenticationSettings	getAuthenticationSettings()	Get authenticationSettings
String	getAuthenticationType()	Get authenticationType
String	getDeclineMessage()	Get declineMessage
Boolean	getEnableAccessCode()	Get enableAccessCode
Boolean	getEnableEmailOTP()	Get enableEmailOTP
IdVerification	getIdVerification()	Get idVerification
Boolean	getIsAuthenticationFailed()	Get isAuthenticationFailed
Boolean	getIsDeliveryFailed()	Get isDeliveryFailed
Boolean	getIsReassigned()	Get isReassigned
Boolean	getIsViewed()	Get isViewed
OffsetDateTime	getLastActivityDate()	Get lastActivityDate
OffsetDateTime	getLastReminderSentOn()	Get lastReminderSentOn
Integer	getOrder()	Get order
PhoneNumberWebhookModel	getPhoneNumber()	Get phoneNumber
String	getReassignMessage()	Get reassignMessage
String	getSignerEmail()	Get signerEmail
String	getSignerName()	Get signerName
String	getSignerRole()	Get signerRole
String	getSignerType()	Get signerType
DocumentSignerWebhookModel.StatusEnum	getStatus()	Get status
int	hashCode()
DocumentSignerWebhookModel	idVerification(IdVerification idVerification)
DocumentSignerWebhookModel	isAuthenticationFailed(Boolean isAuthenticationFailed)
DocumentSignerWebhookModel	isDeliveryFailed(Boolean isDeliveryFailed)
DocumentSignerWebhookModel	isReassigned(Boolean isReassigned)
DocumentSignerWebhookModel	isViewed(Boolean isViewed)
DocumentSignerWebhookModel	lastActivityDate(OffsetDateTime lastActivityDate)
DocumentSignerWebhookModel	lastReminderSentOn(OffsetDateTime lastReminderSentOn)
DocumentSignerWebhookModel	order(Integer order)
DocumentSignerWebhookModel	phoneNumber(PhoneNumberWebhookModel phoneNumber)
DocumentSignerWebhookModel	reassignMessage(String reassignMessage)
void	setAllowFieldConfiguration(Boolean allowFieldConfiguration)
void	setAuthenticationRetryCount(Integer authenticationRetryCount)
void	setAuthenticationSettings(SignerAuthenticationSettings authenticationSettings)
void	setAuthenticationType(String authenticationType)
void	setDeclineMessage(String declineMessage)
void	setEnableAccessCode(Boolean enableAccessCode)
void	setEnableEmailOTP(Boolean enableEmailOTP)
void	setIdVerification(IdVerification idVerification)
void	setIsAuthenticationFailed(Boolean isAuthenticationFailed)
void	setIsDeliveryFailed(Boolean isDeliveryFailed)
void	setIsReassigned(Boolean isReassigned)
void	setIsViewed(Boolean isViewed)
void	setLastActivityDate(OffsetDateTime lastActivityDate)
void	setLastReminderSentOn(OffsetDateTime lastReminderSentOn)
void	setOrder(Integer order)
void	setPhoneNumber(PhoneNumberWebhookModel phoneNumber)
void	setReassignMessage(String reassignMessage)
void	setSignerEmail(String signerEmail)
void	setSignerName(String signerName)
void	setSignerRole(String signerRole)
void	setSignerType(String signerType)
void	setStatus(DocumentSignerWebhookModel.StatusEnum status)
DocumentSignerWebhookModel	signerEmail(String signerEmail)
DocumentSignerWebhookModel	signerName(String signerName)
DocumentSignerWebhookModel	signerRole(String signerRole)
DocumentSignerWebhookModel	signerType(String signerType)
DocumentSignerWebhookModel	status(DocumentSignerWebhookModel.StatusEnum status)
String	toJson()	Convert an instance of DocumentSignerWebhookModel 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 Detail

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_IS_AUTHENTICATION_FAILED

public static final String SERIALIZED_NAME_IS_AUTHENTICATION_FAILED

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_IS_DELIVERY_FAILED

public static final String SERIALIZED_NAME_IS_DELIVERY_FAILED

See Also:

Constant Field Values

SERIALIZED_NAME_IS_VIEWED

public static final String SERIALIZED_NAME_IS_VIEWED

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_IS_REASSIGNED

public static final String SERIALIZED_NAME_IS_REASSIGNED

See Also:

Constant Field Values

SERIALIZED_NAME_REASSIGN_MESSAGE

public static final String SERIALIZED_NAME_REASSIGN_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_DECLINE_MESSAGE

public static final String SERIALIZED_NAME_DECLINE_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_ACTIVITY_DATE

public static final String SERIALIZED_NAME_LAST_ACTIVITY_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_TYPE

public static final String SERIALIZED_NAME_AUTHENTICATION_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_ID_VERIFICATION

public static final String SERIALIZED_NAME_ID_VERIFICATION

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_LAST_REMINDER_SENT_ON

public static final String SERIALIZED_NAME_LAST_REMINDER_SENT_ON

See Also:

Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT

public static final String SERIALIZED_NAME_AUTHENTICATION_RETRY_COUNT

See Also:

Constant Field Values

SERIALIZED_NAME_AUTHENTICATION_SETTINGS

public static final String SERIALIZED_NAME_AUTHENTICATION_SETTINGS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

DocumentSignerWebhookModel

public DocumentSignerWebhookModel()

Method Detail

signerName

public DocumentSignerWebhookModel signerName(String signerName)

getSignerName

@Nullable
public String getSignerName()

Get signerName

Returns:

signerName

setSignerName

public void setSignerName(String signerName)

signerRole

public DocumentSignerWebhookModel signerRole(String signerRole)

getSignerRole

@Nullable
public String getSignerRole()

Get signerRole

Returns:

signerRole

setSignerRole

public void setSignerRole(String signerRole)

signerEmail

public DocumentSignerWebhookModel signerEmail(String signerEmail)

getSignerEmail

@Nullable
public String getSignerEmail()

Get signerEmail

Returns:

signerEmail

setSignerEmail

public void setSignerEmail(String signerEmail)

phoneNumber

public DocumentSignerWebhookModel phoneNumber(PhoneNumberWebhookModel phoneNumber)

getPhoneNumber

@Nullable
public PhoneNumberWebhookModel getPhoneNumber()

Get phoneNumber

Returns:

phoneNumber

setPhoneNumber

public void setPhoneNumber(PhoneNumberWebhookModel phoneNumber)

status

public DocumentSignerWebhookModel status(DocumentSignerWebhookModel.StatusEnum status)

getStatus

@Nullable
public DocumentSignerWebhookModel.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(DocumentSignerWebhookModel.StatusEnum status)

enableAccessCode

public DocumentSignerWebhookModel enableAccessCode(Boolean enableAccessCode)

getEnableAccessCode

@Nullable
public Boolean getEnableAccessCode()

Get enableAccessCode

Returns:

enableAccessCode

setEnableAccessCode

public void setEnableAccessCode(Boolean enableAccessCode)

isAuthenticationFailed

public DocumentSignerWebhookModel isAuthenticationFailed(Boolean isAuthenticationFailed)

getIsAuthenticationFailed

@Nullable
public Boolean getIsAuthenticationFailed()

Get isAuthenticationFailed

Returns:

isAuthenticationFailed

setIsAuthenticationFailed

public void setIsAuthenticationFailed(Boolean isAuthenticationFailed)

enableEmailOTP

public DocumentSignerWebhookModel enableEmailOTP(Boolean enableEmailOTP)

getEnableEmailOTP

@Nullable
public Boolean getEnableEmailOTP()

Get enableEmailOTP

Returns:

enableEmailOTP

setEnableEmailOTP

public void setEnableEmailOTP(Boolean enableEmailOTP)

isDeliveryFailed

public DocumentSignerWebhookModel isDeliveryFailed(Boolean isDeliveryFailed)

getIsDeliveryFailed

@Nullable
public Boolean getIsDeliveryFailed()

Get isDeliveryFailed

Returns:

isDeliveryFailed

setIsDeliveryFailed

public void setIsDeliveryFailed(Boolean isDeliveryFailed)

isViewed

public DocumentSignerWebhookModel isViewed(Boolean isViewed)

getIsViewed

@Nullable
public Boolean getIsViewed()

Get isViewed

Returns:

isViewed

setIsViewed

public void setIsViewed(Boolean isViewed)

order

public DocumentSignerWebhookModel order(Integer order)

getOrder

@Nullable
public Integer getOrder()

Get order

Returns:

order

setOrder

public void setOrder(Integer order)

signerType

public DocumentSignerWebhookModel signerType(String signerType)

getSignerType

@Nullable
public String getSignerType()

Get signerType

Returns:

signerType

setSignerType

public void setSignerType(String signerType)

isReassigned

public DocumentSignerWebhookModel isReassigned(Boolean isReassigned)

getIsReassigned

@Nullable
public Boolean getIsReassigned()

Get isReassigned

Returns:

isReassigned

setIsReassigned

public void setIsReassigned(Boolean isReassigned)

reassignMessage

public DocumentSignerWebhookModel reassignMessage(String reassignMessage)

getReassignMessage

@Nullable
public String getReassignMessage()

Get reassignMessage

Returns:

reassignMessage

setReassignMessage

public void setReassignMessage(String reassignMessage)

declineMessage

public DocumentSignerWebhookModel declineMessage(String declineMessage)

getDeclineMessage

@Nullable
public String getDeclineMessage()

Get declineMessage

Returns:

declineMessage

setDeclineMessage

public void setDeclineMessage(String declineMessage)

lastActivityDate

public DocumentSignerWebhookModel lastActivityDate(OffsetDateTime lastActivityDate)

getLastActivityDate

@Nullable
public OffsetDateTime getLastActivityDate()

Get lastActivityDate

Returns:

lastActivityDate

setLastActivityDate

public void setLastActivityDate(OffsetDateTime lastActivityDate)

authenticationType

public DocumentSignerWebhookModel authenticationType(String authenticationType)

getAuthenticationType

@Nullable
public String getAuthenticationType()

Get authenticationType

Returns:

authenticationType

setAuthenticationType

public void setAuthenticationType(String authenticationType)

idVerification

public DocumentSignerWebhookModel idVerification(IdVerification idVerification)

getIdVerification

@Nullable
public IdVerification getIdVerification()

Get idVerification

Returns:

idVerification

setIdVerification

public void setIdVerification(IdVerification idVerification)

allowFieldConfiguration

public DocumentSignerWebhookModel allowFieldConfiguration(Boolean allowFieldConfiguration)

getAllowFieldConfiguration

@Nullable
public Boolean getAllowFieldConfiguration()

Get allowFieldConfiguration

Returns:

allowFieldConfiguration

setAllowFieldConfiguration

public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)

lastReminderSentOn

public DocumentSignerWebhookModel lastReminderSentOn(OffsetDateTime lastReminderSentOn)

getLastReminderSentOn

@Nullable
public OffsetDateTime getLastReminderSentOn()

Get lastReminderSentOn

Returns:

lastReminderSentOn

setLastReminderSentOn

public void setLastReminderSentOn(OffsetDateTime lastReminderSentOn)

authenticationRetryCount

public DocumentSignerWebhookModel authenticationRetryCount(Integer authenticationRetryCount)

getAuthenticationRetryCount

@Nullable
public Integer getAuthenticationRetryCount()

Get authenticationRetryCount

Returns:

authenticationRetryCount

setAuthenticationRetryCount

public void setAuthenticationRetryCount(Integer authenticationRetryCount)

authenticationSettings

public DocumentSignerWebhookModel authenticationSettings(SignerAuthenticationSettings authenticationSettings)

getAuthenticationSettings

@Nullable
public SignerAuthenticationSettings getAuthenticationSettings()

Get authenticationSettings

Returns:

authenticationSettings

setAuthenticationSettings

public void setAuthenticationSettings(SignerAuthenticationSettings authenticationSettings)

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 DocumentSignerWebhookModel

fromJson

public static DocumentSignerWebhookModel fromJson(String jsonString)
                                           throws IOException

Create an instance of DocumentSignerWebhookModel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentSignerWebhookModel

Throws:

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

toJson

public String toJson()

Convert an instance of DocumentSignerWebhookModel to an JSON string

Returns:

JSON string