Class Template

java.lang.Object

com.boldsign.model.Template

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

Template

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Template.AccessTypeEnum	Gets or Sets accessType
static class	Template.CustomTypeAdapterFactory
static enum	Template.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_ACCESS_TID
static final String	SERIALIZED_NAME_ACCESS_TYPE
static final String	SERIALIZED_NAME_ACTIVITY_BY
static final String	SERIALIZED_NAME_ACTIVITY_DATE
static final String	SERIALIZED_NAME_BEHALF_OF
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_DOCUMENT_ID
static final String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static final String	SERIALIZED_NAME_IS_TEMPLATE
static final String	SERIALIZED_NAME_LABELS
static final String	SERIALIZED_NAME_MESSAGE_TITLE
static final String	SERIALIZED_NAME_SENDER_DETAIL
static final String	SERIALIZED_NAME_SIGNER_DETAILS
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_TEMPLATE_DESCRIPTION
static final String	SERIALIZED_NAME_TEMPLATE_LABELS
static final String	SERIALIZED_NAME_TEMPLATE_NAME

Constructor Summary

Constructors

Constructor	Description
Template()

Method Summary

Modifier and Type	Method	Description
Template	accessTid(String accessTid)
Template	accessType(Template.AccessTypeEnum accessType)
Template	activityBy(String activityBy)
Template	activityDate(Long activityDate)
Template	addCcDetailsItem(TemplateCC ccDetailsItem)
Template	addLabelsItem(String labelsItem)
Template	addSignerDetailsItem(TemplateSignerDetails signerDetailsItem)
Template	addTemplateLabelsItem(String templateLabelsItem)
Template	behalfOf(BehalfOf behalfOf)
Template	brandId(String brandId)
Template	ccDetails(List<TemplateCC> ccDetails)
Template	createdDate(Long createdDate)
Map<String,Object>	createFormData()
Template	documentId(String documentId)
Template	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
static Template	fromJson(String jsonString)	Create an instance of Template given an JSON string
String	getAccessTid()	Get accessTid
Template.AccessTypeEnum	getAccessType()	Get accessType
String	getActivityBy()	Get activityBy
Long	getActivityDate()	Get activityDate
BehalfOf	getBehalfOf()	Get behalfOf
String	getBrandId()	Get brandId
List<TemplateCC>	getCcDetails()	Get ccDetails
Long	getCreatedDate()	Get createdDate
String	getDocumentId()	Get documentId
Boolean	getEnableSigningOrder()	Get enableSigningOrder
Boolean	getIsTemplate()	Get isTemplate
List<String>	getLabels()	Get labels
String	getMessageTitle()	Get messageTitle
TemplateSenderDetails	getSenderDetail()	Get senderDetail
List<TemplateSignerDetails>	getSignerDetails()	Get signerDetails
Template.StatusEnum	getStatus()	Get status
String	getTemplateDescription()	Get templateDescription
List<String>	getTemplateLabels()	Get templateLabels
String	getTemplateName()	Get templateName
int	hashCode()
Template	isTemplate(Boolean isTemplate)
Template	labels(List<String> labels)
Template	messageTitle(String messageTitle)
Template	senderDetail(TemplateSenderDetails senderDetail)
void	setAccessTid(String accessTid)
void	setAccessType(Template.AccessTypeEnum accessType)
void	setActivityBy(String activityBy)
void	setActivityDate(Long activityDate)
void	setBehalfOf(BehalfOf behalfOf)
void	setBrandId(String brandId)
void	setCcDetails(List<TemplateCC> ccDetails)
void	setCreatedDate(Long createdDate)
void	setDocumentId(String documentId)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setIsTemplate(Boolean isTemplate)
void	setLabels(List<String> labels)
void	setMessageTitle(String messageTitle)
void	setSenderDetail(TemplateSenderDetails senderDetail)
void	setSignerDetails(List<TemplateSignerDetails> signerDetails)
void	setStatus(Template.StatusEnum status)
void	setTemplateDescription(String templateDescription)
void	setTemplateLabels(List<String> templateLabels)
void	setTemplateName(String templateName)
Template	signerDetails(List<TemplateSignerDetails> signerDetails)
Template	status(Template.StatusEnum status)
Template	templateDescription(String templateDescription)
Template	templateLabels(List<String> templateLabels)
Template	templateName(String templateName)
String	toJson()	Convert an instance of Template 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_ENABLE_SIGNING_ORDER

public static final String SERIALIZED_NAME_ENABLE_SIGNING_ORDER

See Also:

• Constant Field Values

SERIALIZED_NAME_TEMPLATE_NAME

public static final String SERIALIZED_NAME_TEMPLATE_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_TEMPLATE_DESCRIPTION

public static final String SERIALIZED_NAME_TEMPLATE_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_ACCESS_TYPE

public static final String SERIALIZED_NAME_ACCESS_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_ACCESS_TID

public static final String SERIALIZED_NAME_ACCESS_TID

See Also:

• Constant Field Values

SERIALIZED_NAME_IS_TEMPLATE

public static final String SERIALIZED_NAME_IS_TEMPLATE

See Also:

