Package com.boldsign.model

Class EditTemplateRequest

java.lang.Object

com.boldsign.model.EditTemplateRequest

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

EditTemplateRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EditTemplateRequest.AllowedSignatureTypesEnum	Gets or Sets allowedSignatureTypes
static class	EditTemplateRequest.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_NEW_FILES
static String	SERIALIZED_NAME_ALLOW_NEW_ROLES
static String	SERIALIZED_NAME_ALLOWED_SIGNATURE_TYPES
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_FORM_FIELD_PERMISSION
static String	SERIALIZED_NAME_FORM_GROUPS
static String	SERIALIZED_NAME_GROUP_SIGNER_SETTINGS
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_TITLE

Constructor Summary

Constructors

Constructor	Description
EditTemplateRequest()

Method Summary

Modifier and Type	Method	Description
EditTemplateRequest	addAllowedSignatureTypesItem(EditTemplateRequest.AllowedSignatureTypesEnum allowedSignatureTypesItem)
EditTemplateRequest	addCcItem(DocumentCC ccItem)
EditTemplateRequest	addDocumentInfoItem(DocumentInfo documentInfoItem)
EditTemplateRequest	addFormGroupsItem(FormGroup formGroupsItem)
EditTemplateRequest	addLabelsItem(String labelsItem)
EditTemplateRequest	addRolesItem(TemplateRole rolesItem)
EditTemplateRequest	addTemplateLabelsItem(String templateLabelsItem)
EditTemplateRequest	allowedSignatureTypes(List<EditTemplateRequest.AllowedSignatureTypesEnum> allowedSignatureTypes)
EditTemplateRequest	allowMessageEditing(Boolean allowMessageEditing)
EditTemplateRequest	allowNewFiles(Boolean allowNewFiles)
EditTemplateRequest	allowNewRoles(Boolean allowNewRoles)
EditTemplateRequest	brandId(String brandId)
EditTemplateRequest	cc(List<DocumentCC> cc)
Map<String,Object>	createFormData()
EditTemplateRequest	description(String description)
EditTemplateRequest	documentInfo(List<DocumentInfo> documentInfo)
EditTemplateRequest	documentMessage(String documentMessage)
EditTemplateRequest	documentTitle(String documentTitle)
EditTemplateRequest	enablePrintAndSign(Boolean enablePrintAndSign)
EditTemplateRequest	enableReassign(Boolean enableReassign)
EditTemplateRequest	enableSigningOrder(Boolean enableSigningOrder)
boolean	equals(Object o)
EditTemplateRequest	formFieldPermission(FormFieldPermission formFieldPermission)
EditTemplateRequest	formGroups(List<FormGroup> formGroups)
static EditTemplateRequest	fromJson(String jsonString)	Create an instance of EditTemplateRequest given an JSON string
List<EditTemplateRequest.AllowedSignatureTypesEnum>	getAllowedSignatureTypes()	Get allowedSignatureTypes
Boolean	getAllowMessageEditing()	Get allowMessageEditing
Boolean	getAllowNewFiles()	Get allowNewFiles
Boolean	getAllowNewRoles()	Get allowNewRoles
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
FormFieldPermission	getFormFieldPermission()	Get formFieldPermission
List<FormGroup>	getFormGroups()	Get formGroups
GroupSignerSettings	getGroupSignerSettings()	Get groupSignerSettings
List<String>	getLabels()	Get labels
String	getOnBehalfOf()	Get onBehalfOf
RecipientNotificationSettings	getRecipientNotificationSettings()	Get recipientNotificationSettings
List<TemplateRole>	getRoles()	Get roles
List<String>	getTemplateLabels()	Get templateLabels
String	getTitle()	Get title
EditTemplateRequest	groupSignerSettings(GroupSignerSettings groupSignerSettings)
int	hashCode()
EditTemplateRequest	labels(List<String> labels)
EditTemplateRequest	onBehalfOf(String onBehalfOf)
EditTemplateRequest	recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
EditTemplateRequest	roles(List<TemplateRole> roles)
void	setAllowedSignatureTypes(List<EditTemplateRequest.AllowedSignatureTypesEnum> allowedSignatureTypes)
void	setAllowMessageEditing(Boolean allowMessageEditing)
void	setAllowNewFiles(Boolean allowNewFiles)
void	setAllowNewRoles(Boolean allowNewRoles)
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	setFormFieldPermission(FormFieldPermission formFieldPermission)
void	setFormGroups(List<FormGroup> formGroups)
void	setGroupSignerSettings(GroupSignerSettings groupSignerSettings)
void	setLabels(List<String> labels)
void	setOnBehalfOf(String onBehalfOf)
void	setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
void	setRoles(List<TemplateRole> roles)
void	setTemplateLabels(List<String> templateLabels)
void	setTitle(String title)
EditTemplateRequest	templateLabels(List<String> templateLabels)
EditTemplateRequest	title(String title)
String	toJson()	Convert an instance of EditTemplateRequest 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_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_ROLES

