Class TemplateProperties

java.lang.Object

com.boldsign.model.TemplateProperties

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

TemplateProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplateProperties.CustomTypeAdapterFactory
static enum	TemplateProperties.DocumentDownloadOptionEnum	Gets or Sets documentDownloadOption

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ALLOW_MESSAGE_EDITING
static final String	SERIALIZED_NAME_ALLOW_MODIFY_FILES
static final String	SERIALIZED_NAME_ALLOW_NEW_FILES
static final String	SERIALIZED_NAME_ALLOW_NEW_ROLES
static final String	SERIALIZED_NAME_BEHALF_OF
static final String	SERIALIZED_NAME_BRAND_ID
static final String	SERIALIZED_NAME_C_C_DETAILS
static final String	SERIALIZED_NAME_COMMON_FIELDS
static final String	SERIALIZED_NAME_CREATED_BY
static final String	SERIALIZED_NAME_CREATED_DATE
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_DOCUMENT_DOWNLOAD_OPTION
static final String	SERIALIZED_NAME_DOCUMENT_INFO
static final String	SERIALIZED_NAME_DOCUMENT_MESSAGE
static final String	SERIALIZED_NAME_DOCUMENT_TITLE
static final String	SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
static final String	SERIALIZED_NAME_ENABLE_REASSIGN
static final String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static final String	SERIALIZED_NAME_FILES
static final String	SERIALIZED_NAME_FORM_GROUPS
static final String	SERIALIZED_NAME_LABELS
static final String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static final String	SERIALIZED_NAME_ROLES
static final String	SERIALIZED_NAME_SHARED_TEMPLATE_DETAIL
static final String	SERIALIZED_NAME_TEMPLATE_ID
static final String	SERIALIZED_NAME_TEMPLATE_LABELS
static final String	SERIALIZED_NAME_TITLE

Constructor Summary

Constructors

Constructor	Description
TemplateProperties()

Method Summary

