new module:model/ClickwrapRequest()
- Source:
Constructs a new ClickwrapRequest.
Request body for working with clickwrap.
Members
(inner) clickwrapName :String
- Source:
The name of the clickwrap. This field is required.
Type:
- String
(inner) dataFields :Array.<module:model/DataField>
- Source:
An array of data fields available to be inserted into the documents.
Type:
- Array.<module:model/DataField>
(inner) displaySettings :module:model/DisplaySettings
- Source:
Display settings for the clickwrap. This object is required.
Type:
(inner) documents :Array.<module:model/Document>
- Source:
An array of documents. This object is required.
Type:
- Array.<module:model/Document>
(inner) fieldsToNull :String
- Source:
Specifies whether scheduledReacceptance and scheduledDate should be cleared. May be one of: - \"scheduledReacceptance\" - \"scheduledDate\" - \"scheduledReacceptance,scheduledDate\"
Type:
- String
(inner) isMajorVersion :Boolean
- Source:
Not used.
Type:
- Boolean
(inner) isShared :Boolean
- Source:
When true, indicates that the clickwrap is shared with one or more users in the account.
Type:
- Boolean
(inner) name :String
- Source:
Not used.
Type:
- String
(inner) requireReacceptance :Boolean
- Source:
When true, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
Type:
- Boolean
(inner) scheduledDate :Object
- Source:
The time and date when this clickwrap is activated.
Type:
- Object
(inner) scheduledReacceptance :module:model/ClickwrapScheduledReacceptance
- Source:
Specifies the interval between reacceptances in days, weeks, months, or years.
Type:
(inner) status :String
- Source:
Clickwrap status. This property is read-only. Possible values: - active - inactive - deleted
Type:
- String
(inner) transferFromUserId :String
- Source:
Not used. To update the user ID of a clickwrap, use the updateClickwrap endpoint.
Type:
- String
(inner) transferToUserId :String
- Source:
Not used. To update the user ID of a clickwrap, use the updateClickwrap endpoint.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/ClickwrapRequest}
- Source:
Constructs a ClickwrapRequest 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/ClickwrapRequest | Optional instance to populate. |
Returns:
The populated ClickwrapRequest instance.