public static final String SERIALIZED_NAME_ROLES

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

SERIALIZED_NAME_GROUP_SIGNER_SETTINGS

public static final String SERIALIZED_NAME_GROUP_SIGNER_SETTINGS

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

EditTemplateRequest

public EditTemplateRequest()

Method Detail

title

public EditTemplateRequest title(String title)

getTitle

@Nullable
public String getTitle()

Get title

Returns:

title

setTitle

public void setTitle(String title)

description

public EditTemplateRequest description(String description)

getDescription

@Nullable
public String getDescription()

Get description

Returns:

description

setDescription

public void setDescription(String description)

documentTitle

public EditTemplateRequest documentTitle(String documentTitle)

getDocumentTitle

@Nullable
public String getDocumentTitle()

Get documentTitle

Returns:

documentTitle

setDocumentTitle

public void setDocumentTitle(String documentTitle)

documentMessage

public EditTemplateRequest documentMessage(String documentMessage)

getDocumentMessage

@Nullable
public String getDocumentMessage()

Get documentMessage

Returns:

documentMessage

setDocumentMessage

public void setDocumentMessage(String documentMessage)

roles

public EditTemplateRequest roles(List<TemplateRole> roles)

addRolesItem

public EditTemplateRequest addRolesItem(TemplateRole rolesItem)

getRoles

@Nullable
public List<TemplateRole> getRoles()

Get roles

Returns:

roles

setRoles

public void setRoles(List<TemplateRole> roles)

cc

public EditTemplateRequest cc(List<DocumentCC> cc)

addCcItem

public EditTemplateRequest addCcItem(DocumentCC ccItem)

getCc

@Nullable
public List<DocumentCC> getCc()

Get cc

Returns:

cc

setCc

public void setCc(List<DocumentCC> cc)

brandId

public EditTemplateRequest brandId(String brandId)

getBrandId

@Nullable
public String getBrandId()

Get brandId

Returns:

brandId

setBrandId

public void setBrandId(String brandId)

allowMessageEditing

public EditTemplateRequest allowMessageEditing(Boolean allowMessageEditing)

getAllowMessageEditing

@Nullable
public Boolean getAllowMessageEditing()

Get allowMessageEditing

Returns:

allowMessageEditing

setAllowMessageEditing

public void setAllowMessageEditing(Boolean allowMessageEditing)

allowNewRoles

public EditTemplateRequest allowNewRoles(Boolean allowNewRoles)

getAllowNewRoles

@Nullable
public Boolean getAllowNewRoles()

Get allowNewRoles

Returns:

allowNewRoles

setAllowNewRoles

public void setAllowNewRoles(Boolean allowNewRoles)

allowNewFiles

public EditTemplateRequest allowNewFiles(Boolean allowNewFiles)

getAllowNewFiles

@Nullable
public Boolean getAllowNewFiles()

Get allowNewFiles

Returns:

allowNewFiles

setAllowNewFiles

public void setAllowNewFiles(Boolean allowNewFiles)

enableReassign

public EditTemplateRequest enableReassign(Boolean enableReassign)

getEnableReassign

@Nullable
public Boolean getEnableReassign()

Get enableReassign

Returns:

enableReassign

setEnableReassign

public void setEnableReassign(Boolean enableReassign)

enablePrintAndSign

public EditTemplateRequest enablePrintAndSign(Boolean enablePrintAndSign)

