Package com.boldsign.model
Class Roles
- java.lang.Object
-
- com.boldsign.model.Roles
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.8.0") public class Roles extends Object
Roles
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRoles.CustomTypeAdapterFactorystatic classRoles.DeliveryModeEnumGets or Sets deliveryModestatic classRoles.ImposeAuthenticationEnumGets or Sets imposeAuthenticationstatic classRoles.LanguageEnum<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>static classRoles.LocaleEnumGets or Sets localestatic classRoles.SignerTypeEnumGets or Sets signerType
-
Field Summary
-
Constructor Summary
Constructors Constructor Description Roles()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RolesaddFormFieldsItem(TemplateFormFields formFieldsItem)RolesallowFieldConfiguration(Boolean allowFieldConfiguration)RolesallowRoleDelete(Boolean allowRoleDelete)RolesallowRoleEdit(Boolean allowRoleEdit)Map<String,Object>createFormData()RolesdefaultSignerEmail(String defaultSignerEmail)RolesdefaultSignerName(String defaultSignerName)RolesdeliveryMode(Roles.DeliveryModeEnum deliveryMode)RolesenableAccessCode(Boolean enableAccessCode)RolesenableDeleteRecipients(Boolean enableDeleteRecipients)RolesenableEditRecipients(Boolean enableEditRecipients)RolesenableEmailOTP(Boolean enableEmailOTP)RolesenableQes(Boolean enableQes)booleanequals(Object o)RolesformFields(List<TemplateFormFields> formFields)static RolesfromJson(String jsonString)Create an instance of Roles given an JSON stringBooleangetAllowFieldConfiguration()Get allowFieldConfigurationBooleangetAllowRoleDelete()Get allowRoleDeleteBooleangetAllowRoleEdit()Get allowRoleEditStringgetDefaultSignerEmail()Get defaultSignerEmailStringgetDefaultSignerName()Get defaultSignerNameRoles.DeliveryModeEnumgetDeliveryMode()Get deliveryModeBooleangetEnableAccessCode()Get enableAccessCodeBooleangetEnableDeleteRecipients()Get enableDeleteRecipientsBooleangetEnableEditRecipients()Get enableEditRecipientsBooleangetEnableEmailOTP()Get enableEmailOTPBooleangetEnableQes()Get enableQesList<TemplateFormFields>getFormFields()Get formFieldsStringgetHostEmail()Get hostEmailStringgetHostName()Get hostNameRoles.ImposeAuthenticationEnumgetImposeAuthentication()Get imposeAuthenticationIntegergetIndex()Get indexRoles.LanguageEnumgetLanguage()<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>Roles.LocaleEnumgetLocale()Get localeStringgetName()Get namePhoneNumbergetPhoneNumber()Get phoneNumberRecipientNotificationSettingsgetRecipientNotificationSettings()Get recipientNotificationSettingsIntegergetSignerOrder()Get signerOrderRoles.SignerTypeEnumgetSignerType()Get signerTypeinthashCode()RoleshostEmail(String hostEmail)RoleshostName(String hostName)RolesimposeAuthentication(Roles.ImposeAuthenticationEnum imposeAuthentication)Rolesindex(Integer index)Roleslanguage(Roles.LanguageEnum language)Roleslocale(Roles.LocaleEnum locale)Rolesname(String name)RolesphoneNumber(PhoneNumber phoneNumber)RolesrecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)voidsetAllowFieldConfiguration(Boolean allowFieldConfiguration)voidsetAllowRoleDelete(Boolean allowRoleDelete)voidsetAllowRoleEdit(Boolean allowRoleEdit)voidsetDefaultSignerEmail(String defaultSignerEmail)voidsetDefaultSignerName(String defaultSignerName)voidsetDeliveryMode(Roles.DeliveryModeEnum deliveryMode)voidsetEnableAccessCode(Boolean enableAccessCode)voidsetEnableDeleteRecipients(Boolean enableDeleteRecipients)voidsetEnableEditRecipients(Boolean enableEditRecipients)voidsetEnableEmailOTP(Boolean enableEmailOTP)voidsetEnableQes(Boolean enableQes)voidsetFormFields(List<TemplateFormFields> formFields)voidsetHostEmail(String hostEmail)voidsetHostName(String hostName)voidsetImposeAuthentication(Roles.ImposeAuthenticationEnum imposeAuthentication)voidsetIndex(Integer index)voidsetLanguage(Roles.LanguageEnum language)voidsetLocale(Roles.LocaleEnum locale)voidsetName(String name)voidsetPhoneNumber(PhoneNumber phoneNumber)voidsetRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)voidsetSignerOrder(Integer signerOrder)voidsetSignerType(Roles.SignerTypeEnum signerType)RolessignerOrder(Integer signerOrder)RolessignerType(Roles.SignerTypeEnum signerType)StringtoJson()Convert an instance of Roles to an JSON stringStringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement)Validates the JSON Element and throws an exception if issues found
-
-
-
Field Detail
-
SERIALIZED_NAME_NAME
public static final String SERIALIZED_NAME_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_INDEX
public static final String SERIALIZED_NAME_INDEX
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DEFAULT_SIGNER_NAME
public static final String SERIALIZED_NAME_DEFAULT_SIGNER_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DEFAULT_SIGNER_EMAIL
public static final String SERIALIZED_NAME_DEFAULT_SIGNER_EMAIL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PHONE_NUMBER
public static final String SERIALIZED_NAME_PHONE_NUMBER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SIGNER_ORDER
public static final String SERIALIZED_NAME_SIGNER_ORDER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SIGNER_TYPE
public static final String SERIALIZED_NAME_SIGNER_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_HOST_EMAIL
public static final String SERIALIZED_NAME_HOST_EMAIL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_HOST_NAME
public static final String SERIALIZED_NAME_HOST_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LANGUAGE
public static final String SERIALIZED_NAME_LANGUAGE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LOCALE
public static final String SERIALIZED_NAME_LOCALE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_ROLE_EDIT
public static final String SERIALIZED_NAME_ALLOW_ROLE_EDIT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_ROLE_DELETE
public static final String SERIALIZED_NAME_ALLOW_ROLE_DELETE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_ACCESS_CODE
public static final String SERIALIZED_NAME_ENABLE_ACCESS_CODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
public static final String SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IMPOSE_AUTHENTICATION
public static final String SERIALIZED_NAME_IMPOSE_AUTHENTICATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DELIVERY_MODE
public static final String SERIALIZED_NAME_DELIVERY_MODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
public static final String SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FORM_FIELDS
public static final String SERIALIZED_NAME_FORM_FIELDS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_EDIT_RECIPIENTS
public static final String SERIALIZED_NAME_ENABLE_EDIT_RECIPIENTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ENABLE_DELETE_RECIPIENTS
public static final String SERIALIZED_NAME_ENABLE_DELETE_RECIPIENTS
- 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_ENABLE_QES
public static final String SERIALIZED_NAME_ENABLE_QES
- See Also:
- Constant Field Values
-
-
Method Detail
-
setName
public void setName(String name)
-
setIndex
public void setIndex(Integer index)
-
getDefaultSignerName
@Nullable public String getDefaultSignerName()
Get defaultSignerName- Returns:
- defaultSignerName
-
setDefaultSignerName
public void setDefaultSignerName(String defaultSignerName)
-
getDefaultSignerEmail
@Nullable public String getDefaultSignerEmail()
Get defaultSignerEmail- Returns:
- defaultSignerEmail
-
setDefaultSignerEmail
public void setDefaultSignerEmail(String defaultSignerEmail)
-
phoneNumber
public Roles phoneNumber(PhoneNumber phoneNumber)
-
getPhoneNumber
@Nullable public PhoneNumber getPhoneNumber()
Get phoneNumber- Returns:
- phoneNumber
-
setPhoneNumber
public void setPhoneNumber(PhoneNumber phoneNumber)
-
setSignerOrder
public void setSignerOrder(Integer signerOrder)
-
signerType
public Roles signerType(Roles.SignerTypeEnum signerType)
-
getSignerType
@Nullable public Roles.SignerTypeEnum getSignerType()
Get signerType- Returns:
- signerType
-
setSignerType
public void setSignerType(Roles.SignerTypeEnum signerType)
-
setHostEmail
public void setHostEmail(String hostEmail)
-
setHostName
public void setHostName(String hostName)
-
language
public Roles language(Roles.LanguageEnum language)
-
getLanguage
@Nullable public Roles.LanguageEnum getLanguage()
<p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li></ul>- Returns:
- language
-
setLanguage
public void setLanguage(Roles.LanguageEnum language)
-
locale
public Roles locale(Roles.LocaleEnum locale)
-
getLocale
@Nullable public Roles.LocaleEnum getLocale()
Get locale- Returns:
- locale
-
setLocale
public void setLocale(Roles.LocaleEnum locale)
-
getAllowRoleEdit
@Nullable public Boolean getAllowRoleEdit()
Get allowRoleEdit- Returns:
- allowRoleEdit
-
setAllowRoleEdit
public void setAllowRoleEdit(Boolean allowRoleEdit)
-
getAllowRoleDelete
@Nullable public Boolean getAllowRoleDelete()
Get allowRoleDelete- Returns:
- allowRoleDelete
-
setAllowRoleDelete
public void setAllowRoleDelete(Boolean allowRoleDelete)
-
getEnableAccessCode
@Nullable public Boolean getEnableAccessCode()
Get enableAccessCode- Returns:
- enableAccessCode
-
setEnableAccessCode
public void setEnableAccessCode(Boolean enableAccessCode)
-
getEnableEmailOTP
@Nullable public Boolean getEnableEmailOTP()
Get enableEmailOTP- Returns:
- enableEmailOTP
-
setEnableEmailOTP
public void setEnableEmailOTP(Boolean enableEmailOTP)
-
imposeAuthentication
public Roles imposeAuthentication(Roles.ImposeAuthenticationEnum imposeAuthentication)
-
getImposeAuthentication
@Nullable public Roles.ImposeAuthenticationEnum getImposeAuthentication()
Get imposeAuthentication- Returns:
- imposeAuthentication
-
setImposeAuthentication
public void setImposeAuthentication(Roles.ImposeAuthenticationEnum imposeAuthentication)
-
deliveryMode
public Roles deliveryMode(Roles.DeliveryModeEnum deliveryMode)
-
getDeliveryMode
@Nullable public Roles.DeliveryModeEnum getDeliveryMode()
Get deliveryMode- Returns:
- deliveryMode
-
setDeliveryMode
public void setDeliveryMode(Roles.DeliveryModeEnum deliveryMode)
-
getAllowFieldConfiguration
@Nullable public Boolean getAllowFieldConfiguration()
Get allowFieldConfiguration- Returns:
- allowFieldConfiguration
-
setAllowFieldConfiguration
public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)
-
formFields
public Roles formFields(List<TemplateFormFields> formFields)
-
addFormFieldsItem
public Roles addFormFieldsItem(TemplateFormFields formFieldsItem)
-
getFormFields
@Nullable public List<TemplateFormFields> getFormFields()
Get formFields- Returns:
- formFields
-
setFormFields
public void setFormFields(List<TemplateFormFields> formFields)
-
getEnableEditRecipients
@Nullable public Boolean getEnableEditRecipients()
Get enableEditRecipients- Returns:
- enableEditRecipients
-
setEnableEditRecipients
public void setEnableEditRecipients(Boolean enableEditRecipients)
-
getEnableDeleteRecipients
@Nullable public Boolean getEnableDeleteRecipients()
Get enableDeleteRecipients- Returns:
- enableDeleteRecipients
-
setEnableDeleteRecipients
public void setEnableDeleteRecipients(Boolean enableDeleteRecipients)
-
recipientNotificationSettings
public Roles recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
-
getRecipientNotificationSettings
@Nullable public RecipientNotificationSettings getRecipientNotificationSettings()
Get recipientNotificationSettings- Returns:
- recipientNotificationSettings
-
setRecipientNotificationSettings
public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)
-
setEnableQes
public void setEnableQes(Boolean enableQes)
-
createFormData
public Map<String,Object> createFormData() throws ApiException
- Throws:
ApiException
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates 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 Roles
-
fromJson
public static Roles fromJson(String jsonString) throws IOException
Create an instance of Roles given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of Roles
- Throws:
IOException- if the JSON string is invalid with respect to Roles
-
toJson
public String toJson()
Convert an instance of Roles to an JSON string- Returns:
- JSON string
-
-