new module:model/UserAgreementResponse()
- Source:
Constructs a new UserAgreementResponse.
Members
(inner) accountId :String
- Source:
The external account number (int) or account ID GUID.
Type:
- String
(inner) agreedOn :Object
- Source:
Date that the client last completed the agreement. This property is null if agreementUrl is not null and status is not agreed.
Type:
- Object
(inner) agreementId :String
- Source:
The agreement ID.
Type:
- String
(inner) agreementUrl :String
- Source:
When not null, an agreement is required for user specified by clientUserId. When missing the user specified by clientUserId has already agreed and does not require a new acceptance. Use this URL to render the agreement in a web page.
Type:
- String
(inner) clickwrapId :String
- Source:
The ID of the clickwrap.
Type:
- String
(inner) clientUserId :String
- Source:
A unique value that identifies a user.\nYou can use anything that your system uses\nto identify unique users, such as\nemployee IDs, email addresses, and surrogate keys as the value of clientUserId.\n\nA clickwrap with a specific clientUserId will not appear again\nonce it has been accepted.\n"
Type:
- String
(inner) consumerDisclosureEnabled :Boolean
- Source:
True if consumer disclosure was required by this agreement.
Type:
- Boolean
(inner) consumerDisclosureHtml :String
- Source:
The customer-branded HTML with the Electronic Record and Signature Disclosure information
Type:
- String
(inner) createdOn :Object
- Source:
The date when the clickwrap was created. May be null.
Type:
- Object
(inner) dataFields :Array.<module:model/DataField>
- Source:
The list of all the data fields available for the clickwrap (custom fields and standard fields).
Type:
- Array.<module:model/DataField>
(inner) declinedOn :Object
- Source:
The date when the user declined the most recent required agreement. This property is valid only when status is declined. Otherwise it is null.
Type:
- Object
(inner) documentData :Object.<String, String>
- Source:
This property specifies the data used to create a clickwrap with [dynamic content][]. [dynamic content]: /docs/click-api/click101/customize-clickwrap-fields/#embed-clickwraps-that-contain-dynamic-content
Type:
- Object.<String, String>
(inner) documents :Array.<module:model/Document>
- Source:
An array of documents.
Type:
- Array.<module:model/Document>
(inner) metadata :String
- Source:
A customer-defined string you can use in requests. This string will appear in the corresponding response.
Type:
- String
(inner) returnUrl :String
- Source:
The URL redirected to after the agreement was completed.
Type:
- String
(inner) settings :module:model/DisplaySettings
- Source:
The display settings for this agreement.
Type:
(inner) status :String
- Source:
User agreement status. One of: - created - agreed - declined
Type:
- String
(inner) style :module:model/UserAgreementResponseStyle
- Source:
Type:
(inner) version :String
- Source:
The human-readable semver version string.
Type:
- String
(inner) versionId :String
- Source:
The ID of the version.
Type:
- String
(inner) versionNumber :Number
- Source:
Version of the clickwrap.
Type:
- Number
Methods
(static) constructFromObject(data, obj) → {module:model/UserAgreementResponse}
- Source:
Constructs a UserAgreementResponse 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/UserAgreementResponse | Optional instance to populate. |
Returns:
The populated UserAgreementResponse instance.