Modifier and Type	Method	Description
TemplateProperties	addCCDetailsItem(String cCDetailsItem)
TemplateProperties	addCommonFieldsItem(TemplateFormFields commonFieldsItem)
TemplateProperties	addDocumentInfoItem(DocumentInfo documentInfoItem)
TemplateProperties	addFilesItem(DocumentFiles filesItem)
TemplateProperties	addFormGroupsItem(FormGroup formGroupsItem)
TemplateProperties	addLabelsItem(String labelsItem)
TemplateProperties	addRolesItem(Roles rolesItem)
TemplateProperties	addSharedTemplateDetailItem(TemplateSharedTemplateDetail sharedTemplateDetailItem)
TemplateProperties	addTemplateLabelsItem(String templateLabelsItem)
TemplateProperties	allowMessageEditing(Boolean allowMessageEditing)
TemplateProperties	allowModifyFiles(Boolean allowModifyFiles)
TemplateProperties	allowNewFiles(Boolean allowNewFiles)
TemplateProperties	allowNewRoles(Boolean allowNewRoles)
TemplateProperties	behalfOf(BehalfOf behalfOf)
TemplateProperties	brandId(String brandId)
TemplateProperties	cCDetails(List<String> cCDetails)
TemplateProperties	commonFields(List<TemplateFormFields> commonFields)
TemplateProperties	createdBy(TemplateSenderDetail createdBy)
TemplateProperties	createdDate(Long createdDate)
Map<String,Object>	createFormData()
TemplateProperties	description(String description)
TemplateProperties	documentDownloadOption(TemplateProperties.DocumentDownloadOptionEnum documentDownloadOption)
TemplateProperties	documentInfo(List<DocumentInfo> documentInfo)
TemplateProperties	documentMessage(String documentMessage)
TemplateProperties	documentTitle(String documentTitle)
TemplateProperties	enablePrintAndSign(Boolean enablePrintAndSign)
TemplateProperties	enableReassign(Boolean enableReassign)
TemplateProperties	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
TemplateProperties	files(List<DocumentFiles> files)
TemplateProperties	formGroups(List<FormGroup> formGroups)
static TemplateProperties	fromJson(String jsonString)	Create an instance of TemplateProperties given an JSON string
Boolean	getAllowMessageEditing()	Get allowMessageEditing
Boolean	getAllowModifyFiles()	Get allowModifyFiles
Boolean	getAllowNewFiles()	Get allowNewFiles
Boolean	getAllowNewRoles()	Get allowNewRoles
BehalfOf	getBehalfOf()	Get behalfOf
String	getBrandId()	Get brandId
List<String>	getcCDetails()	Get cCDetails
List<TemplateFormFields>	getCommonFields()	Get commonFields
TemplateSenderDetail	getCreatedBy()	Get createdBy
Long	getCreatedDate()	Get createdDate
String	getDescription()	Get description
TemplateProperties.DocumentDownloadOptionEnum	getDocumentDownloadOption()	Get documentDownloadOption
List<DocumentInfo>	getDocumentInfo()	Get documentInfo
String	getDocumentMessage()	Get documentMessage
String	getDocumentTitle()	Get documentTitle
Boolean	getEnablePrintAndSign()	Get enablePrintAndSign
Boolean	getEnableReassign()	Get enableReassign
Boolean	getEnableSigningOrder()	Get enableSigningOrder
List<DocumentFiles>	getFiles()	Get files
List<FormGroup>	getFormGroups()	Get formGroups
List<String>	getLabels()	Get labels
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
List<Roles>	getRoles()	Get roles
List<TemplateSharedTemplateDetail>	getSharedTemplateDetail()	Get sharedTemplateDetail
String	getTemplateId()	Get templateId
List<String>	getTemplateLabels()	Get templateLabels
String	getTitle()	Get title
int	hashCode()
TemplateProperties	labels(List<String> labels)
TemplateProperties	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
TemplateProperties	roles(List<Roles> roles)
void	setAllowMessageEditing(Boolean allowMessageEditing)
void	setAllowModifyFiles(Boolean allowModifyFiles)
void	setAllowNewFiles(Boolean allowNewFiles)
void	setAllowNewRoles(Boolean allowNewRoles)
void	setBehalfOf(BehalfOf behalfOf)
void	setBrandId(String brandId)
void	setcCDetails(List<String> cCDetails)
void	setCommonFields(List<TemplateFormFields> commonFields)
void	setCreatedBy(TemplateSenderDetail createdBy)
void	setCreatedDate(Long createdDate)
void	setDescription(String description)
void	setDocumentDownloadOption(TemplateProperties.DocumentDownloadOptionEnum documentDownloadOption)
void	setDocumentInfo(List<DocumentInfo> documentInfo)
void	setDocumentMessage(String documentMessage)
void	setDocumentTitle(String documentTitle)
void	setEnablePrintAndSign(Boolean enablePrintAndSign)
void	setEnableReassign(Boolean enableReassign)
void	setEnableSigningOrder(Boolean enableSigningOrder)
void	setFiles(List<DocumentFiles> files)
void	setFormGroups(List<FormGroup> formGroups)
void	setLabels(List<String> labels)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setRoles(List<Roles> roles)
void	setSharedTemplateDetail(List<TemplateSharedTemplateDetail> sharedTemplateDetail)
void	setTemplateId(String templateId)
void	setTemplateLabels(List<String> templateLabels)
void	setTitle(String title)
TemplateProperties	sharedTemplateDetail(List<TemplateSharedTemplateDetail> sharedTemplateDetail)
TemplateProperties	templateId(String templateId)
TemplateProperties	templateLabels(List<String> templateLabels)
TemplateProperties	title(String title)
String	toJson()	Convert an instance of TemplateProperties 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_TEMPLATE_ID

public static final String SERIALIZED_NAME_TEMPLATE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_TITLE

public static final String SERIALIZED_NAME_TITLE

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_DOCUMENT_TITLE

public static final String SERIALIZED_NAME_DOCUMENT_TITLE

See Also:

• Constant Field Values

SERIALIZED_NAME_DOCUMENT_MESSAGE

public static final String SERIALIZED_NAME_DOCUMENT_MESSAGE

See Also:

• Constant Field Values

SERIALIZED_NAME_FILES

public static final String SERIALIZED_NAME_FILES

See Also:

• Constant Field Values

SERIALIZED_NAME_ROLES

public static final String SERIALIZED_NAME_ROLES

See Also:

• Constant Field Values

SERIALIZED_NAME_FORM_GROUPS

public static final String SERIALIZED_NAME_FORM_GROUPS

See Also:

• Constant Field Values

SERIALIZED_NAME_COMMON_FIELDS

public static final String SERIALIZED_NAME_COMMON_FIELDS

