Package com.boldsign.model

Class CreateTemplateRequest

java.lang.Object

com.boldsign.model.CreateTemplateRequest

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

CreateTemplateRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateTemplateRequest.AllowedSignatureTypesEnum	Gets or Sets allowedSignatureTypes
static class	CreateTemplateRequest.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ALLOW_MESSAGE_EDITING
static String	SERIALIZED_NAME_ALLOW_MODIFY_FILES
static String	SERIALIZED_NAME_ALLOW_NEW_FILES
static String	SERIALIZED_NAME_ALLOW_NEW_ROLES
static String	SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES
static String	SERIALIZED_NAME_AUTO_DETECT_FIELDS
static String	SERIALIZED_NAME_BRAND_ID
static String	SERIALIZED_NAME_CC
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_DOCUMENT_INFO
static String	SERIALIZED_NAME_DOCUMENT_MESSAGE
static String	SERIALIZED_NAME_DOCUMENT_TITLE
static String	SERIALIZED_NAME_ENABLE_PRINT_AND_SIGN
static String	SERIALIZED_NAME_ENABLE_REASSIGN
static String	SERIALIZED_NAME_ENABLE_SIGNING_ORDER
static String	SERIALIZED_NAME_FILE_URLS
static String	SERIALIZED_NAME_FILES
static String	SERIALIZED_NAME_FORM_FIELD_PERMISSION
static String	SERIALIZED_NAME_FORM_GROUPS
static String	SERIALIZED_NAME_LABELS
static String	SERIALIZED_NAME_ON_BEHALF_OF
static String	SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
static String	SERIALIZED_NAME_ROLES
static String	SERIALIZED_NAME_TEMPLATE_LABELS
static String	SERIALIZED_NAME_TEXT_TAG_DEFINITIONS
static String	SERIALIZED_NAME_TITLE
static String	SERIALIZED_NAME_USE_TEXT_TAGS

Constructor Summary

Constructors

Constructor	Description
CreateTemplateRequest()

Method Summary

