Package com.boldsign.model

Class DocumentEvent

java.lang.Object

com.boldsign.model.DocumentEvent

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

DocumentEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentEvent.CustomTypeAdapterFactory
static class	DocumentEvent.FailedDeliveryModeEnum	Gets or Sets failedDeliveryMode
static class	DocumentEvent.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_BRAND_ID
static String	SERIALIZED_NAME_CC_DETAILS
static String	SERIALIZED_NAME_CREATED_DATE
static String	SERIALIZED_NAME_DISABLE_EMAILS
static String	SERIALIZED_NAME_DOCUMENT_DESCRIPTION
static String	SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
static String	SERIALIZED_NAME_DOCUMENT_ID
static String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static String	SERIALIZED_NAME_ERROR_MESSAGE
static String	SERIALIZED_NAME_EXPIRY_DATE
static String	SERIALIZED_NAME_FAILED_DELIVERY_MODE
static String	SERIALIZED_NAME_IS_COMBINED_ATTACHMENT
static String	SERIALIZED_NAME_IS_COMBINED_AUDIT
static String	SERIALIZED_NAME_LABELS
static String	SERIALIZED_NAME_MESSAGE_TITLE
static String	SERIALIZED_NAME_META_DATA
static String	SERIALIZED_NAME_OBJECT
static String	SERIALIZED_NAME_ON_BEHALF_OF
static String	SERIALIZED_NAME_REVOKE_MESSAGE
static String	SERIALIZED_NAME_SENDER_DETAIL
static String	SERIALIZED_NAME_SIGNER_DETAILS
static String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor	Description
DocumentEvent()

Method Summary

Modifier and Type	Method	Description
DocumentEvent	_object(String _object)
DocumentEvent	addCcDetailsItem(DocumentCcWebhookModel ccDetailsItem)
DocumentEvent	addLabelsItem(String labelsItem)
DocumentEvent	addSignerDetailsItem(DocumentSignerWebhookModel signerDetailsItem)
DocumentEvent	brandId(String brandId)
DocumentEvent	ccDetails(List<DocumentCcWebhookModel> ccDetails)
DocumentEvent	createdDate(OffsetDateTime createdDate)
Map<String,Object>	createFormData()
DocumentEvent	disableEmails(Boolean disableEmails)
DocumentEvent	documentDescription(String documentDescription)
DocumentEvent	documentDownloadOption(String documentDownloadOption)
DocumentEvent	documentId(String documentId)
DocumentEvent	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
DocumentEvent	errorMessage(String errorMessage)
DocumentEvent	expiryDate(OffsetDateTime expiryDate)
DocumentEvent	failedDeliveryMode(DocumentEvent.FailedDeliveryModeEnum failedDeliveryMode)
static DocumentEvent	fromJson(String jsonString)	Create an instance of DocumentEvent given an JSON string
String	getBrandId()	Get brandId
List<DocumentCcWebhookModel>	getCcDetails()	Get ccDetails
OffsetDateTime	getCreatedDate()	Get createdDate
Boolean	getDisableEmails()	Get disableEmails
String	getDocumentDescription()	Get documentDescription
String	getDocumentDownloadOption()	Get documentDownloadOption
String	getDocumentId()	Get documentId
Boolean	getEnableSigningOrder()	Get enableSigningOrder
String	getErrorMessage()	Get errorMessage
OffsetDateTime	getExpiryDate()	Get expiryDate
DocumentEvent.FailedDeliveryModeEnum	getFailedDeliveryMode()	Get failedDeliveryMode
Boolean	getIsCombinedAttachment()	Get isCombinedAttachment
Boolean	getIsCombinedAudit()	Get isCombinedAudit
List<String>	getLabels()	Get labels
String	getMessageTitle()	Get messageTitle
Map<String,String>	getMetaData()	Get metaData
String	getObject()	Get _object
String	getOnBehalfOf()	Get onBehalfOf
String	getRevokeMessage()	Get revokeMessage
DocumentSender	getSenderDetail()	Get senderDetail
List<DocumentSignerWebhookModel>	getSignerDetails()	Get signerDetails
DocumentEvent.StatusEnum	getStatus()	Get status
int	hashCode()
DocumentEvent	isCombinedAttachment(Boolean isCombinedAttachment)
DocumentEvent	isCombinedAudit(Boolean isCombinedAudit)
DocumentEvent	labels(List<String> labels)
DocumentEvent	messageTitle(String messageTitle)
DocumentEvent	metaData(Map<String,String> metaData)
DocumentEvent	onBehalfOf(String onBehalfOf)
DocumentEvent	putMetaDataItem(String key, String metaDataItem)
DocumentEvent	revokeMessage(String revokeMessage)
DocumentEvent	senderDetail(DocumentSender senderDetail)
void	setBrandId(String brandId)
void	setCcDetails(List<DocumentCcWebhookModel> ccDetails)
void	setCreatedDate(OffsetDateTime createdDate)
void	setDisableEmails(Boolean disableEmails)
void	setDocumentDescription(String documentDescription)
void	setDocumentDownloadOption(String documentDownloadOption)
void	setDocumentId(String documentId)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setErrorMessage(String errorMessage)
void	setExpiryDate(OffsetDateTime expiryDate)
void	setFailedDeliveryMode(DocumentEvent.FailedDeliveryModeEnum failedDeliveryMode)
void	setIsCombinedAttachment(Boolean isCombinedAttachment)
void	setIsCombinedAudit(Boolean isCombinedAudit)
void	setLabels(List<String> labels)
void	setMessageTitle(String messageTitle)
void	setMetaData(Map<String,String> metaData)
void	setObject(String _object)
void	setOnBehalfOf(String onBehalfOf)
void	setRevokeMessage(String revokeMessage)
void	setSenderDetail(DocumentSender senderDetail)
void	setSignerDetails(List<DocumentSignerWebhookModel> signerDetails)
void	setStatus(DocumentEvent.StatusEnum status)
DocumentEvent	signerDetails(List<DocumentSignerWebhookModel> signerDetails)
DocumentEvent	status(DocumentEvent.StatusEnum status)
String	toJson()	Convert an instance of DocumentEvent 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_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_ID

