Details about consumer disclosures. More...

Inheritance diagram for DocuSign.eSign.Model.ConsumerDisclosure:

Public Member Functions
	ConsumerDisclosure (string AccountEsignId=default(string), string AllowCDWithdraw=default(string), SettingsMetadata AllowCDWithdrawMetadata=default(SettingsMetadata), string ChangeEmail=default(string), string ChangeEmailOther=default(string), string CompanyName=default(string), string CompanyPhone=default(string), string CopyCostPerPage=default(string), string CopyFeeCollectionMethod=default(string), string CopyRequestEmail=default(string), string Custom=default(string), string EnableEsign=default(string), string EsignAgreement=default(string), string EsignText=default(string), string LanguageCode=default(string), string MustAgreeToEsign=default(string), string PdfId=default(string), string UseBrand=default(string), string UseConsumerDisclosureWithinAccount=default(string), SettingsMetadata UseConsumerDisclosureWithinAccountMetadata=default(SettingsMetadata), string WithdrawAddressLine1=default(string), string WithdrawAddressLine2=default(string), string WithdrawByEmail=default(string), string WithdrawByMail=default(string), string WithdrawByPhone=default(string), string WithdrawCity=default(string), string WithdrawConsequences=default(string), string WithdrawEmail=default(string), string WithdrawOther=default(string), string WithdrawPhone=default(string), string WithdrawPostalCode=default(string), string WithdrawState=default(string))
	Initializes a new instance of the ConsumerDisclosure class. More...

override string	ToString ()
	Returns the string presentation of the object More...

string	ToJson ()
	Returns the JSON string presentation of the object More...

override bool	Equals (object obj)
	Returns true if objects are equal More...

bool	Equals (ConsumerDisclosure other)
	Returns true if ConsumerDisclosure instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	AccountEsignId `[get, set]`
	A GUID identifying the account associated with the consumer disclosure More...

string	AllowCDWithdraw `[get, set]`
	Indicates whether the customer can withdraw their acceptance of the consumer disclosure. More...

SettingsMetadata	AllowCDWithdrawMetadata `[get, set]`
	Metadata that indicates whether the `allowCDWithdraw` property is editable. More...

string	ChangeEmail `[get, set]`
	Gets or Sets ChangeEmail More...

string	ChangeEmailOther `[get, set]`
	Gets or Sets ChangeEmailOther More...

string	CompanyName `[get, set]`
	The name of the company associated with the consumer disclosure. More...

string	CompanyPhone `[get, set]`
	The phone number of the company associated with the consumer disclosure. More...

string	CopyCostPerPage `[get, set]`
	Gets or Sets CopyCostPerPage More...

string	CopyFeeCollectionMethod `[get, set]`
	Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters More...

string	CopyRequestEmail `[get, set]`
	Gets or Sets CopyRequestEmail More...

string	Custom `[get, set]`
	Gets or Sets Custom More...

string	EnableEsign `[get, set]`
	Gets or Sets EnableEsign More...

string	EsignAgreement `[get, set]`
	The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting. More...

string	EsignText `[get, set]`
	Gets or Sets EsignText More...

string	LanguageCode `[get, set]`
	Gets or Sets LanguageCode More...

string	MustAgreeToEsign `[get, set]`
	Gets or Sets MustAgreeToEsign More...

string	PdfId `[get, set]`
	Gets or Sets PdfId More...

string	UseBrand `[get, set]`
	Gets or Sets UseBrand More...

string	UseConsumerDisclosureWithinAccount `[get, set]`
	Gets or Sets UseConsumerDisclosureWithinAccount More...

SettingsMetadata	UseConsumerDisclosureWithinAccountMetadata `[get, set]`
	Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. More...

string	WithdrawAddressLine1 `[get, set]`
	Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. More...

string	WithdrawAddressLine2 `[get, set]`
	Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. More...

string	WithdrawByEmail `[get, set]`
	Indicates whether the customer can withdraw consent by email. More...

string	WithdrawByMail `[get, set]`
	Indicates whether the customer can withdraw consent by postal mail. More...

string	WithdrawByPhone `[get, set]`
	Indicates whether the customer can withdraw consent by phone. More...

string	WithdrawCity `[get, set]`
	Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. More...

string	WithdrawConsequences `[get, set]`
	Indicates the consequences of withdrawing consent. More...

string	WithdrawEmail `[get, set]`
	Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. More...

string	WithdrawOther `[get, set]`
	Indicates other information need to withdraw consent. Maximum length: 255 characters. More...

string	WithdrawPhone `[get, set]`
	Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters. More...

string	WithdrawPostalCode `[get, set]`
	Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. More...

string	WithdrawState `[get, set]`
	Contains the state of the postal address to which a customer can send a consent withdrawal notification. More...

Detailed Description

Details about consumer disclosures.