Modifier and Type	Method	Description
CreateTemplateRequest	addAllowedSignatureTypesItem(CreateTemplateRequest.AllowedSignatureTypesEnum allowedSignatureTypesItem)
CreateTemplateRequest	addCcItem(DocumentCC ccItem)
CreateTemplateRequest	addDocumentInfoItem(DocumentInfo documentInfoItem)
CreateTemplateRequest	addFilesItem(File filesItem)
CreateTemplateRequest	addFileUrlsItem(URI fileUrlsItem)
CreateTemplateRequest	addFormGroupsItem(FormGroup formGroupsItem)
CreateTemplateRequest	addLabelsItem(String labelsItem)
CreateTemplateRequest	addRolesItem(TemplateRole rolesItem)
CreateTemplateRequest	addTemplateLabelsItem(String templateLabelsItem)
CreateTemplateRequest	addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)
CreateTemplateRequest	allowedSignatureTypes(List<CreateTemplateRequest.AllowedSignatureTypesEnum> allowedSignatureTypes)
CreateTemplateRequest	allowMessageEditing(Boolean allowMessageEditing)
CreateTemplateRequest	allowModifyFiles(Boolean allowModifyFiles)
CreateTemplateRequest	allowNewFiles(Boolean allowNewFiles)
CreateTemplateRequest	allowNewRoles(Boolean allowNewRoles)
CreateTemplateRequest	autoDetectFields(Boolean autoDetectFields)
CreateTemplateRequest	brandId(String brandId)
CreateTemplateRequest	cc(List<DocumentCC> cc)
Map<String,Object>	createFormData()
CreateTemplateRequest	description(String description)
CreateTemplateRequest	documentInfo(List<DocumentInfo> documentInfo)
CreateTemplateRequest	documentMessage(String documentMessage)
CreateTemplateRequest	documentTitle(String documentTitle)
CreateTemplateRequest	enablePrintAndSign(Boolean enablePrintAndSign)
CreateTemplateRequest	enableReassign(Boolean enableReassign)
CreateTemplateRequest	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
CreateTemplateRequest	files(List<File> files)
CreateTemplateRequest	fileUrls(List<URI> fileUrls)
CreateTemplateRequest	formFieldPermission(FormFieldPermission formFieldPermission)
CreateTemplateRequest	formGroups(List<FormGroup> formGroups)
static CreateTemplateRequest	fromJson(String jsonString)	Create an instance of CreateTemplateRequest given an JSON string
List<CreateTemplateRequest.AllowedSignatureTypesEnum>	getAllowedSignatureTypes()	Get allowedSignatureTypes
Boolean	getAllowMessageEditing()	Get allowMessageEditing
Boolean	getAllowModifyFiles()	Get allowModifyFiles
Boolean	getAllowNewFiles()	Get allowNewFiles
Boolean	getAllowNewRoles()	Get allowNewRoles
Boolean	getAutoDetectFields()	Get autoDetectFields
String	getBrandId()	Get brandId
List<DocumentCC>	getCc()	Get cc
String	getDescription()	Get description
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<File>	getFiles()	Get files
List<URI>	getFileUrls()	Get fileUrls
FormFieldPermission	getFormFieldPermission()	Get formFieldPermission
List<FormGroup>	getFormGroups()	Get formGroups
List<String>	getLabels()	Get labels
String	getOnBehalfOf()	Get onBehalfOf
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
List<TemplateRole>	getRoles()	Get roles
List<String>	getTemplateLabels()	Get templateLabels
List<TextTagDefinition>	getTextTagDefinitions()	Get textTagDefinitions
String	getTitle()	Get title
Boolean	getUseTextTags()	Get useTextTags
int	hashCode()
CreateTemplateRequest	labels(List<String> labels)
CreateTemplateRequest	onBehalfOf(String onBehalfOf)
CreateTemplateRequest	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
CreateTemplateRequest	roles(List<TemplateRole> roles)
void	setAllowedSignatureTypes(List<CreateTemplateRequest.AllowedSignatureTypesEnum> allowedSignatureTypes)
void	setAllowMessageEditing(Boolean allowMessageEditing)
void	setAllowModifyFiles(Boolean allowModifyFiles)
void	setAllowNewFiles(Boolean allowNewFiles)
void	setAllowNewRoles(Boolean allowNewRoles)
void	setAutoDetectFields(Boolean autoDetectFields)
void	setBrandId(String brandId)
void	setCc(List<DocumentCC> cc)
void	setDescription(String description)
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<File> files)
void	setFileUrls(List<URI> fileUrls)
void	setFormFieldPermission(FormFieldPermission formFieldPermission)
void	setFormGroups(List<FormGroup> formGroups)
void	setLabels(List<String> labels)
void	setOnBehalfOf(String onBehalfOf)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setRoles(List<TemplateRole> roles)
void	setTemplateLabels(List<String> templateLabels)
void	setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)
void	setTitle(String title)
void	setUseTextTags(Boolean useTextTags)
CreateTemplateRequest	templateLabels(List<String> templateLabels)
CreateTemplateRequest	textTagDefinitions(List<TextTagDefinition> textTagDefinitions)
CreateTemplateRequest	title(String title)
String	toJson()	Convert an instance of CreateTemplateRequest to an JSON string
String	toString()
CreateTemplateRequest	useTextTags(Boolean useTextTags)
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_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_FILE_URLS

public static final String SERIALIZED_NAME_FILE_URLS

See Also:

Constant Field Values

SERIALIZED_NAME_ROLES

public static final String SERIALIZED_NAME_ROLES

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_CC

public static final String SERIALIZED_NAME_CC

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_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_DOCUMENT_INFO

public static final String SERIALIZED_NAME_DOCUMENT_INFO

See Also:

Constant Field Values

SERIALIZED_NAME_USE_TEXT_TAGS

public static final String SERIALIZED_NAME_USE_TEXT_TAGS

See Also:

