com.docusign.esign.model

Class ConsumerDisclosure

java.lang.Object

com.docusign.esign.model.ConsumerDisclosure

public class ConsumerDisclosure
extends Object

ConsumerDisclosure

Constructor Summary

Constructors

Constructor and Description
ConsumerDisclosure()

Method Summary

Methods

Modifier and Type	Method and Description
ConsumerDisclosure	accountEsignId(String accountEsignId)
ConsumerDisclosure	allowCDWithdraw(String allowCDWithdraw)
ConsumerDisclosure	allowCDWithdrawMetadata(SettingsMetadata allowCDWithdrawMetadata)
ConsumerDisclosure	changeEmail(String changeEmail)
ConsumerDisclosure	changeEmailOther(String changeEmailOther)
ConsumerDisclosure	companyName(String companyName)
ConsumerDisclosure	companyPhone(String companyPhone)
ConsumerDisclosure	copyCostPerPage(String copyCostPerPage)
ConsumerDisclosure	copyFeeCollectionMethod(String copyFeeCollectionMethod)
ConsumerDisclosure	copyRequestEmail(String copyRequestEmail)
ConsumerDisclosure	custom(String custom)
ConsumerDisclosure	enableEsign(String enableEsign)
boolean	equals(Object o)
ConsumerDisclosure	esignAgreement(String esignAgreement)
ConsumerDisclosure	esignText(String esignText)
String	getAccountEsignId() A GUID identifying the account associated with the consumer disclosure
String	getAllowCDWithdraw() Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
SettingsMetadata	getAllowCDWithdrawMetadata() Get allowCDWithdrawMetadata
String	getChangeEmail()
String	getChangeEmailOther()
String	getCompanyName() The name of the company associated with the consumer disclosure.
String	getCompanyPhone() The phone number of the company associated with the consumer disclosure.
String	getCopyCostPerPage()
String	getCopyFeeCollectionMethod() Specifies the fee collection method for cases in which the customer requires paper copies of the document.
String	getCopyRequestEmail()
String	getCustom()
String	getEnableEsign()
String	getEsignAgreement() The Electronic Record and Signature Disclosure text.
String	getEsignText()
String	getLanguageCode()
String	getMustAgreeToEsign()
String	getPdfId()
String	getUseBrand()
String	getUseConsumerDisclosureWithinAccount()
SettingsMetadata	getUseConsumerDisclosureWithinAccountMetadata() Get useConsumerDisclosureWithinAccountMetadata
String	getWithdrawAddressLine1() Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.
String	getWithdrawAddressLine2() Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.
String	getWithdrawByEmail() Indicates whether the customer can withdraw consent by email.
String	getWithdrawByMail() Indicates whether the customer can withdraw consent by postal mail.
String	getWithdrawByPhone() Indicates whether the customer can withdraw consent by phone.
String	getWithdrawCity() Contains the city of the postal address to which a customer can send a consent withdrawal notification.
String	getWithdrawConsequences() Indicates the consequences of withdrawing consent.
String	getWithdrawEmail() Contains the email address to which a customer can send a consent withdrawal notification.
String	getWithdrawOther() Indicates other information need to withdraw consent.
String	getWithdrawPhone() Contains the phone number which a customer can call to register consent withdrawal notification.
String	getWithdrawPostalCode() Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.
String	getWithdrawState() Contains the state of the postal address to which a customer can send a consent withdrawal notification.
int	hashCode()
ConsumerDisclosure	languageCode(String languageCode)
ConsumerDisclosure	mustAgreeToEsign(String mustAgreeToEsign)
ConsumerDisclosure	pdfId(String pdfId)
void	setAccountEsignId(String accountEsignId)
void	setAllowCDWithdraw(String allowCDWithdraw)
void	setAllowCDWithdrawMetadata(SettingsMetadata allowCDWithdrawMetadata)
void	setChangeEmail(String changeEmail)
void	setChangeEmailOther(String changeEmailOther)
void	setCompanyName(String companyName)
void	setCompanyPhone(String companyPhone)
void	setCopyCostPerPage(String copyCostPerPage)
void	setCopyFeeCollectionMethod(String copyFeeCollectionMethod)
void	setCopyRequestEmail(String copyRequestEmail)
void	setCustom(String custom)
void	setEnableEsign(String enableEsign)
void	setEsignAgreement(String esignAgreement)
void	setEsignText(String esignText)
void	setLanguageCode(String languageCode)
void	setMustAgreeToEsign(String mustAgreeToEsign)
void	setPdfId(String pdfId)
void	setUseBrand(String useBrand)
void	setUseConsumerDisclosureWithinAccount(String useConsumerDisclosureWithinAccount)
void	setUseConsumerDisclosureWithinAccountMetadata(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)
void	setWithdrawAddressLine1(String withdrawAddressLine1)
void	setWithdrawAddressLine2(String withdrawAddressLine2)
void	setWithdrawByEmail(String withdrawByEmail)
void	setWithdrawByMail(String withdrawByMail)
void	setWithdrawByPhone(String withdrawByPhone)
void	setWithdrawCity(String withdrawCity)
void	setWithdrawConsequences(String withdrawConsequences)
void	setWithdrawEmail(String withdrawEmail)
void	setWithdrawOther(String withdrawOther)
void	setWithdrawPhone(String withdrawPhone)
void	setWithdrawPostalCode(String withdrawPostalCode)
void	setWithdrawState(String withdrawState)
String	toString()
ConsumerDisclosure	useBrand(String useBrand)
ConsumerDisclosure	useConsumerDisclosureWithinAccount(String useConsumerDisclosureWithinAccount)
ConsumerDisclosure	useConsumerDisclosureWithinAccountMetadata(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)
ConsumerDisclosure	withdrawAddressLine1(String withdrawAddressLine1)
ConsumerDisclosure	withdrawAddressLine2(String withdrawAddressLine2)
ConsumerDisclosure	withdrawByEmail(String withdrawByEmail)
ConsumerDisclosure	withdrawByMail(String withdrawByMail)
ConsumerDisclosure	withdrawByPhone(String withdrawByPhone)
ConsumerDisclosure	withdrawCity(String withdrawCity)
ConsumerDisclosure	withdrawConsequences(String withdrawConsequences)
ConsumerDisclosure	withdrawEmail(String withdrawEmail)
ConsumerDisclosure	withdrawOther(String withdrawOther)
ConsumerDisclosure	withdrawPhone(String withdrawPhone)
ConsumerDisclosure	withdrawPostalCode(String withdrawPostalCode)
ConsumerDisclosure	withdrawState(String withdrawState)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsumerDisclosure

public ConsumerDisclosure()

Method Detail

accountEsignId

public ConsumerDisclosure accountEsignId(String accountEsignId)

getAccountEsignId

public String getAccountEsignId()

A GUID identifying the account associated with the consumer disclosure

Returns:

accountEsignId

setAccountEsignId

public void setAccountEsignId(String accountEsignId)

allowCDWithdraw

public ConsumerDisclosure allowCDWithdraw(String allowCDWithdraw)

getAllowCDWithdraw

public String getAllowCDWithdraw()

Indicates whether the customer can withdraw their acceptance of the consumer disclosure.

Returns:

allowCDWithdraw

setAllowCDWithdraw

public void setAllowCDWithdraw(String allowCDWithdraw)

allowCDWithdrawMetadata

public ConsumerDisclosure allowCDWithdrawMetadata(SettingsMetadata allowCDWithdrawMetadata)

getAllowCDWithdrawMetadata

public SettingsMetadata getAllowCDWithdrawMetadata()

Get allowCDWithdrawMetadata

Returns:

allowCDWithdrawMetadata

setAllowCDWithdrawMetadata

public void setAllowCDWithdrawMetadata(SettingsMetadata allowCDWithdrawMetadata)

changeEmail

public ConsumerDisclosure changeEmail(String changeEmail)

getChangeEmail

public String getChangeEmail()

Returns:

changeEmail

setChangeEmail

public void setChangeEmail(String changeEmail)

changeEmailOther

public ConsumerDisclosure changeEmailOther(String changeEmailOther)

getChangeEmailOther

public String getChangeEmailOther()

Returns:

changeEmailOther

setChangeEmailOther

public void setChangeEmailOther(String changeEmailOther)

companyName

public ConsumerDisclosure companyName(String companyName)

getCompanyName

public String getCompanyName()

The name of the company associated with the consumer disclosure.

Returns:

companyName

setCompanyName

public void setCompanyName(String companyName)

companyPhone

public ConsumerDisclosure companyPhone(String companyPhone)

getCompanyPhone

public String getCompanyPhone()

The phone number of the company associated with the consumer disclosure.

Returns:

companyPhone

setCompanyPhone

public void setCompanyPhone(String companyPhone)

copyCostPerPage

public ConsumerDisclosure copyCostPerPage(String copyCostPerPage)

getCopyCostPerPage

public String getCopyCostPerPage()

Returns:

copyCostPerPage

setCopyCostPerPage

public void setCopyCostPerPage(String copyCostPerPage)

copyFeeCollectionMethod

public ConsumerDisclosure copyFeeCollectionMethod(String copyFeeCollectionMethod)

getCopyFeeCollectionMethod

public 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(String copyFeeCollectionMethod)

copyRequestEmail

public ConsumerDisclosure copyRequestEmail(String copyRequestEmail)

getCopyRequestEmail

public String getCopyRequestEmail()

Returns:

copyRequestEmail

setCopyRequestEmail

public void setCopyRequestEmail(String copyRequestEmail)

custom

public ConsumerDisclosure custom(String custom)

getCustom

public String getCustom()

Returns:

custom

setCustom

public void setCustom(String custom)

enableEsign

public ConsumerDisclosure enableEsign(String enableEsign)

getEnableEsign

public String getEnableEsign()

Returns:

enableEsign

setEnableEsign

public void setEnableEsign(String enableEsign)

esignAgreement

public ConsumerDisclosure esignAgreement(String esignAgreement)

getEsignAgreement