Constructor & Destructor Documentation

◆ ConsumerDisclosure()

DocuSign.eSign.Model.ConsumerDisclosure.ConsumerDisclosure	(	string	AccountEsignId = `default(string)`,
		string	AllowCDWithdraw = `default(string)`,
		SettingsMetadata	AllowCDWithdrawMetadata = `default(SettingsMetadata)`,
		string	ChangeEmail = `default(string)`,
		string	ChangeEmailOther = `default(string)`,
		string	CompanyName = `default(string)`,
		string	CompanyPhone = `default(string)`,
		string	CopyCostPerPage = `default(string)`,
		string	CopyFeeCollectionMethod = `default(string)`,
		string	CopyRequestEmail = `default(string)`,
		string	Custom = `default(string)`,
		string	EnableEsign = `default(string)`,
		string	EsignAgreement = `default(string)`,
		string	EsignText = `default(string)`,
		string	LanguageCode = `default(string)`,
		string	MustAgreeToEsign = `default(string)`,
		string	PdfId = `default(string)`,
		string	UseBrand = `default(string)`,
		string	UseConsumerDisclosureWithinAccount = `default(string)`,
		SettingsMetadata	UseConsumerDisclosureWithinAccountMetadata = `default(SettingsMetadata)`,
		string	WithdrawAddressLine1 = `default(string)`,
		string	WithdrawAddressLine2 = `default(string)`,
		string	WithdrawByEmail = `default(string)`,
		string	WithdrawByMail = `default(string)`,
		string	WithdrawByPhone = `default(string)`,
		string	WithdrawCity = `default(string)`,
		string	WithdrawConsequences = `default(string)`,
		string	WithdrawEmail = `default(string)`,
		string	WithdrawOther = `default(string)`,
		string	WithdrawPhone = `default(string)`,
		string	WithdrawPostalCode = `default(string)`,
		string	WithdrawState = `default(string)`
	)

inline

Initializes a new instance of the ConsumerDisclosure class.

Parameters

AccountEsignId	A GUID identifying the account associated with the consumer disclosure.
AllowCDWithdraw	Indicates whether the customer can withdraw their acceptance of the consumer disclosure..
AllowCDWithdrawMetadata	Metadata that indicates whether the `allowCDWithdraw` property is editable. .
ChangeEmail	ChangeEmail.
ChangeEmailOther	ChangeEmailOther.
CompanyName	The name of the company associated with the consumer disclosure..
CompanyPhone	The phone number of the company associated with the consumer disclosure..
CopyCostPerPage	CopyCostPerPage.
CopyFeeCollectionMethod	Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters.
CopyRequestEmail	CopyRequestEmail.
Custom	Custom.
EnableEsign	EnableEsign.
EsignAgreement	The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting..
EsignText	EsignText.
LanguageCode	LanguageCode.
MustAgreeToEsign	MustAgreeToEsign.
PdfId	PdfId.
UseBrand	UseBrand.
UseConsumerDisclosureWithinAccount	UseConsumerDisclosureWithinAccount.
UseConsumerDisclosureWithinAccountMetadata	Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. .
WithdrawAddressLine1	Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
WithdrawAddressLine2	Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
WithdrawByEmail	Indicates whether the customer can withdraw consent by email..
WithdrawByMail	Indicates whether the customer can withdraw consent by postal mail..
WithdrawByPhone	Indicates whether the customer can withdraw consent by phone..
WithdrawCity	Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. .
WithdrawConsequences	Indicates the consequences of withdrawing consent..
WithdrawEmail	Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. .
WithdrawOther	Indicates other information need to withdraw consent. Maximum length: 255 characters..
WithdrawPhone	Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters. .
WithdrawPostalCode	Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. .
WithdrawState	Contains the state of the postal address to which a customer can send a consent withdrawal notification..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.ConsumerDisclosure.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.ConsumerDisclosure.Equals ( ConsumerDisclosure other )

inline

Returns true if ConsumerDisclosure instances are equal

Parameters

other Instance of ConsumerDisclosure to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.ConsumerDisclosure.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.ConsumerDisclosure.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.ConsumerDisclosure.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccountEsignId

string DocuSign.eSign.Model.ConsumerDisclosure.AccountEsignId

getset

A GUID identifying the account associated with the consumer disclosure

◆ AllowCDWithdraw

string DocuSign.eSign.Model.ConsumerDisclosure.AllowCDWithdraw

getset

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

◆ AllowCDWithdrawMetadata

SettingsMetadata DocuSign.eSign.Model.ConsumerDisclosure.AllowCDWithdrawMetadata

getset

Metadata that indicates whether the `allowCDWithdraw` property is editable.

◆ ChangeEmail

string DocuSign.eSign.Model.ConsumerDisclosure.ChangeEmail

getset

Gets or Sets ChangeEmail