Constant Field Values

SERIALIZED_NAME_TEXT_TAG_DEFINITIONS

public static final String SERIALIZED_NAME_TEXT_TAG_DEFINITIONS

See Also:

Constant Field Values

SERIALIZED_NAME_AUTO_DETECT_FIELDS

public static final String SERIALIZED_NAME_AUTO_DETECT_FIELDS

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_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_FORM_GROUPS

public static final String SERIALIZED_NAME_FORM_GROUPS

See Also:

Constant Field Values

SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

public static final String SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS

See Also:

Constant Field Values

SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES

public static final String SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES

See Also:

Constant Field Values

SERIALIZED_NAME_FORM_FIELD_PERMISSION

public static final String SERIALIZED_NAME_FORM_FIELD_PERMISSION

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

CreateTemplateRequest

public CreateTemplateRequest()

Method Detail

title

public CreateTemplateRequest title(String title)

getTitle

@Nonnull
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

description

public CreateTemplateRequest description(String description)

getDescription

@Nullable
public String getDescription()

Get description

Returns:

description

setDescription

public void setDescription(String description)

documentTitle

public CreateTemplateRequest documentTitle(String documentTitle)

getDocumentTitle

@Nullable
public String getDocumentTitle()

Get documentTitle

Returns:

documentTitle

setDocumentTitle

public void setDocumentTitle(String documentTitle)

documentMessage

public CreateTemplateRequest documentMessage(String documentMessage)

getDocumentMessage

@Nullable
public String getDocumentMessage()

Get documentMessage

Returns:

documentMessage

setDocumentMessage

public void setDocumentMessage(String documentMessage)

files

public CreateTemplateRequest files(List<File> files)

addFilesItem

public CreateTemplateRequest addFilesItem(File filesItem)

getFiles

@Nullable
public List<File> getFiles()

Get files

Returns:

files

setFiles

public void setFiles(List<File> files)

fileUrls

public CreateTemplateRequest fileUrls(List<URI> fileUrls)

addFileUrlsItem

public CreateTemplateRequest addFileUrlsItem(URI fileUrlsItem)

getFileUrls

@Nullable
public List<URI> getFileUrls()

Get fileUrls

Returns:

fileUrls

setFileUrls

public void setFileUrls(List<URI> fileUrls)

roles

public CreateTemplateRequest roles(List<TemplateRole> roles)

addRolesItem

public CreateTemplateRequest addRolesItem(TemplateRole rolesItem)

getRoles

@Nullable
public List<TemplateRole> getRoles()

Get roles

Returns:

roles

setRoles

public void setRoles(List<TemplateRole> roles)

allowModifyFiles

public CreateTemplateRequest allowModifyFiles(Boolean allowModifyFiles)

getAllowModifyFiles

@Nullable
public Boolean getAllowModifyFiles()

Get allowModifyFiles

Returns:

allowModifyFiles

setAllowModifyFiles

public void setAllowModifyFiles(Boolean allowModifyFiles)

cc

public CreateTemplateRequest cc(List<DocumentCC> cc)

addCcItem

public CreateTemplateRequest addCcItem(DocumentCC ccItem)

getCc

@Nullable
public List<DocumentCC> getCc()

Get cc

Returns:

cc

setCc

public void setCc(List<DocumentCC> cc)

brandId

public CreateTemplateRequest brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

allowMessageEditing

public CreateTemplateRequest allowMessageEditing(Boolean allowMessageEditing)

getAllowMessageEditing

@Nullable
public Boolean getAllowMessageEditing()

Get allowMessageEditing

Returns:

allowMessageEditing

setAllowMessageEditing

public void setAllowMessageEditing(Boolean allowMessageEditing)

allowNewRoles

public CreateTemplateRequest allowNewRoles(Boolean allowNewRoles)

getAllowNewRoles

@Nullable
public Boolean getAllowNewRoles()

Get allowNewRoles

Returns:

allowNewRoles

setAllowNewRoles