public String getEsignAgreement()

The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.

Returns:

esignAgreement

setEsignAgreement

public void setEsignAgreement(String esignAgreement)

esignText

public ConsumerDisclosure esignText(String esignText)

getEsignText

public String getEsignText()

Returns:

esignText

setEsignText

public void setEsignText(String esignText)

languageCode

public ConsumerDisclosure languageCode(String languageCode)

getLanguageCode

public String getLanguageCode()

Returns:

languageCode

setLanguageCode

public void setLanguageCode(String languageCode)

mustAgreeToEsign

public ConsumerDisclosure mustAgreeToEsign(String mustAgreeToEsign)

getMustAgreeToEsign

public String getMustAgreeToEsign()

Returns:

mustAgreeToEsign

setMustAgreeToEsign

public void setMustAgreeToEsign(String mustAgreeToEsign)

pdfId

public ConsumerDisclosure pdfId(String pdfId)

getPdfId

public String getPdfId()

Returns:

pdfId

setPdfId

public void setPdfId(String pdfId)

useBrand

public ConsumerDisclosure useBrand(String useBrand)

getUseBrand

public String getUseBrand()

Returns:

useBrand

setUseBrand

public void setUseBrand(String useBrand)

useConsumerDisclosureWithinAccount

public ConsumerDisclosure useConsumerDisclosureWithinAccount(String useConsumerDisclosureWithinAccount)

getUseConsumerDisclosureWithinAccount

public String getUseConsumerDisclosureWithinAccount()

Returns:

useConsumerDisclosureWithinAccount

setUseConsumerDisclosureWithinAccount

public void setUseConsumerDisclosureWithinAccount(String useConsumerDisclosureWithinAccount)

useConsumerDisclosureWithinAccountMetadata

public ConsumerDisclosure useConsumerDisclosureWithinAccountMetadata(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)

getUseConsumerDisclosureWithinAccountMetadata

public SettingsMetadata getUseConsumerDisclosureWithinAccountMetadata()

Get useConsumerDisclosureWithinAccountMetadata

Returns:

useConsumerDisclosureWithinAccountMetadata

setUseConsumerDisclosureWithinAccountMetadata

public void setUseConsumerDisclosureWithinAccountMetadata(SettingsMetadata useConsumerDisclosureWithinAccountMetadata)

withdrawAddressLine1

public ConsumerDisclosure withdrawAddressLine1(String withdrawAddressLine1)

getWithdrawAddressLine1

public 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(String withdrawAddressLine1)

withdrawAddressLine2

public ConsumerDisclosure withdrawAddressLine2(String withdrawAddressLine2)

getWithdrawAddressLine2

public 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(String withdrawAddressLine2)

withdrawByEmail

public ConsumerDisclosure withdrawByEmail(String withdrawByEmail)

getWithdrawByEmail

public String getWithdrawByEmail()

Indicates whether the customer can withdraw consent by email.

Returns:

withdrawByEmail

setWithdrawByEmail

public void setWithdrawByEmail(String withdrawByEmail)

withdrawByMail

public ConsumerDisclosure withdrawByMail(String withdrawByMail)

getWithdrawByMail

public String getWithdrawByMail()

Indicates whether the customer can withdraw consent by postal mail.

Returns:

withdrawByMail

setWithdrawByMail

public void setWithdrawByMail(String withdrawByMail)

withdrawByPhone

public ConsumerDisclosure withdrawByPhone(String withdrawByPhone)

getWithdrawByPhone

public String getWithdrawByPhone()

Indicates whether the customer can withdraw consent by phone.

Returns:

withdrawByPhone

setWithdrawByPhone

public void setWithdrawByPhone(String withdrawByPhone)

withdrawCity

public ConsumerDisclosure withdrawCity(String withdrawCity)

getWithdrawCity

public 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(String withdrawCity)

withdrawConsequences

public ConsumerDisclosure withdrawConsequences(String withdrawConsequences)

getWithdrawConsequences

public String getWithdrawConsequences()

Indicates the consequences of withdrawing consent.

Returns:

withdrawConsequences

setWithdrawConsequences

public void setWithdrawConsequences(String withdrawConsequences)

withdrawEmail

public ConsumerDisclosure withdrawEmail(String withdrawEmail)

getWithdrawEmail

public 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(String withdrawEmail)

withdrawOther

public ConsumerDisclosure withdrawOther(String withdrawOther)

getWithdrawOther

public String getWithdrawOther()

Indicates other information need to withdraw consent. Maximum length: 255 characters.

Returns:

withdrawOther

setWithdrawOther

public void setWithdrawOther(String withdrawOther)

withdrawPhone

public ConsumerDisclosure withdrawPhone(String withdrawPhone)

getWithdrawPhone

public 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(String withdrawPhone)

withdrawPostalCode

public ConsumerDisclosure withdrawPostalCode(String withdrawPostalCode)

getWithdrawPostalCode

public 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(String withdrawPostalCode)

withdrawState

public ConsumerDisclosure withdrawState(String withdrawState)

getWithdrawState

public 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(String withdrawState)

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