public static final String SERIALIZED_NAME_DOCUMENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_MESSAGE_TITLE

public static final String SERIALIZED_NAME_MESSAGE_TITLE

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_DESCRIPTION

public static final String SERIALIZED_NAME_DOCUMENT_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_SENDER_DETAIL

public static final String SERIALIZED_NAME_SENDER_DETAIL

See Also:

Constant Field Values

SERIALIZED_NAME_SIGNER_DETAILS

public static final String SERIALIZED_NAME_SIGNER_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_CC_DETAILS

public static final String SERIALIZED_NAME_CC_DETAILS

See Also:

Constant Field Values

SERIALIZED_NAME_ON_BEHALF_OF

public static final String SERIALIZED_NAME_ON_BEHALF_OF

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_DATE

public static final String SERIALIZED_NAME_CREATED_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_EXPIRY_DATE

public static final String SERIALIZED_NAME_EXPIRY_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_ENABLE_SIGNING_ORDER

public static final String SERIALIZED_NAME_ENABLE_SIGNING_ORDER

See Also:

Constant Field Values

SERIALIZED_NAME_DISABLE_EMAILS

public static final String SERIALIZED_NAME_DISABLE_EMAILS

See Also:

Constant Field Values

SERIALIZED_NAME_REVOKE_MESSAGE

public static final String SERIALIZED_NAME_REVOKE_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_ERROR_MESSAGE

public static final String SERIALIZED_NAME_ERROR_MESSAGE

See Also:

Constant Field Values

SERIALIZED_NAME_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

Constant Field Values

SERIALIZED_NAME_IS_COMBINED_AUDIT

public static final String SERIALIZED_NAME_IS_COMBINED_AUDIT

See Also:

Constant Field Values

SERIALIZED_NAME_IS_COMBINED_ATTACHMENT

public static final String SERIALIZED_NAME_IS_COMBINED_ATTACHMENT

See Also:

Constant Field Values

SERIALIZED_NAME_BRAND_ID

public static final String SERIALIZED_NAME_BRAND_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION

public static final String SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION

See Also:

Constant Field Values

SERIALIZED_NAME_META_DATA

public static final String SERIALIZED_NAME_META_DATA

See Also:

Constant Field Values

SERIALIZED_NAME_FAILED_DELIVERY_MODE

public static final String SERIALIZED_NAME_FAILED_DELIVERY_MODE

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

DocumentEvent

public DocumentEvent()

Method Detail

_object

public DocumentEvent _object(String _object)

getObject

@Nullable
public String getObject()

Get _object

Returns:

_object

setObject

public void setObject(String _object)

documentId

public DocumentEvent documentId(String documentId)

getDocumentId

@Nullable
public String getDocumentId()

Get documentId

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

messageTitle

public DocumentEvent messageTitle(String messageTitle)

getMessageTitle

@Nullable
public String getMessageTitle()

Get messageTitle

Returns:

messageTitle

setMessageTitle

public void setMessageTitle(String messageTitle)

documentDescription

public DocumentEvent documentDescription(String documentDescription)

getDocumentDescription

@Nullable
public String getDocumentDescription()

Get documentDescription

Returns:

documentDescription

setDocumentDescription

public void setDocumentDescription(String documentDescription)

status

public DocumentEvent status(DocumentEvent.StatusEnum status)

getStatus

@Nullable
public DocumentEvent.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(DocumentEvent.StatusEnum status)

senderDetail