• Constant Field Values

SERIALIZED_NAME_BEHALF_OF

public static final String SERIALIZED_NAME_BEHALF_OF

See Also:

• Constant Field Values

SERIALIZED_NAME_TEMPLATE_LABELS

public static final String SERIALIZED_NAME_TEMPLATE_LABELS

See Also:

• Constant Field Values

SERIALIZED_NAME_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

• Constant Field Values

SERIALIZED_NAME_BRAND_ID

public static final String SERIALIZED_NAME_BRAND_ID

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Template

public Template()

Method Details

documentId

public Template documentId(String documentId)

getDocumentId

@Nullable
public String getDocumentId()

Get documentId

Returns:

documentId

setDocumentId

public void setDocumentId(String documentId)

senderDetail

public Template senderDetail(TemplateSenderDetails senderDetail)

getSenderDetail

@Nullable
public TemplateSenderDetails getSenderDetail()

Get senderDetail

Returns:

senderDetail

setSenderDetail

public void setSenderDetail(TemplateSenderDetails senderDetail)

ccDetails

public Template ccDetails(List<TemplateCC> ccDetails)

addCcDetailsItem

public Template addCcDetailsItem(TemplateCC ccDetailsItem)

getCcDetails

@Nullable
public List<TemplateCC> getCcDetails()

Get ccDetails

Returns:

ccDetails

setCcDetails

public void setCcDetails(List<TemplateCC> ccDetails)

createdDate

public Template createdDate(Long createdDate)

getCreatedDate

@Nullable
public Long getCreatedDate()

Get createdDate

Returns:

createdDate

setCreatedDate

public void setCreatedDate(Long createdDate)

activityDate

public Template activityDate(Long activityDate)

getActivityDate

@Nullable
public Long getActivityDate()

Get activityDate

Returns:

activityDate

setActivityDate

public void setActivityDate(Long activityDate)

activityBy

public Template activityBy(String activityBy)

getActivityBy

@Nullable
public String getActivityBy()

Get activityBy

Returns:

activityBy

setActivityBy

public void setActivityBy(String activityBy)

messageTitle

public Template messageTitle(String messageTitle)

getMessageTitle

@Nullable
public String getMessageTitle()

Get messageTitle

Returns:

messageTitle

setMessageTitle

public void setMessageTitle(String messageTitle)

status

public Template status(Template.StatusEnum status)

getStatus

@Nullable
public Template.StatusEnum getStatus()

Get status

Returns:

status

setStatus

public void setStatus(Template.StatusEnum status)

signerDetails

public Template signerDetails(List<TemplateSignerDetails> signerDetails)

addSignerDetailsItem

public Template addSignerDetailsItem(TemplateSignerDetails signerDetailsItem)

getSignerDetails

@Nullable
public List<TemplateSignerDetails> getSignerDetails()

Get signerDetails

Returns:

signerDetails

setSignerDetails

public void setSignerDetails(List<TemplateSignerDetails> signerDetails)

enableSigningOrder

public Template enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

templateName

public Template templateName(String templateName)

getTemplateName

@Nullable
public String getTemplateName()

Get templateName

Returns:

templateName

setTemplateName

public void setTemplateName(String templateName)

templateDescription

public Template templateDescription(String templateDescription)

getTemplateDescription

@Nullable
public String getTemplateDescription()

Get templateDescription

Returns:

templateDescription

setTemplateDescription

public void setTemplateDescription(String templateDescription)

accessType

public Template accessType(Template.AccessTypeEnum accessType)

getAccessType

@Nullable
public Template.AccessTypeEnum getAccessType()

Get accessType

Returns:

accessType

setAccessType

public void setAccessType(Template.AccessTypeEnum accessType)

accessTid

public Template accessTid(String accessTid)

getAccessTid

@Nullable
public String getAccessTid()

Get accessTid

Returns:

accessTid

setAccessTid

public void setAccessTid(String accessTid)

isTemplate

public Template isTemplate(Boolean isTemplate)

getIsTemplate

@Nullable
public Boolean getIsTemplate()

Get isTemplate

Returns:

isTemplate

setIsTemplate

public void setIsTemplate(Boolean isTemplate)

behalfOf

public Template behalfOf(BehalfOf behalfOf)

getBehalfOf

@Nullable
public BehalfOf getBehalfOf()

Get behalfOf

Returns:

behalfOf

setBehalfOf

public void setBehalfOf(BehalfOf behalfOf)

templateLabels

public Template templateLabels(List<String> templateLabels)

addTemplateLabelsItem

public Template addTemplateLabelsItem(String templateLabelsItem)

getTemplateLabels

@Nullable
public List<String> getTemplateLabels()

Get templateLabels

Returns:

templateLabels

setTemplateLabels

public void setTemplateLabels(List<String> templateLabels)

labels

public Template labels(List<String> labels)

addLabelsItem

public Template addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

brandId

public Template brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

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 Template

fromJson

public static Template fromJson(String jsonString)
                         throws IOException

Create an instance of Template given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Template

Throws:

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

toJson

public String toJson()

Convert an instance of Template to an JSON string

Returns:

JSON string