public void setAllowNewRoles(Boolean allowNewRoles)

allowNewFiles

public CreateTemplateRequest allowNewFiles(Boolean allowNewFiles)

getAllowNewFiles

@Nullable
public Boolean getAllowNewFiles()

Get allowNewFiles

Returns:

allowNewFiles

setAllowNewFiles

public void setAllowNewFiles(Boolean allowNewFiles)

enableReassign

public CreateTemplateRequest enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

enablePrintAndSign

public CreateTemplateRequest enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableSigningOrder

public CreateTemplateRequest enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

documentInfo

public CreateTemplateRequest documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public CreateTemplateRequest addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

useTextTags

public CreateTemplateRequest useTextTags(Boolean useTextTags)

getUseTextTags

@Nullable
public Boolean getUseTextTags()

Get useTextTags

Returns:

useTextTags

setUseTextTags

public void setUseTextTags(Boolean useTextTags)

textTagDefinitions

public CreateTemplateRequest textTagDefinitions(List<TextTagDefinition> textTagDefinitions)

addTextTagDefinitionsItem

public CreateTemplateRequest addTextTagDefinitionsItem(TextTagDefinition textTagDefinitionsItem)

getTextTagDefinitions

@Nullable
public List<TextTagDefinition> getTextTagDefinitions()

Get textTagDefinitions

Returns:

textTagDefinitions

setTextTagDefinitions

public void setTextTagDefinitions(List<TextTagDefinition> textTagDefinitions)

autoDetectFields

public CreateTemplateRequest autoDetectFields(Boolean autoDetectFields)

getAutoDetectFields

@Nullable
public Boolean getAutoDetectFields()

Get autoDetectFields

Returns:

autoDetectFields

setAutoDetectFields

public void setAutoDetectFields(Boolean autoDetectFields)

onBehalfOf

public CreateTemplateRequest onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

labels

public CreateTemplateRequest labels(List<String> labels)

addLabelsItem

public CreateTemplateRequest addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

templateLabels

public CreateTemplateRequest templateLabels(List<String> templateLabels)

addTemplateLabelsItem

public CreateTemplateRequest addTemplateLabelsItem(String templateLabelsItem)

getTemplateLabels

@Nullable
public List<String> getTemplateLabels()

Get templateLabels

Returns:

templateLabels

setTemplateLabels

public void setTemplateLabels(List<String> templateLabels)

formGroups

public CreateTemplateRequest formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public CreateTemplateRequest addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

recipientNotificationSettings

public CreateTemplateRequest recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

allowedSignatureTypes

public CreateTemplateRequest allowedSignatureTypes(List<CreateTemplateRequest.AllowedSignatureTypesEnum> allowedSignatureTypes)

addAllowedSignatureTypesItem

public CreateTemplateRequest addAllowedSignatureTypesItem(CreateTemplateRequest.AllowedSignatureTypesEnum allowedSignatureTypesItem)

getAllowedSignatureTypes

@Nullable
public List<CreateTemplateRequest.AllowedSignatureTypesEnum> getAllowedSignatureTypes()

Get allowedSignatureTypes

Returns:

allowedSignatureTypes

setAllowedSignatureTypes

public void setAllowedSignatureTypes(List<CreateTemplateRequest.AllowedSignatureTypesEnum> allowedSignatureTypes)

formFieldPermission

public CreateTemplateRequest formFieldPermission(FormFieldPermission formFieldPermission)

getFormFieldPermission

@Nullable
public FormFieldPermission getFormFieldPermission()

Get formFieldPermission

Returns:

formFieldPermission

setFormFieldPermission

public void setFormFieldPermission(FormFieldPermission formFieldPermission)

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 CreateTemplateRequest

fromJson

public static CreateTemplateRequest fromJson(String jsonString)
                                      throws IOException

Create an instance of CreateTemplateRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CreateTemplateRequest

Throws:

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

toJson

public String toJson()

Convert an instance of CreateTemplateRequest to an JSON string

Returns:

JSON string