Class Role


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

      • Role

        public Role()
    • Method Detail

      • 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)
      • getPhoneNumber

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

        public void setPhoneNumber​(PhoneNumber phoneNumber)
      • 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)
      • addFormFieldsItem

        public Role addFormFieldsItem​(FormField formFieldsItem)
      • setFormFields

        public void setFormFields​(List<FormField> formFields)
      • addExistingFormFieldsItem

        public Role addExistingFormFieldsItem​(ExistingFormField existingFormFieldsItem)
      • setExistingFormFields

        public void setExistingFormFields​(List<ExistingFormField> existingFormFields)
      • getIdentityVerificationSettings

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

        public void setIdentityVerificationSettings​(IdentityVerificationSettings identityVerificationSettings)
      • 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><li><i>16</i> - Japanese</li><li><i>17</i> - Thai</li><li><i>18</i> - SimplifiedChinese</li><li><i>19</i> - TraditionalChinese</li><li><i>20</i> - Korean</li></ul>
        Returns:
        language
      • 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)
      • getAuthenticationSettings

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

        public void setAuthenticationSettings​(AuthenticationSettings authenticationSettings)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • 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