See Also:

• Constant Field Values

SERIALIZED_NAME_C_C_DETAILS

public static final String SERIALIZED_NAME_C_C_DETAILS

See Also:

• Constant Field Values

SERIALIZED_NAME_BRAND_ID

public static final String SERIALIZED_NAME_BRAND_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_MESSAGE_EDITING

public static final String SERIALIZED_NAME_ALLOW_MESSAGE_EDITING

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_NEW_ROLES

public static final String SERIALIZED_NAME_ALLOW_NEW_ROLES

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_NEW_FILES

public static final String SERIALIZED_NAME_ALLOW_NEW_FILES

See Also:

• Constant Field Values

SERIALIZED_NAME_ALLOW_MODIFY_FILES

public static final String SERIALIZED_NAME_ALLOW_MODIFY_FILES

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLE_REASSIGN

public static final String SERIALIZED_NAME_ENABLE_REASSIGN

See Also:

• Constant Field Values

SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN

public static final String SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN

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_CREATED_DATE

public static final String SERIALIZED_NAME_CREATED_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_BY

public static final String SERIALIZED_NAME_CREATED_BY

See Also:

• Constant Field Values

SERIALIZED_NAME_SHARED_TEMPLATE_DETAIL

public static final String SERIALIZED_NAME_SHARED_TEMPLATE_DETAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_DOCUMENT_INFO

public static final String SERIALIZED_NAME_DOCUMENT_INFO

See Also:

• Constant Field Values

SERIALIZED_NAME_LABELS

public static final String SERIALIZED_NAME_LABELS

See Also:

• Constant Field Values

SERIALIZED_NAME_TEMPLATE_LABELS

public static final String SERIALIZED_NAME_TEMPLATE_LABELS

See Also:

• Constant Field Values

SERIALIZED_NAME_BEHALF_OF

public static final String SERIALIZED_NAME_BEHALF_OF

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_RECIPIENT_NOTIFICATION_SETTINGS

public static final String SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TemplateProperties

public TemplateProperties()

Method Details

templateId

public TemplateProperties templateId(String templateId)

getTemplateId

@Nullable
public String getTemplateId()

Get templateId

Returns:

templateId

setTemplateId

public void setTemplateId(String templateId)

title

public TemplateProperties title(String title)

getTitle

@Nullable
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

description

public TemplateProperties description(String description)

getDescription

@Nullable
public String getDescription()

Get description

Returns:

description

setDescription

public void setDescription(String description)

documentTitle

public TemplateProperties documentTitle(String documentTitle)

getDocumentTitle

@Nullable
public String getDocumentTitle()

Get documentTitle

Returns:

documentTitle

setDocumentTitle

public void setDocumentTitle(String documentTitle)

documentMessage

public TemplateProperties documentMessage(String documentMessage)

getDocumentMessage

@Nullable
public String getDocumentMessage()

Get documentMessage

Returns:

documentMessage

setDocumentMessage

public void setDocumentMessage(String documentMessage)

files

public TemplateProperties files(List<DocumentFiles> files)

addFilesItem

public TemplateProperties addFilesItem(DocumentFiles filesItem)

getFiles

@Nullable
public List<DocumentFiles> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<DocumentFiles> files)

roles

public TemplateProperties roles(List<Roles> roles)

addRolesItem

public TemplateProperties addRolesItem(Roles rolesItem)

getRoles

@Nullable
public List<Roles> getRoles()

Get roles

Returns:

roles

setRoles

public void setRoles(List<Roles> roles)

formGroups

public TemplateProperties formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public TemplateProperties addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

commonFields

public TemplateProperties commonFields(List<TemplateFormFields> commonFields)

addCommonFieldsItem

public TemplateProperties addCommonFieldsItem(TemplateFormFields commonFieldsItem)

getCommonFields

@Nullable
public List<TemplateFormFields> getCommonFields()

Get commonFields

Returns:

commonFields

setCommonFields

public void setCommonFields(List<TemplateFormFields> commonFields)

cCDetails

public TemplateProperties cCDetails(List<String> cCDetails)

addCCDetailsItem

public TemplateProperties addCCDetailsItem(String cCDetailsItem)

getcCDetails

@Nullable
public List<String> getcCDetails()

Get cCDetails

Returns:

cCDetails

setcCDetails

public void setcCDetails(List<String> cCDetails)

brandId

