Class Document

java.lang.Object

com.boldsign.model.Document

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

Document

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.CustomTypeAdapterFactory
static enum	Document.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_ACTIVITY_BY
static final String	SERIALIZED_NAME_ACTIVITY_DATE
static final String	SERIALIZED_NAME_BRAND_ID
static final String	SERIALIZED_NAME_CC_DETAILS
static final String	SERIALIZED_NAME_CREATED_DATE
static final String	SERIALIZED_NAME_CURSOR
static final String	SERIALIZED_NAME_DOCUMENT_ID
static final String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static final String	SERIALIZED_NAME_EXPIRY_DATE
static final String	SERIALIZED_NAME_IS_DELETED
static final String	SERIALIZED_NAME_LABELS
static final String	SERIALIZED_NAME_MESSAGE_TITLE
static final String	SERIALIZED_NAME_SCHEDULED_SEND_TIME
static final String	SERIALIZED_NAME_SENDER_DETAIL
static final String	SERIALIZED_NAME_SIGNER_DETAILS
static final String	SERIALIZED_NAME_STATUS

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
Document	activityBy(String activityBy)
Document	activityDate(Long activityDate)
Document	addCcDetailsItem(DocumentCcDetails ccDetailsItem)
Document	addLabelsItem(String labelsItem)
Document	addSignerDetailsItem(DocumentSignerDetails signerDetailsItem)
Document	brandId(String brandId)
Document	ccDetails(List<DocumentCcDetails> ccDetails)
Document	createdDate(Long createdDate)
Map<String,Object>	createFormData()
Document	cursor(Long cursor)
Document	documentId(String documentId)
Document	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
Document	expiryDate(Long expiryDate)
static Document	fromJson(String jsonString)	Create an instance of Document given an JSON string
String	getActivityBy()	Get activityBy
Long	getActivityDate()	Get activityDate
String	getBrandId()	Get brandId
List<DocumentCcDetails>	getCcDetails()	Get ccDetails
Long	getCreatedDate()	Get createdDate
Long	getCursor()	Get cursor
String	getDocumentId()	Get documentId
Boolean	getEnableSigningOrder()	Get enableSigningOrder
Long	getExpiryDate()	Get expiryDate
Boolean	getIsDeleted()	Get isDeleted
List<String>	getLabels()	Get labels
String	getMessageTitle()	Get messageTitle
Long	getScheduledSendTime()	Get scheduledSendTime
DocumentSenderDetail	getSenderDetail()	Get senderDetail
List<DocumentSignerDetails>	getSignerDetails()	Get signerDetails
Document.StatusEnum	getStatus()	Get status
int	hashCode()
Document	isDeleted(Boolean isDeleted)
Document	labels(List<String> labels)
Document	messageTitle(String messageTitle)
Document	scheduledSendTime(Long scheduledSendTime)
Document	senderDetail(DocumentSenderDetail senderDetail)
void	setActivityBy(String activityBy)
void	setActivityDate(Long activityDate)
void	setBrandId(String brandId)
void	setCcDetails(List<DocumentCcDetails> ccDetails)
void	setCreatedDate(Long createdDate)
void	setCursor(Long cursor)
void	setDocumentId(String documentId)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setExpiryDate(Long expiryDate)
void	setIsDeleted(Boolean isDeleted)
void	setLabels(List<String> labels)
void	setMessageTitle(String messageTitle)
void	setScheduledSendTime(Long scheduledSendTime)
void	setSenderDetail(DocumentSenderDetail senderDetail)
void	setSignerDetails(List<DocumentSignerDetails> signerDetails)
void	setStatus(Document.StatusEnum status)
Document	signerDetails(List<DocumentSignerDetails> signerDetails)
Document	status(Document.StatusEnum status)
String	toJson()	Convert an instance of Document 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_DOCUMENT_ID

public static final String SERIALIZED_NAME_DOCUMENT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_SENDER_DETAIL

public static final String SERIALIZED_NAME_SENDER_DETAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_CC_DETAILS

public static final String SERIALIZED_NAME_CC_DETAILS

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_DATE

public static final String SERIALIZED_NAME_CREATED_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVITY_DATE

public static final String SERIALIZED_NAME_ACTIVITY_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVITY_BY

public static final String SERIALIZED_NAME_ACTIVITY_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_MESSAGE_TITLE