getEnablePrintAndSign

@Nullable
public Boolean getEnablePrintAndSign()

Get enablePrintAndSign

Returns:

enablePrintAndSign

setEnablePrintAndSign

public void setEnablePrintAndSign(Boolean enablePrintAndSign)

enableSigningOrder

public EditTemplateRequest enableSigningOrder(Boolean enableSigningOrder)

getEnableSigningOrder

@Nullable
public Boolean getEnableSigningOrder()

Get enableSigningOrder

Returns:

enableSigningOrder

setEnableSigningOrder

public void setEnableSigningOrder(Boolean enableSigningOrder)

documentInfo

public EditTemplateRequest documentInfo(List<DocumentInfo> documentInfo)

addDocumentInfoItem

public EditTemplateRequest addDocumentInfoItem(DocumentInfo documentInfoItem)

getDocumentInfo

@Nullable
public List<DocumentInfo> getDocumentInfo()

Get documentInfo

Returns:

documentInfo

setDocumentInfo

public void setDocumentInfo(List<DocumentInfo> documentInfo)

onBehalfOf

public EditTemplateRequest onBehalfOf(String onBehalfOf)

getOnBehalfOf

@Nullable
public String getOnBehalfOf()

Get onBehalfOf

Returns:

onBehalfOf

setOnBehalfOf

public void setOnBehalfOf(String onBehalfOf)

labels

public EditTemplateRequest labels(List<String> labels)

addLabelsItem

public EditTemplateRequest addLabelsItem(String labelsItem)

getLabels

@Nullable
public List<String> getLabels()

Get labels

Returns:

labels

setLabels

public void setLabels(List<String> labels)

templateLabels

public EditTemplateRequest templateLabels(List<String> templateLabels)

addTemplateLabelsItem

public EditTemplateRequest addTemplateLabelsItem(String templateLabelsItem)

getTemplateLabels

@Nullable
public List<String> getTemplateLabels()

Get templateLabels

Returns:

templateLabels

setTemplateLabels

public void setTemplateLabels(List<String> templateLabels)

formGroups

public EditTemplateRequest formGroups(List<FormGroup> formGroups)

addFormGroupsItem

public EditTemplateRequest addFormGroupsItem(FormGroup formGroupsItem)

getFormGroups

@Nullable
public List<FormGroup> getFormGroups()

Get formGroups

Returns:

formGroups

setFormGroups

public void setFormGroups(List<FormGroup> formGroups)

recipientNotificationSettings

public EditTemplateRequest recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

getRecipientNotificationSettings

@Nullable
public RecipientNotificationSettings getRecipientNotificationSettings()

Get recipientNotificationSettings

Returns:

recipientNotificationSettings

setRecipientNotificationSettings

public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

allowedSignatureTypes

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

addAllowedSignatureTypesItem

public EditTemplateRequest addAllowedSignatureTypesItem(EditTemplateRequest.AllowedSignatureTypesEnum allowedSignatureTypesItem)

getAllowedSignatureTypes

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

Get allowedSignatureTypes

Returns:

allowedSignatureTypes

setAllowedSignatureTypes

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

formFieldPermission

public EditTemplateRequest formFieldPermission(FormFieldPermission formFieldPermission)

getFormFieldPermission

@Nullable
public FormFieldPermission getFormFieldPermission()

Get formFieldPermission

Returns:

formFieldPermission

setFormFieldPermission

public void setFormFieldPermission(FormFieldPermission formFieldPermission)

groupSignerSettings

public EditTemplateRequest groupSignerSettings(GroupSignerSettings groupSignerSettings)

getGroupSignerSettings

@Nullable
public GroupSignerSettings getGroupSignerSettings()

Get groupSignerSettings

Returns:

groupSignerSettings

setGroupSignerSettings

public void setGroupSignerSettings(GroupSignerSettings groupSignerSettings)

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 EditTemplateRequest

fromJson

public static EditTemplateRequest fromJson(String jsonString)
                                    throws IOException

Create an instance of EditTemplateRequest given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of EditTemplateRequest

Throws:

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

toJson

public String toJson()

Convert an instance of EditTemplateRequest to an JSON string

Returns:

JSON string