◆ ChangeEmailOther

string DocuSign.eSign.Model.ConsumerDisclosure.ChangeEmailOther

getset

Gets or Sets ChangeEmailOther

◆ CompanyName

string DocuSign.eSign.Model.ConsumerDisclosure.CompanyName

getset

The name of the company associated with the consumer disclosure.

◆ CompanyPhone

string DocuSign.eSign.Model.ConsumerDisclosure.CompanyPhone

getset

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

◆ CopyCostPerPage

string DocuSign.eSign.Model.ConsumerDisclosure.CopyCostPerPage

getset

Gets or Sets CopyCostPerPage

◆ CopyFeeCollectionMethod

string DocuSign.eSign.Model.ConsumerDisclosure.CopyFeeCollectionMethod

getset

Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum Length: 255 characters

◆ CopyRequestEmail

string DocuSign.eSign.Model.ConsumerDisclosure.CopyRequestEmail

getset

Gets or Sets CopyRequestEmail

◆ Custom

string DocuSign.eSign.Model.ConsumerDisclosure.Custom

getset

Gets or Sets Custom

◆ EnableEsign

string DocuSign.eSign.Model.ConsumerDisclosure.EnableEsign

getset

Gets or Sets EnableEsign

◆ EsignAgreement

string DocuSign.eSign.Model.ConsumerDisclosure.EsignAgreement

getset

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

◆ EsignText

string DocuSign.eSign.Model.ConsumerDisclosure.EsignText

getset

Gets or Sets EsignText

◆ LanguageCode

string DocuSign.eSign.Model.ConsumerDisclosure.LanguageCode

getset

Gets or Sets LanguageCode

◆ MustAgreeToEsign

string DocuSign.eSign.Model.ConsumerDisclosure.MustAgreeToEsign

getset

Gets or Sets MustAgreeToEsign

◆ PdfId

string DocuSign.eSign.Model.ConsumerDisclosure.PdfId

getset

Gets or Sets PdfId

◆ UseBrand

string DocuSign.eSign.Model.ConsumerDisclosure.UseBrand

getset

Gets or Sets UseBrand

◆ UseConsumerDisclosureWithinAccount

string DocuSign.eSign.Model.ConsumerDisclosure.UseConsumerDisclosureWithinAccount

getset

Gets or Sets UseConsumerDisclosureWithinAccount

◆ UseConsumerDisclosureWithinAccountMetadata

SettingsMetadata DocuSign.eSign.Model.ConsumerDisclosure.UseConsumerDisclosureWithinAccountMetadata

getset

Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable.

◆ WithdrawAddressLine1

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawAddressLine1

getset

Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.

◆ WithdrawAddressLine2

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawAddressLine2

getset

Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.

◆ WithdrawByEmail

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawByEmail

getset

Indicates whether the customer can withdraw consent by email.

◆ WithdrawByMail

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawByMail

getset

Indicates whether the customer can withdraw consent by postal mail.

◆ WithdrawByPhone

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawByPhone

getset

Indicates whether the customer can withdraw consent by phone.

◆ WithdrawCity

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawCity

getset

Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters.

◆ WithdrawConsequences

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawConsequences

getset

Indicates the consequences of withdrawing consent.

◆ WithdrawEmail

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawEmail

getset

Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters.

◆ WithdrawOther

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawOther

getset

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

◆ WithdrawPhone

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawPhone

getset

Contains the phone number which a customer can call to register consent withdrawal notification. Maximum length: 20 characters.

◆ WithdrawPostalCode

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawPostalCode

getset

Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters.

◆ WithdrawState

string DocuSign.eSign.Model.ConsumerDisclosure.WithdrawState

getset

Contains the state of the postal address to which a customer can send a consent withdrawal notification.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Model/ConsumerDisclosure.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ConsumerDisclosure()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccountEsignId

◆ AllowCDWithdraw

◆ AllowCDWithdrawMetadata

◆ ChangeEmail

◆ ChangeEmailOther

◆ CompanyName

◆ CompanyPhone

◆ CopyCostPerPage

◆ CopyFeeCollectionMethod

◆ CopyRequestEmail

◆ Custom

◆ EnableEsign

◆ EsignAgreement

◆ EsignText

◆ LanguageCode

◆ MustAgreeToEsign

◆ PdfId

◆ UseBrand

◆ UseConsumerDisclosureWithinAccount

◆ UseConsumerDisclosureWithinAccountMetadata

◆ WithdrawAddressLine1

◆ WithdrawAddressLine2

◆ WithdrawByEmail

◆ WithdrawByMail

◆ WithdrawByPhone

◆ WithdrawCity

◆ WithdrawConsequences

◆ WithdrawEmail

◆ WithdrawOther

◆ WithdrawPhone

◆ WithdrawPostalCode

◆ WithdrawState