public DocumentEvent senderDetail(DocumentSender senderDetail)

getSenderDetail

@Nullable
public DocumentSender getSenderDetail()

Get senderDetail

Returns:

senderDetail

setSenderDetail

public void setSenderDetail(DocumentSender senderDetail)

signerDetails

public DocumentEvent signerDetails(List<DocumentSignerWebhookModel> signerDetails)

addSignerDetailsItem

public DocumentEvent addSignerDetailsItem(DocumentSignerWebhookModel signerDetailsItem)

getSignerDetails

@Nullable
public List<DocumentSignerWebhookModel> getSignerDetails()

Get signerDetails

Returns:

signerDetails

setSignerDetails

public void setSignerDetails(List<DocumentSignerWebhookModel> signerDetails)

ccDetails

public DocumentEvent ccDetails(List<DocumentCcWebhookModel> ccDetails)

addCcDetailsItem

public DocumentEvent addCcDetailsItem(DocumentCcWebhookModel ccDetailsItem)

getCcDetails

@Nullable
public List<DocumentCcWebhookModel> getCcDetails()

Get ccDetails

Returns:

ccDetails

setCcDetails

public void setCcDetails(List<DocumentCcWebhookModel> ccDetails)

onBehalfOf

public DocumentEvent onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

createdDate

public DocumentEvent createdDate(OffsetDateTime createdDate)

getCreatedDate

@Nullable
public OffsetDateTime getCreatedDate()

Get createdDate

Returns:

createdDate

setCreatedDate

public void setCreatedDate(OffsetDateTime createdDate)

expiryDate

public DocumentEvent expiryDate(OffsetDateTime expiryDate)

getExpiryDate

@Nullable
public OffsetDateTime getExpiryDate()

Get expiryDate

Returns:

expiryDate

setExpiryDate

public void setExpiryDate(OffsetDateTime expiryDate)

enableSigningOrder

public DocumentEvent enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

disableEmails

public DocumentEvent disableEmails(Boolean disableEmails)

getDisableEmails

@Nullable
public Boolean getDisableEmails()

Get disableEmails

Returns:

disableEmails

setDisableEmails

public void setDisableEmails(Boolean disableEmails)

revokeMessage

public DocumentEvent revokeMessage(String revokeMessage)

getRevokeMessage

@Nullable
public String getRevokeMessage()

Get revokeMessage

Returns:

revokeMessage

setRevokeMessage

public void setRevokeMessage(String revokeMessage)

errorMessage

public DocumentEvent errorMessage(String errorMessage)

getErrorMessage

@Nullable
public String getErrorMessage()

Get errorMessage

Returns:

errorMessage

setErrorMessage

public void setErrorMessage(String errorMessage)

labels

public DocumentEvent labels(List<String> labels)

addLabelsItem

public DocumentEvent addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

isCombinedAudit

public DocumentEvent isCombinedAudit(Boolean isCombinedAudit)

getIsCombinedAudit

@Nullable
public Boolean getIsCombinedAudit()

Get isCombinedAudit

Returns:

isCombinedAudit

setIsCombinedAudit

public void setIsCombinedAudit(Boolean isCombinedAudit)

isCombinedAttachment

public DocumentEvent isCombinedAttachment(Boolean isCombinedAttachment)

getIsCombinedAttachment

@Nullable
public Boolean getIsCombinedAttachment()

Get isCombinedAttachment

Returns:

isCombinedAttachment

setIsCombinedAttachment

public void setIsCombinedAttachment(Boolean isCombinedAttachment)

brandId

public DocumentEvent brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

documentDownloadOption

public DocumentEvent documentDownloadOption(String documentDownloadOption)

getDocumentDownloadOption

@Nullable
public String getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(String documentDownloadOption)

metaData

public DocumentEvent metaData(Map<String,String> metaData)

putMetaDataItem

public DocumentEvent putMetaDataItem(String key,
                                     String metaDataItem)

getMetaData

@Nullable
public Map<String,String> getMetaData()

Get metaData

Returns:

metaData

setMetaData

public void setMetaData(Map<String,String> metaData)

failedDeliveryMode

public DocumentEvent failedDeliveryMode(DocumentEvent.FailedDeliveryModeEnum failedDeliveryMode)

getFailedDeliveryMode

@Nullable
public DocumentEvent.FailedDeliveryModeEnum getFailedDeliveryMode()

Get failedDeliveryMode

Returns:

failedDeliveryMode

setFailedDeliveryMode

public void setFailedDeliveryMode(DocumentEvent.FailedDeliveryModeEnum failedDeliveryMode)

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 DocumentEvent

fromJson

public static DocumentEvent fromJson(String jsonString)
                              throws IOException

Create an instance of DocumentEvent given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentEvent

Throws:

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

toJson

public String toJson()

Convert an instance of DocumentEvent to an JSON string

Returns:

JSON string