Class Role

java.lang.Object
com.boldsign.model.Role
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.8.0") public class Role extends Object
Role

  • Field Details

  • Constructor Details

    • Role

      public Role()

  • Method Details

    • roleIndex

      public Role roleIndex(Integer roleIndex)

    • getRoleIndex

      @Nullable public Integer getRoleIndex()
      Get roleIndex minimum: 1 maximum: 50
      Returns:
      roleIndex

    • setRoleIndex

      public void setRoleIndex(Integer roleIndex)

    • signerName

      public Role signerName(String signerName)

    • getSignerName

      @Nullable public String getSignerName()
      Get signerName
      Returns:
      signerName

    • setSignerName

      public void setSignerName(String signerName)

    • signerOrder

      public Role signerOrder(Integer signerOrder)

    • getSignerOrder

      @Nullable public Integer getSignerOrder()
      Get signerOrder
      Returns:
      signerOrder

    • setSignerOrder

      public void setSignerOrder(Integer signerOrder)

    • signerEmail

      public Role signerEmail(String signerEmail)

    • getSignerEmail

      @Nullable public String getSignerEmail()
      Get signerEmail
      Returns:
      signerEmail

    • setSignerEmail

      public void setSignerEmail(String signerEmail)

    • hostEmail

      public Role hostEmail(String hostEmail)

    • getHostEmail

      @Nullable public String getHostEmail()
      Get hostEmail
      Returns:
      hostEmail

    • setHostEmail

      public void setHostEmail(String hostEmail)

    • privateMessage

      public Role privateMessage(String privateMessage)

    • getPrivateMessage

      @Nullable public String getPrivateMessage()
      Get privateMessage
      Returns:
      privateMessage

    • setPrivateMessage

      public void setPrivateMessage(String privateMessage)

    • authenticationCode

      public Role authenticationCode(String authenticationCode)

    • getAuthenticationCode

      @Nullable public String getAuthenticationCode()
      Get authenticationCode
      Returns:
      authenticationCode

    • setAuthenticationCode

      public void setAuthenticationCode(String authenticationCode)

    • enableEmailOTP

      public Role enableEmailOTP(Boolean enableEmailOTP)

    • getEnableEmailOTP

      @Nullable public Boolean getEnableEmailOTP()
      Get enableEmailOTP
      Returns:
      enableEmailOTP

    • setEnableEmailOTP

      public void setEnableEmailOTP(Boolean enableEmailOTP)

    • authenticationType

      public Role authenticationType(Role.AuthenticationTypeEnum authenticationType)

    • getAuthenticationType

      @Nullable public Role.AuthenticationTypeEnum getAuthenticationType()
      Get authenticationType
      Returns:
      authenticationType

    • setAuthenticationType

      public void setAuthenticationType(Role.AuthenticationTypeEnum authenticationType)

    • phoneNumber

      public Role phoneNumber(PhoneNumber phoneNumber)

    • getPhoneNumber

      @Nullable public PhoneNumber getPhoneNumber()
      Get phoneNumber
      Returns:
      phoneNumber

    • setPhoneNumber

      public void setPhoneNumber(PhoneNumber phoneNumber)

    • deliveryMode

      public Role deliveryMode(Role.DeliveryModeEnum deliveryMode)

    • getDeliveryMode

      @Nullable public Role.DeliveryModeEnum getDeliveryMode()
      Get deliveryMode
      Returns:
      deliveryMode

    • setDeliveryMode

      public void setDeliveryMode(Role.DeliveryModeEnum deliveryMode)

    • signerType

      public Role signerType(Role.SignerTypeEnum signerType)

    • getSignerType

      @Nullable public Role.SignerTypeEnum getSignerType()
      Get signerType
      Returns:
      signerType

    • setSignerType

      public void setSignerType(Role.SignerTypeEnum signerType)

    • signerRole

      public Role signerRole(String signerRole)

    • getSignerRole

      @Nullable public String getSignerRole()
      Get signerRole
      Returns:
      signerRole

    • setSignerRole

      public void setSignerRole(String signerRole)

    • allowFieldConfiguration

      public Role allowFieldConfiguration(Boolean allowFieldConfiguration)

    • getAllowFieldConfiguration

      @Nullable public Boolean getAllowFieldConfiguration()
      Get allowFieldConfiguration
      Returns:
      allowFieldConfiguration

    • setAllowFieldConfiguration

      public void setAllowFieldConfiguration(Boolean allowFieldConfiguration)

    • formFields

      public Role formFields(List<FormField> formFields)

    • addFormFieldsItem

      public Role addFormFieldsItem(FormField formFieldsItem)

    • getFormFields

      @Nullable public List<FormField> getFormFields()
      Get formFields
      Returns:
      formFields

    • setFormFields

      public void setFormFields(List<FormField> formFields)

    • existingFormFields

      public Role existingFormFields(List<ExistingFormField> existingFormFields)

    • addExistingFormFieldsItem

      public Role addExistingFormFieldsItem(ExistingFormField existingFormFieldsItem)

    • getExistingFormFields

      @Nullable public List<ExistingFormField> getExistingFormFields()
      Get existingFormFields
      Returns:
      existingFormFields

    • setExistingFormFields

      public void setExistingFormFields(List<ExistingFormField> existingFormFields)

    • identityVerificationSettings

      public Role identityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)

    • getIdentityVerificationSettings

      @Nullable public IdentityVerificationSettings getIdentityVerificationSettings()
      Get identityVerificationSettings
      Returns:
      identityVerificationSettings

    • setIdentityVerificationSettings

      public void setIdentityVerificationSettings(IdentityVerificationSettings identityVerificationSettings)

    • language

      public Role language(Role.LanguageEnum language)

    • getLanguage

      @Nullable public Role.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(Role.LanguageEnum language)

    • locale

      public Role locale(Role.LocaleEnum locale)

    • getLocale

      @Nullable public Role.LocaleEnum getLocale()
      Get locale
      Returns:
      locale

    • setLocale

      public void setLocale(Role.LocaleEnum locale)

    • recipientNotificationSettings

      public Role recipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

    • getRecipientNotificationSettings

      @Nullable public RecipientNotificationSettings getRecipientNotificationSettings()
      Get recipientNotificationSettings
      Returns:
      recipientNotificationSettings

    • setRecipientNotificationSettings

      public void setRecipientNotificationSettings(RecipientNotificationSettings recipientNotificationSettings)

    • authenticationRetryCount

      public Role authenticationRetryCount(Integer authenticationRetryCount)

    • getAuthenticationRetryCount

      @Nullable public Integer getAuthenticationRetryCount()
      Get authenticationRetryCount minimum: 1 maximum: 10
      Returns:
      authenticationRetryCount

    • setAuthenticationRetryCount

      public void setAuthenticationRetryCount(Integer authenticationRetryCount)

    • enableQes

      public Role enableQes(Boolean enableQes)

    • getEnableQes

      @Nullable public Boolean getEnableQes()
      Get enableQes
      Returns:
      enableQes

    • setEnableQes

      public void setEnableQes(Boolean enableQes)

    • authenticationSettings

      public Role authenticationSettings(AuthenticationSettings authenticationSettings)

    • getAuthenticationSettings

      @Nullable public AuthenticationSettings getAuthenticationSettings()
      Get authenticationSettings
      Returns:
      authenticationSettings

    • setAuthenticationSettings

      public void setAuthenticationSettings(AuthenticationSettings authenticationSettings)

    • 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 Role

    • fromJson

      public static Role fromJson(String jsonString) throws IOException
      Create an instance of Role given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of Role
      Throws:
      IOException - if the JSON string is invalid with respect to Role

    • toJson

      public String toJson()
      Convert an instance of Role to an JSON string
      Returns:
      JSON string