public TemplateProperties brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

allowMessageEditing

public TemplateProperties allowMessageEditing(Boolean allowMessageEditing)

getAllowMessageEditing

@Nullable
public Boolean getAllowMessageEditing()

Get allowMessageEditing

Returns:

allowMessageEditing

setAllowMessageEditing

public void setAllowMessageEditing(Boolean allowMessageEditing)

allowNewRoles

public TemplateProperties allowNewRoles(Boolean allowNewRoles)

getAllowNewRoles

@Nullable
public Boolean getAllowNewRoles()

Get allowNewRoles

Returns:

allowNewRoles

setAllowNewRoles

public void setAllowNewRoles(Boolean allowNewRoles)

allowNewFiles

public TemplateProperties allowNewFiles(Boolean allowNewFiles)

getAllowNewFiles

@Nullable
public Boolean getAllowNewFiles()

Get allowNewFiles

Returns:

allowNewFiles

setAllowNewFiles

public void setAllowNewFiles(Boolean allowNewFiles)

allowModifyFiles

public TemplateProperties allowModifyFiles(Boolean allowModifyFiles)

getAllowModifyFiles

@Nullable
public Boolean getAllowModifyFiles()

Get allowModifyFiles

Returns:

allowModifyFiles

setAllowModifyFiles

public void setAllowModifyFiles(Boolean allowModifyFiles)

enableReassign

public TemplateProperties enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

enablePrintAndSign

public TemplateProperties enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableSigningOrder

public TemplateProperties enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

createdDate

public TemplateProperties createdDate(Long createdDate)

getCreatedDate

@Nullable
public Long getCreatedDate()

Get createdDate

Returns:

createdDate

setCreatedDate

public void setCreatedDate(Long createdDate)

createdBy

public TemplateProperties createdBy(TemplateSenderDetail createdBy)

getCreatedBy

@Nullable
public TemplateSenderDetail getCreatedBy()

Get createdBy

Returns:

createdBy

setCreatedBy

public void setCreatedBy(TemplateSenderDetail createdBy)

sharedTemplateDetail

public TemplateProperties sharedTemplateDetail(List<TemplateSharedTemplateDetail> sharedTemplateDetail)

addSharedTemplateDetailItem

public TemplateProperties addSharedTemplateDetailItem(TemplateSharedTemplateDetail sharedTemplateDetailItem)

getSharedTemplateDetail

@Nullable
public List<TemplateSharedTemplateDetail> getSharedTemplateDetail()

Get sharedTemplateDetail

Returns:

sharedTemplateDetail

setSharedTemplateDetail

public void setSharedTemplateDetail(List<TemplateSharedTemplateDetail> sharedTemplateDetail)

documentInfo

public TemplateProperties documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public TemplateProperties addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

labels

public TemplateProperties labels(List<String> labels)

addLabelsItem

public TemplateProperties addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

templateLabels

public TemplateProperties templateLabels(List<String> templateLabels)

addTemplateLabelsItem

public TemplateProperties addTemplateLabelsItem(String templateLabelsItem)

getTemplateLabels

@Nullable
public List<String> getTemplateLabels()

Get templateLabels

Returns:

templateLabels

setTemplateLabels

public void setTemplateLabels(List<String> templateLabels)

behalfOf

public TemplateProperties behalfOf(BehalfOf behalfOf)

getBehalfOf

@Nullable
public BehalfOf getBehalfOf()

Get behalfOf

Returns:

behalfOf

setBehalfOf

public void setBehalfOf(BehalfOf behalfOf)

documentDownloadOption

public TemplateProperties documentDownloadOption(TemplateProperties.DocumentDownloadOptionEnum documentDownloadOption)

getDocumentDownloadOption

@Nullable
public TemplateProperties.DocumentDownloadOptionEnum getDocumentDownloadOption()

Get documentDownloadOption

Returns:

documentDownloadOption

setDocumentDownloadOption

public void setDocumentDownloadOption(TemplateProperties.DocumentDownloadOptionEnum documentDownloadOption)

recipientNotificationSettings

public TemplateProperties recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

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 TemplateProperties

fromJson

public static TemplateProperties fromJson(String jsonString)
                                   throws IOException

Create an instance of TemplateProperties given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TemplateProperties

Throws:

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

toJson

public String toJson()

Convert an instance of TemplateProperties to an JSON string

Returns:

JSON string