module:model/ConsumerDisclosure

module:model/ConsumerDisclosure

new module:model/ConsumerDisclosure()

Source:

Constructs a new ConsumerDisclosure.
Details about consumer disclosures.

Members

(inner) accountEsignId :String

Source:

A GUID identifying the account associated with the consumer disclosure

Type:
  • String

(inner) allowCDWithdraw :String

Source:

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

Type:
  • String

(inner) allowCDWithdrawMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the allowCDWithdraw property is editable.

Type:

(inner) changeEmail :String

Source:
Type:
  • String

(inner) changeEmailOther :String

Source:
Type:
  • String

(inner) companyName :String

Source:

The name of the company associated with the consumer disclosure.

Type:
  • String

(inner) companyPhone :String

Source:

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

Type:
  • String

(inner) copyCostPerPage :String

Source:
Type:
  • String

(inner) copyFeeCollectionMethod :String

Source:

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

Type:
  • String

(inner) copyRequestEmail :String

Source:
Type:
  • String

(inner) custom :String

Source:
Type:
  • String

(inner) enableEsign :String

Source:
Type:
  • String

(inner) esignAgreement :String

Source:

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

Type:
  • String

(inner) esignText :String

Source:
Type:
  • String

(inner) languageCode :String

Source:
Type:
  • String

(inner) mustAgreeToEsign :String

Source:
Type:
  • String

(inner) pdfId :String

Source:
Type:
  • String

(inner) useBrand :String

Source:
Type:
  • String

(inner) useConsumerDisclosureWithinAccount :String

Source:
Type:
  • String

(inner) useConsumerDisclosureWithinAccountMetadata :module:model/SettingsMetadata

Source:

Metadata that indicates whether the useConsumerDisclosureWithinAccount property is editable.

Type:

(inner) withdrawAddressLine1 :String

Source:

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

Type:
  • String

(inner) withdrawAddressLine2 :String

Source:

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

Type:
  • String

(inner) withdrawByEmail :String

Source:

Indicates whether the customer can withdraw consent by email.

Type:
  • String

(inner) withdrawByMail :String

Source:

Indicates whether the customer can withdraw consent by postal mail.

Type:
  • String

(inner) withdrawByPhone :String

Source:

Indicates whether the customer can withdraw consent by phone.

Type:
  • String

(inner) withdrawCity :String

Source:

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

Type:
  • String

(inner) withdrawConsequences :String

Source:

Indicates the consequences of withdrawing consent.

Type:
  • String

(inner) withdrawEmail :String

Source:

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

Type:
  • String

(inner) withdrawOther :String

Source:

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

Type:
  • String

(inner) withdrawPhone :String

Source:

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

Type:
  • String

(inner) withdrawPostalCode :String

Source:

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

Type:
  • String

(inner) withdrawState :String

Source:

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

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/ConsumerDisclosure}

Source:

Constructs a ConsumerDisclosure from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:model/ConsumerDisclosure

Optional instance to populate.

Returns:

The populated ConsumerDisclosure instance.

Type
module:model/ConsumerDisclosure