Package com.docusign.esign.model

Class ConsumerDisclosure

  • public class ConsumerDisclosure
extends java.lang.Object
    ConsumerDisclosure.

    • Constructor Detail

      • ConsumerDisclosure

        public ConsumerDisclosure()

    • Method Detail

      • accountEsignId

        public ConsumerDisclosure accountEsignId​(java.lang.String accountEsignId)
        accountEsignId.
        Returns:
        ConsumerDisclosure

      • getAccountEsignId

        public java.lang.String getAccountEsignId()
        A GUID identifying the account associated with the consumer disclosure.
        Returns:
        accountEsignId

      • setAccountEsignId

        public void setAccountEsignId​(java.lang.String accountEsignId)
        setAccountEsignId.

      • allowCDWithdraw

        public ConsumerDisclosure allowCDWithdraw​(java.lang.String allowCDWithdraw)
        allowCDWithdraw.
        Returns:
        ConsumerDisclosure

      • getAllowCDWithdraw

        public java.lang.String getAllowCDWithdraw()
        Indicates whether the customer can withdraw their acceptance of the consumer disclosure..
        Returns:
        allowCDWithdraw

      • setAllowCDWithdraw

        public void setAllowCDWithdraw​(java.lang.String allowCDWithdraw)
        setAllowCDWithdraw.

      • allowCDWithdrawMetadata

        public ConsumerDisclosure allowCDWithdrawMetadata​(SettingsMetadata allowCDWithdrawMetadata)
        allowCDWithdrawMetadata.
        Returns:
        ConsumerDisclosure

      • getAllowCDWithdrawMetadata

        public SettingsMetadata getAllowCDWithdrawMetadata()
        Get allowCDWithdrawMetadata.
        Returns:
        allowCDWithdrawMetadata

      • setAllowCDWithdrawMetadata

        public void setAllowCDWithdrawMetadata​(SettingsMetadata allowCDWithdrawMetadata)
        setAllowCDWithdrawMetadata.

      • changeEmail

        public ConsumerDisclosure changeEmail​(java.lang.String changeEmail)
        changeEmail.
        Returns:
        ConsumerDisclosure

      • getChangeEmail

        public java.lang.String getChangeEmail()
        .
        Returns:
        changeEmail

      • setChangeEmail

        public void setChangeEmail​(java.lang.String changeEmail)
        setChangeEmail.

      • changeEmailOther

        public ConsumerDisclosure changeEmailOther​(java.lang.String changeEmailOther)
        changeEmailOther.
        Returns:
        ConsumerDisclosure

      • getChangeEmailOther

        public java.lang.String getChangeEmailOther()
        .
        Returns:
        changeEmailOther

      • setChangeEmailOther

        public void setChangeEmailOther​(java.lang.String changeEmailOther)
        setChangeEmailOther.

      • companyName

        public ConsumerDisclosure companyName​(java.lang.String companyName)
        companyName.
        Returns:
        ConsumerDisclosure

      • getCompanyName

        public java.lang.String getCompanyName()
        The name of the company associated with the consumer disclosure..
        Returns:
        companyName

      • setCompanyName

        public void setCompanyName​(java.lang.String companyName)
        setCompanyName.

      • companyPhone

        public ConsumerDisclosure companyPhone​(java.lang.String companyPhone)
        companyPhone.
        Returns:
        ConsumerDisclosure

      • getCompanyPhone

        public java.lang.String getCompanyPhone()
        The phone number of the company associated with the consumer disclosure..
        Returns:
        companyPhone

      • setCompanyPhone

        public void setCompanyPhone​(java.lang.String companyPhone)
        setCompanyPhone.

      • copyCostPerPage

        public ConsumerDisclosure copyCostPerPage​(java.lang.String copyCostPerPage)
        copyCostPerPage.
        Returns:
        ConsumerDisclosure

      • getCopyCostPerPage

        public java.lang.String getCopyCostPerPage()
        .
        Returns:
        copyCostPerPage

      • setCopyCostPerPage

        public void setCopyCostPerPage​(java.lang.String copyCostPerPage)
        setCopyCostPerPage.

      • copyFeeCollectionMethod

        public ConsumerDisclosure copyFeeCollectionMethod​(java.lang.String copyFeeCollectionMethod)
        copyFeeCollectionMethod.
        Returns:
        ConsumerDisclosure

      • getCopyFeeCollectionMethod

        public java.lang.String getCopyFeeCollectionMethod()
        Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters.
        Returns:
        copyFeeCollectionMethod

      • setCopyFeeCollectionMethod

        public void setCopyFeeCollectionMethod​(java.lang.String copyFeeCollectionMethod)
        setCopyFeeCollectionMethod.

      • copyRequestEmail

        public ConsumerDisclosure copyRequestEmail​(java.lang.String copyRequestEmail)
        copyRequestEmail.
        Returns:
        ConsumerDisclosure

      • getCopyRequestEmail

        public java.lang.String getCopyRequestEmail()
        .
        Returns:
        copyRequestEmail

      • setCopyRequestEmail

        public void setCopyRequestEmail​(java.lang.String copyRequestEmail)
        setCopyRequestEmail.

      • custom

        public ConsumerDisclosure custom​(java.lang.String custom)
        custom.
        Returns:
        ConsumerDisclosure

      • getCustom

        public java.lang.String getCustom()
        .
        Returns:
        custom

      • setCustom

        public void setCustom​(java.lang.String custom)
        setCustom.

      • enableEsign

        public ConsumerDisclosure enableEsign​(java.lang.String enableEsign)
        enableEsign.
        Returns:
        ConsumerDisclosure

      • getEnableEsign

        public java.lang.String getEnableEsign()
        .
        Returns:
        enableEsign

      • setEnableEsign

        public void setEnableEsign​(java.lang.String enableEsign)
        setEnableEsign.

      • esignAgreement

        public ConsumerDisclosure esignAgreement​(java.lang.String esignAgreement)
        esignAgreement.
        Returns:
        ConsumerDisclosure

      • getEsignAgreement

        public java.lang.String getEsignAgreement()
        The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting..
        Returns:
        esignAgreement

      • setEsignAgreement

        public void setEsignAgreement​(java.lang.String esignAgreement)
        setEsignAgreement.

      • esignText

        public ConsumerDisclosure esignText​(java.lang.String esignText)
        esignText.
        Returns:
        ConsumerDisclosure

      • getEsignText

        public java.lang.String getEsignText()
        .
        Returns:
        esignText

      • setEsignText

        public void setEsignText​(java.lang.String esignText)
        setEsignText.

      • languageCode

        public ConsumerDisclosure languageCode​(java.lang.String languageCode)
        languageCode.
        Returns:
        ConsumerDisclosure

      • getLanguageCode

        public java.lang.String getLanguageCode()
        .
        Returns:
        languageCode

      • setLanguageCode

        public void setLanguageCode​(java.lang.String languageCode)
        setLanguageCode.

      • mustAgreeToEsign

        public ConsumerDisclosure mustAgreeToEsign​(java.lang.String mustAgreeToEsign)
        mustAgreeToEsign.
        Returns:
        ConsumerDisclosure

      • getMustAgreeToEsign

        public java.lang.String getMustAgreeToEsign()
        .
        Returns:
        mustAgreeToEsign

      • setMustAgreeToEsign

        public void setMustAgreeToEsign​(java.lang.String mustAgreeToEsign)
        setMustAgreeToEsign.

      • pdfId

        public ConsumerDisclosure pdfId​(java.lang.String pdfId)
        pdfId.
        Returns:
        ConsumerDisclosure

      • getPdfId

        public java.lang.String getPdfId()
        .
        Returns:
        pdfId

      • setPdfId

        public void setPdfId​(java.lang.String pdfId)
        setPdfId.

      • useBrand

        public ConsumerDisclosure useBrand​(java.lang.String useBrand)
        useBrand.
        Returns:
        ConsumerDisclosure

      • getUseBrand

        public java.lang.String getUseBrand()
        .
        Returns:
        useBrand

      • setUseBrand

        public void setUseBrand​(java.lang.String useBrand)
        setUseBrand.

      • useConsumerDisclosureWithinAccount

        public ConsumerDisclosure useConsumerDisclosureWithinAccount​(java.lang.String useConsumerDisclosureWithinAccount)
        useConsumerDisclosureWithinAccount.
        Returns:
        ConsumerDisclosure

      • getUseConsumerDisclosureWithinAccount

        public java.lang.String getUseConsumerDisclosureWithinAccount()
        .
        Returns:
        useConsumerDisclosureWithinAccount

      • setUseConsumerDisclosureWithinAccount

        public void setUseConsumerDisclosureWithinAccount​(java.lang.String useConsumerDisclosureWithinAccount)
        setUseConsumerDisclosureWithinAccount.

      • useConsumerDisclosureWithinAccountMetadata

        public ConsumerDisclosure useConsumerDisclosureWithinAccountMetadata​(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)
        useConsumerDisclosureWithinAccountMetadata.
        Returns:
        ConsumerDisclosure

      • getUseConsumerDisclosureWithinAccountMetadata

        public SettingsMetadata getUseConsumerDisclosureWithinAccountMetadata()
        Get useConsumerDisclosureWithinAccountMetadata.
        Returns:
        useConsumerDisclosureWithinAccountMetadata

      • setUseConsumerDisclosureWithinAccountMetadata

        public void setUseConsumerDisclosureWithinAccountMetadata​(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)
        setUseConsumerDisclosureWithinAccountMetadata.

      • withdrawAddressLine1

        public ConsumerDisclosure withdrawAddressLine1​(java.lang.String withdrawAddressLine1)
        withdrawAddressLine1.
        Returns:
        ConsumerDisclosure

      • getWithdrawAddressLine1

        public java.lang.String getWithdrawAddressLine1()
        Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
        Returns:
        withdrawAddressLine1

      • setWithdrawAddressLine1

        public void setWithdrawAddressLine1​(java.lang.String withdrawAddressLine1)
        setWithdrawAddressLine1.

      • withdrawAddressLine2

        public ConsumerDisclosure withdrawAddressLine2​(java.lang.String withdrawAddressLine2)
        withdrawAddressLine2.
        Returns:
        ConsumerDisclosure

      • getWithdrawAddressLine2

        public java.lang.String getWithdrawAddressLine2()
        Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
        Returns:
        withdrawAddressLine2

      • setWithdrawAddressLine2

        public void setWithdrawAddressLine2​(java.lang.String withdrawAddressLine2)
        setWithdrawAddressLine2.

      • withdrawByEmail

        public ConsumerDisclosure withdrawByEmail​(java.lang.String withdrawByEmail)
        withdrawByEmail.
        Returns:
        ConsumerDisclosure

      • getWithdrawByEmail

        public java.lang.String getWithdrawByEmail()
        Indicates whether the customer can withdraw consent by email..
        Returns:
        withdrawByEmail

      • setWithdrawByEmail

        public void setWithdrawByEmail​(java.lang.String withdrawByEmail)
        setWithdrawByEmail.

      • withdrawByMail

        public ConsumerDisclosure withdrawByMail​(java.lang.String withdrawByMail)
        withdrawByMail.
        Returns:
        ConsumerDisclosure

      • getWithdrawByMail

        public java.lang.String getWithdrawByMail()
        Indicates whether the customer can withdraw consent by postal mail..
        Returns:
        withdrawByMail

      • setWithdrawByMail

        public void setWithdrawByMail​(java.lang.String withdrawByMail)
        setWithdrawByMail.

      • withdrawByPhone

        public ConsumerDisclosure withdrawByPhone​(java.lang.String withdrawByPhone)
        withdrawByPhone.
        Returns:
        ConsumerDisclosure

      • getWithdrawByPhone

        public java.lang.String getWithdrawByPhone()
        Indicates whether the customer can withdraw consent by phone..
        Returns:
        withdrawByPhone

      • setWithdrawByPhone

        public void setWithdrawByPhone​(java.lang.String withdrawByPhone)
        setWithdrawByPhone.

      • withdrawCity

        public ConsumerDisclosure withdrawCity​(java.lang.String withdrawCity)
        withdrawCity.
        Returns:
        ConsumerDisclosure

      • getWithdrawCity

        public java.lang.String getWithdrawCity()
        Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. .
        Returns:
        withdrawCity

      • setWithdrawCity

        public void setWithdrawCity​(java.lang.String withdrawCity)
        setWithdrawCity.

      • withdrawConsequences

        public ConsumerDisclosure withdrawConsequences​(java.lang.String withdrawConsequences)
        withdrawConsequences.
        Returns:
        ConsumerDisclosure

      • getWithdrawConsequences

        public java.lang.String getWithdrawConsequences()
        Indicates the consequences of withdrawing consent..
        Returns:
        withdrawConsequences

      • setWithdrawConsequences

        public void setWithdrawConsequences​(java.lang.String withdrawConsequences)
        setWithdrawConsequences.

      • withdrawEmail

        public ConsumerDisclosure withdrawEmail​(java.lang.String withdrawEmail)
        withdrawEmail.
        Returns:
        ConsumerDisclosure

      • getWithdrawEmail

        public java.lang.String getWithdrawEmail()
        Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
        Returns:
        withdrawEmail

      • setWithdrawEmail

        public void setWithdrawEmail​(java.lang.String withdrawEmail)
        setWithdrawEmail.

      • withdrawOther

        public ConsumerDisclosure withdrawOther​(java.lang.String withdrawOther)
        withdrawOther.
        Returns:
        ConsumerDisclosure

      • getWithdrawOther

        public java.lang.String getWithdrawOther()
        Indicates other information need to withdraw consent. Maximum length: 255 characters..
        Returns:
        withdrawOther

      • setWithdrawOther

        public void setWithdrawOther​(java.lang.String withdrawOther)
        setWithdrawOther.

      • withdrawPhone

        public ConsumerDisclosure withdrawPhone​(java.lang.String withdrawPhone)
        withdrawPhone.
        Returns:
        ConsumerDisclosure

      • getWithdrawPhone

        public java.lang.String getWithdrawPhone()
        Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters. .
        Returns:
        withdrawPhone

      • setWithdrawPhone

        public void setWithdrawPhone​(java.lang.String withdrawPhone)
        setWithdrawPhone.

      • withdrawPostalCode

        public ConsumerDisclosure withdrawPostalCode​(java.lang.String withdrawPostalCode)
        withdrawPostalCode.
        Returns:
        ConsumerDisclosure

      • getWithdrawPostalCode

        public java.lang.String getWithdrawPostalCode()
        Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. .
        Returns:
        withdrawPostalCode

      • setWithdrawPostalCode

        public void setWithdrawPostalCode​(java.lang.String withdrawPostalCode)
        setWithdrawPostalCode.

      • withdrawState

        public ConsumerDisclosure withdrawState​(java.lang.String withdrawState)
        withdrawState.
        Returns:
        ConsumerDisclosure

      • getWithdrawState

        public java.lang.String getWithdrawState()
        Contains the state of the postal address to which a customer can send a consent withdrawal notification..
        Returns:
        withdrawState

      • setWithdrawState

        public void setWithdrawState​(java.lang.String withdrawState)
        setWithdrawState.

      • equals

        public boolean equals​(java.lang.Object o)
        Compares objects.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Converts the given object to string.
        Overrides:
        toString in class java.lang.Object