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 ClassesModifier and TypeClassDescriptionstatic classstatic enumGets or Sets deliveryModestatic enumGets or Sets imposeAuthenticationstatic enum<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 enumGets or Sets localestatic enumGets or Sets signerType -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddFormFieldsItem(TemplateFormFields formFieldsItem) allowFieldConfiguration(Boolean allowFieldConfiguration) allowRoleDelete(Boolean allowRoleDelete) allowRoleEdit(Boolean allowRoleEdit) defaultSignerEmail(String defaultSignerEmail) defaultSignerName(String defaultSignerName) deliveryMode(Roles.DeliveryModeEnum deliveryMode) enableAccessCode(Boolean enableAccessCode) enableDeleteRecipients(Boolean enableDeleteRecipients) enableEditRecipients(Boolean enableEditRecipients) enableEmailOTP(Boolean enableEmailOTP) booleanformFields(List<TemplateFormFields> formFields) static RolesCreate an instance of Roles given an JSON stringGet allowFieldConfigurationGet allowRoleDeleteGet allowRoleEditGet defaultSignerEmailGet defaultSignerNameGet deliveryModeGet enableAccessCodeGet enableDeleteRecipientsGet enableEditRecipientsGet enableEmailOTPGet enableQesGet formFieldsGet hostEmailGet hostNameGet imposeAuthenticationgetIndex()Get index<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>Get localegetName()Get nameGet phoneNumberGet recipientNotificationSettingsGet signerOrderGet signerTypeinthashCode()imposeAuthentication(Roles.ImposeAuthenticationEnum imposeAuthentication) language(Roles.LanguageEnum language) locale(Roles.LocaleEnum locale) phoneNumber(PhoneNumber phoneNumber) recipientNotificationSettings(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) voidvoidsetLanguage(Roles.LanguageEnum language) voidsetLocale(Roles.LocaleEnum locale) voidvoidsetPhoneNumber(PhoneNumber phoneNumber) voidsetRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) voidsetSignerOrder(Integer signerOrder) voidsetSignerType(Roles.SignerTypeEnum signerType) signerOrder(Integer signerOrder) signerType(Roles.SignerTypeEnum signerType) toJson()Convert an instance of Roles to an JSON stringtoString()static voidvalidateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_NAME
- See Also:
-
SERIALIZED_NAME_INDEX
- See Also:
-
SERIALIZED_NAME_DEFAULT_SIGNER_NAME
- See Also:
-
SERIALIZED_NAME_DEFAULT_SIGNER_EMAIL
- See Also:
-
SERIALIZED_NAME_PHONE_NUMBER
- See Also:
-
SERIALIZED_NAME_SIGNER_ORDER
- See Also:
-
SERIALIZED_NAME_SIGNER_TYPE
- See Also:
-
SERIALIZED_NAME_HOST_EMAIL
- See Also:
-
SERIALIZED_NAME_HOST_NAME
- See Also:
-
SERIALIZED_NAME_LANGUAGE
- See Also:
-
SERIALIZED_NAME_LOCALE
- See Also:
-
SERIALIZED_NAME_ALLOW_ROLE_EDIT
- See Also:
-
SERIALIZED_NAME_ALLOW_ROLE_DELETE
- See Also:
-
SERIALIZED_NAME_ENABLE_ACCESS_CODE
- See Also:
-
SERIALIZED_NAME_ENABLE_EMAIL_O_T_P
- See Also:
-
SERIALIZED_NAME_IMPOSE_AUTHENTICATION
- See Also:
-
SERIALIZED_NAME_DELIVERY_MODE
- See Also:
-
SERIALIZED_NAME_ALLOW_FIELD_CONFIGURATION
- See Also:
-
SERIALIZED_NAME_FORM_FIELDS
- See Also:
-
SERIALIZED_NAME_ENABLE_EDIT_RECIPIENTS
- See Also:
-
SERIALIZED_NAME_ENABLE_DELETE_RECIPIENTS
- See Also:
-
SERIALIZED_NAME_RECIPIENT_NOTIFICATION_SETTINGS
- See Also:
-
SERIALIZED_NAME_ENABLE_QES
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
Roles
public Roles()
-
-
Method Details
-
name
-
getName
-
setName
-
index
-
getIndex
-
setIndex
-
defaultSignerName
-
getDefaultSignerName
-
setDefaultSignerName
-
defaultSignerEmail
-
getDefaultSignerEmail
-
setDefaultSignerEmail
-
phoneNumber
-
getPhoneNumber
-
setPhoneNumber
-
signerOrder
-
getSignerOrder
-
setSignerOrder
-
signerType
-
getSignerType
-
setSignerType
-
hostEmail
-
getHostEmail
-
setHostEmail
-
hostName
-
getHostName
-
setHostName
-
language
-
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
-
locale
-
getLocale
-
setLocale
-
allowRoleEdit
-
getAllowRoleEdit
-
setAllowRoleEdit
-
allowRoleDelete
-
getAllowRoleDelete
-
setAllowRoleDelete
-
enableAccessCode
-
getEnableAccessCode
-
setEnableAccessCode
-
enableEmailOTP
-
getEnableEmailOTP
-
setEnableEmailOTP
-
imposeAuthentication
-
getImposeAuthentication
Get imposeAuthentication- Returns:
- imposeAuthentication
-
setImposeAuthentication
-
deliveryMode
-
getDeliveryMode
-
setDeliveryMode
-
allowFieldConfiguration
-
getAllowFieldConfiguration
-
setAllowFieldConfiguration
-
formFields
-
addFormFieldsItem
-
getFormFields
-
setFormFields
-
enableEditRecipients
-
getEnableEditRecipients
-
setEnableEditRecipients
-
enableDeleteRecipients
-
getEnableDeleteRecipients
-
setEnableDeleteRecipients
-
recipientNotificationSettings
public Roles recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) -
getRecipientNotificationSettings
Get recipientNotificationSettings- Returns:
- recipientNotificationSettings
-
setRecipientNotificationSettings
public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings) -
enableQes
-
getEnableQes
-
setEnableQes
-
equals
-
hashCode
-
toString
-
createFormData
- Throws:
ApiException
-
validateJsonElement
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 Roles
-
fromJson
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
-