public static final String SERIALIZED_NAME_MESSAGE_TITLE

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_SIGNER_DETAILS

public static final String SERIALIZED_NAME_SIGNER_DETAILS

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_IS_DELETED

public static final String SERIALIZED_NAME_IS_DELETED

See Also:

• Constant Field Values

SERIALIZED_NAME_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

• Constant Field Values

SERIALIZED_NAME_CURSOR

public static final String SERIALIZED_NAME_CURSOR

See Also:

• Constant Field Values

SERIALIZED_NAME_BRAND_ID

public static final String SERIALIZED_NAME_BRAND_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_SCHEDULED_SEND_TIME

public static final String SERIALIZED_NAME_SCHEDULED_SEND_TIME

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Document

public Document()

Method Details

documentId

public Document documentId(String documentId)

getDocumentId

@Nullable
public String getDocumentId()

Get documentId

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

senderDetail

public Document senderDetail(DocumentSenderDetail senderDetail)

getSenderDetail

@Nullable
public DocumentSenderDetail getSenderDetail()

Get senderDetail

Returns:

senderDetail

setSenderDetail

public void setSenderDetail(DocumentSenderDetail senderDetail)

ccDetails

public Document ccDetails(List<DocumentCcDetails> ccDetails)

addCcDetailsItem

public Document addCcDetailsItem(DocumentCcDetails ccDetailsItem)

getCcDetails

@Nullable
public List<DocumentCcDetails> getCcDetails()

Get ccDetails

Returns:

ccDetails

setCcDetails

public void setCcDetails(List<DocumentCcDetails> ccDetails)

createdDate

public Document createdDate(Long createdDate)

getCreatedDate

@Nullable
public Long getCreatedDate()

Get createdDate

Returns:

createdDate

setCreatedDate

public void setCreatedDate(Long createdDate)

activityDate

public Document activityDate(Long activityDate)

getActivityDate

@Nullable
public Long getActivityDate()

Get activityDate

Returns:

activityDate

setActivityDate

public void setActivityDate(Long activityDate)

activityBy

public Document activityBy(String activityBy)

getActivityBy

@Nullable
public String getActivityBy()

Get activityBy

Returns:

activityBy

setActivityBy

public void setActivityBy(String activityBy)

messageTitle

public Document messageTitle(String messageTitle)

getMessageTitle

@Nullable
public String getMessageTitle()

Get messageTitle

Returns:

messageTitle

setMessageTitle

public void setMessageTitle(String messageTitle)

status

public Document status(Document.StatusEnum status)

getStatus

@Nullable
public Document.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(Document.StatusEnum status)

signerDetails

public Document signerDetails(List<DocumentSignerDetails> signerDetails)

addSignerDetailsItem

public Document addSignerDetailsItem(DocumentSignerDetails signerDetailsItem)

getSignerDetails

@Nullable
public List<DocumentSignerDetails> getSignerDetails()

Get signerDetails

Returns:

signerDetails

setSignerDetails

public void setSignerDetails(List<DocumentSignerDetails> signerDetails)

expiryDate

public Document expiryDate(Long expiryDate)

getExpiryDate

@Nullable
public Long getExpiryDate()

Get expiryDate

Returns:

expiryDate

setExpiryDate

public void setExpiryDate(Long expiryDate)

enableSigningOrder

public Document enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

isDeleted

public Document isDeleted(Boolean isDeleted)

getIsDeleted

@Nullable
public Boolean getIsDeleted()

Get isDeleted

Returns:

isDeleted

setIsDeleted

public void setIsDeleted(Boolean isDeleted)

labels

public Document labels(List<String> labels)

addLabelsItem

public Document addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

cursor

public Document cursor(Long cursor)

getCursor

@Nullable
public Long getCursor()

Get cursor

Returns:

cursor

setCursor

public void setCursor(Long cursor)

brandId

public Document brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

scheduledSendTime

public Document scheduledSendTime(Long scheduledSendTime)

getScheduledSendTime

@Nullable
public Long getScheduledSendTime()

Get scheduledSendTime

Returns:

scheduledSendTime

setScheduledSendTime

public void setScheduledSendTime(Long scheduledSendTime)

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 Document

fromJson

public static Document fromJson(String jsonString)
                         throws IOException

Create an instance of Document given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Document

Throws:

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

toJson

public String toJson()

Convert an instance of Document to an JSON string

Returns:

JSON string