java.lang.Object
- com.docusign.click.model.UserAgreementResponse

public class UserAgreementResponse
extends Object

UserAgreementResponse.

Constructor Summary

Constructors
Constructor Description

UserAgreementResponse()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`UserAgreementResponse`	`accountId(String accountId)`	accountId.
`UserAgreementResponse`	`addDataFieldsItem(DataField dataFieldsItem)`	addDataFieldsItem.
`UserAgreementResponse`	`addDocumentsItem(Document documentsItem)`	addDocumentsItem.
`UserAgreementResponse`	`agreedOn(Object agreedOn)`	agreedOn.
`UserAgreementResponse`	`agreementId(String agreementId)`	agreementId.
`UserAgreementResponse`	`agreementUrl(String agreementUrl)`	agreementUrl.
`UserAgreementResponse`	`clickwrapId(String clickwrapId)`	clickwrapId.
`UserAgreementResponse`	`clientUserId(String clientUserId)`	clientUserId.
`UserAgreementResponse`	`consumerDisclosureEnabled(Boolean consumerDisclosureEnabled)`	consumerDisclosureEnabled.
`UserAgreementResponse`	`consumerDisclosureHtml(String consumerDisclosureHtml)`	consumerDisclosureHtml.
`UserAgreementResponse`	`createdOn(Object createdOn)`	createdOn.
`UserAgreementResponse`	`dataFields(List<DataField> dataFields)`	dataFields.
`UserAgreementResponse`	`declinedOn(Object declinedOn)`	declinedOn.
`UserAgreementResponse`	`documentData(Map<String,String> documentData)`	documentData.
`UserAgreementResponse`	`documents(List<Document> documents)`	documents.
`boolean`	`equals(Object o)`	Compares objects.
`String`	`getAccountId()`	The external account number (int) or account ID GUID..
`Object`	`getAgreedOn()`	Date that the client last completed the agreement.
`String`	`getAgreementId()`	The agreement ID..
`String`	`getAgreementUrl()`	When not null, an agreement is required for user specified by `clientUserId`.
`String`	`getClickwrapId()`	The ID of the clickwrap..
`String`	`getClientUserId()`	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\".
`String`	`getConsumerDisclosureHtml()`	The customer-branded HTML with the Electronic Record and Signature Disclosure information.
`Object`	`getCreatedOn()`	The date when the clickwrap was created.
`List<DataField>`	`getDataFields()`	The list of all the data fields available for the clickwrap (custom fields and standard fields)..
`Object`	`getDeclinedOn()`	The date when the user declined the most recent required agreement.
`Map<String,String>`	`getDocumentData()`	This property specifies the data used to create a clickwrap with [dynamic content][].
`List<Document>`	`getDocuments()`	An array of documents..
`String`	`getMetadata()`	A customer-defined string you can use in requests.
`String`	`getReturnUrl()`	The URL redirected to after the agreement was completed..
`DisplaySettings`	`getSettings()`	The display settings for this agreement..
`String`	`getStatus()`	User agreement status.
`Map<String,String>`	`getStyle()`	This property specifies the custom style provided when the agreement was created by [customizing the template appearance][].
`String`	`getVersion()`	The human-readable semver version string..
`String`	`getVersionId()`	The ID of the version..
`Integer`	`getVersionNumber()`	Version of the clickwrap..
`int`	`hashCode()`	Returns the HashCode.
`Boolean`	`isConsumerDisclosureEnabled()`	True if consumer disclosure was required by this agreement..
`UserAgreementResponse`	`metadata(String metadata)`	metadata.
`UserAgreementResponse`	`putDocumentDataItem(String key, String documentDataItem)`	putDocumentDataItem.
`UserAgreementResponse`	`putStyleItem(String key, String styleItem)`	putStyleItem.
`UserAgreementResponse`	`returnUrl(String returnUrl)`	returnUrl.
`void`	`setAccountId(String accountId)`	setAccountId.
`void`	`setAgreedOn(Object agreedOn)`	setAgreedOn.
`void`	`setAgreementId(String agreementId)`	setAgreementId.
`void`	`setAgreementUrl(String agreementUrl)`	setAgreementUrl.
`void`	`setClickwrapId(String clickwrapId)`	setClickwrapId.
`void`	`setClientUserId(String clientUserId)`	setClientUserId.
`void`	`setConsumerDisclosureEnabled(Boolean consumerDisclosureEnabled)`	setConsumerDisclosureEnabled.
`void`	`setConsumerDisclosureHtml(String consumerDisclosureHtml)`	setConsumerDisclosureHtml.
`void`	`setCreatedOn(Object createdOn)`	setCreatedOn.
`void`	`setDataFields(List<DataField> dataFields)`	setDataFields.
`void`	`setDeclinedOn(Object declinedOn)`	setDeclinedOn.
`void`	`setDocumentData(Map<String,String> documentData)`	setDocumentData.
`void`	`setDocuments(List<Document> documents)`	setDocuments.
`void`	`setMetadata(String metadata)`	setMetadata.
`void`	`setReturnUrl(String returnUrl)`	setReturnUrl.
`void`	`setSettings(DisplaySettings settings)`	setSettings.
`void`	`setStatus(String status)`	setStatus.
`void`	`setStyle(Map<String,String> style)`	setStyle.
`UserAgreementResponse`	`settings(DisplaySettings settings)`	settings.
`void`	`setVersion(String version)`	setVersion.
`void`	`setVersionId(String versionId)`	setVersionId.
`void`	`setVersionNumber(Integer versionNumber)`	setVersionNumber.
`UserAgreementResponse`	`status(String status)`	status.
`UserAgreementResponse`	`style(Map<String,String> style)`	style.
`String`	`toString()`	Converts the given object to string.
`UserAgreementResponse`	`version(String version)`	version.
`UserAgreementResponse`	`versionId(String versionId)`	versionId.
`UserAgreementResponse`	`versionNumber(Integer versionNumber)`	versionNumber.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserAgreementResponse
```
public UserAgreementResponse()
```
- Method Detail
  - accountId
```
public UserAgreementResponse accountId(String accountId)
```
    accountId.
    
    Returns:
    
    UserAgreementResponse
  - getAccountId
```
public String getAccountId()
```
    The external account number (int) or account ID GUID..
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
    setAccountId.
  - agreedOn
```
public UserAgreementResponse agreedOn(Object agreedOn)
```
    agreedOn.
    
    Returns:
    
    UserAgreementResponse
  - getAgreedOn
```
public Object getAgreedOn()
```
    Date that the client last completed the agreement. This property is null if `agreementUrl` is not null and `status` is not `agreed`..
    
    Returns:
    
    agreedOn
  - setAgreedOn
```
public void setAgreedOn(Object agreedOn)
```
    setAgreedOn.
  - agreementId
```
public UserAgreementResponse agreementId(String agreementId)
```
    agreementId.
    
    Returns:
    
    UserAgreementResponse
  - getAgreementId
```
public String getAgreementId()
```
    The agreement ID..
    
    Returns:
    
    agreementId
  - setAgreementId
```
public void setAgreementId(String agreementId)
```
    setAgreementId.
  - agreementUrl
```
public UserAgreementResponse agreementUrl(String agreementUrl)
```
    agreementUrl.
    
    Returns:
    
    UserAgreementResponse
  - getAgreementUrl
```
public String getAgreementUrl()
```
    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. .
    
    Returns:
    
    agreementUrl
  - setAgreementUrl
```
public void setAgreementUrl(String agreementUrl)
```
    setAgreementUrl.
  - clickwrapId
```
public UserAgreementResponse clickwrapId(String clickwrapId)
```
    clickwrapId.
    
    Returns:
    
    UserAgreementResponse
  - getClickwrapId
```
public String getClickwrapId()
```
    The ID of the clickwrap..
    
    Returns:
    
    clickwrapId
  - setClickwrapId
```
public void setClickwrapId(String clickwrapId)
```
    setClickwrapId.
  - clientUserId
```
public UserAgreementResponse clientUserId(String clientUserId)
```
    clientUserId.
    
    Returns:
    
    UserAgreementResponse
  - getClientUserId
```
public String getClientUserId()
```
    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\".
    
    Returns:
    
    clientUserId
  - setClientUserId
```
public void setClientUserId(String clientUserId)
```
    setClientUserId.
  - consumerDisclosureEnabled
```
public UserAgreementResponse consumerDisclosureEnabled(Boolean consumerDisclosureEnabled)
```
    consumerDisclosureEnabled.
    
    Returns:
    
    UserAgreementResponse
  - isConsumerDisclosureEnabled
```
public Boolean isConsumerDisclosureEnabled()
```
    **True** if consumer disclosure was required by this agreement..
    
    Returns:
    
    consumerDisclosureEnabled
  - setConsumerDisclosureEnabled
```
public void setConsumerDisclosureEnabled(Boolean consumerDisclosureEnabled)
```
    setConsumerDisclosureEnabled.
  - consumerDisclosureHtml
```
public UserAgreementResponse consumerDisclosureHtml(String consumerDisclosureHtml)
```
    consumerDisclosureHtml.
    
    Returns:
    
    UserAgreementResponse
  - getConsumerDisclosureHtml
```
public String getConsumerDisclosureHtml()
```
    The customer-branded HTML with the Electronic Record and Signature Disclosure information.
    
    Returns:
    
    consumerDisclosureHtml
  - setConsumerDisclosureHtml
```
public void setConsumerDisclosureHtml(String consumerDisclosureHtml)
```
    setConsumerDisclosureHtml.
  - createdOn
```
public UserAgreementResponse createdOn(Object createdOn)
```
    createdOn.
    
    Returns:
    
    UserAgreementResponse
  - getCreatedOn
```
public Object getCreatedOn()
```
    The date when the clickwrap was created. May be null..
    
    Returns:
    
    createdOn
  - setCreatedOn
```
public void setCreatedOn(Object createdOn)
```
    setCreatedOn.
  - dataFields
```
public UserAgreementResponse dataFields(List<DataField> dataFields)
```
    dataFields.
    
    Returns:
    
    UserAgreementResponse
  - addDataFieldsItem
```
public UserAgreementResponse addDataFieldsItem(DataField dataFieldsItem)
```
    addDataFieldsItem.
    
    Returns:
    
    UserAgreementResponse
  - getDataFields
```
public List<DataField> getDataFields()
```
    The list of all the data fields available for the clickwrap (custom fields and standard fields)..
    
    Returns:
    
    dataFields
  - setDataFields
```
public void setDataFields(List<DataField> dataFields)
```
    setDataFields.
  - declinedOn
```
public UserAgreementResponse declinedOn(Object declinedOn)
```
    declinedOn.
    
    Returns:
    
    UserAgreementResponse
  - getDeclinedOn
```
public Object getDeclinedOn()
```
    The date when the user declined the most recent required agreement. This property is valid only when `status` is `declined`. Otherwise it is null..
    
    Returns:
    
    declinedOn
  - setDeclinedOn
```
public void setDeclinedOn(Object declinedOn)
```
    setDeclinedOn.
  - documentData
```
public UserAgreementResponse documentData(Map<String,String> documentData)
```
    documentData.
    
    Returns:
    
    UserAgreementResponse
  - putDocumentDataItem
```
public UserAgreementResponse putDocumentDataItem(String key,
                                                 String documentDataItem)
```
    putDocumentDataItem.
    
    Returns:
    
    UserAgreementResponse
  - getDocumentData
```
public Map<String,String> getDocumentData()
```
    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 .
    
    Returns:
    
    documentData
  - setDocumentData
```
public void setDocumentData(Map<String,String> documentData)
```
    setDocumentData.
  - documents
```
public UserAgreementResponse documents(List<Document> documents)
```
    documents.
    
    Returns:
    
    UserAgreementResponse
  - addDocumentsItem
```
public UserAgreementResponse addDocumentsItem(Document documentsItem)
```
    addDocumentsItem.
    
    Returns:
    
    UserAgreementResponse
  - getDocuments
```
public List<Document> getDocuments()
```
    An array of documents..
    
    Returns:
    
    documents
  - setDocuments
```
public void setDocuments(List<Document> documents)
```
    setDocuments.
  - metadata
```
public UserAgreementResponse metadata(String metadata)
```
    metadata.
    
    Returns:
    
    UserAgreementResponse
  - getMetadata
```
public String getMetadata()
```
    A customer-defined string you can use in requests. This string will appear in the corresponding response..
    
    Returns:
    
    metadata
  - setMetadata
```
public void setMetadata(String metadata)
```
    setMetadata.
  - returnUrl
```
public UserAgreementResponse returnUrl(String returnUrl)
```
    returnUrl.
    
    Returns:
    
    UserAgreementResponse
  - getReturnUrl
```
public String getReturnUrl()
```
    The URL redirected to after the agreement was completed..
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
    setReturnUrl.
  - settings
```
public UserAgreementResponse settings(DisplaySettings settings)
```
    settings.
    
    Returns:
    
    UserAgreementResponse
  - getSettings
```
public DisplaySettings getSettings()
```
    The display settings for this agreement..
    
    Returns:
    
    settings
  - setSettings
```
public void setSettings(DisplaySettings settings)
```
    setSettings.
  - status
```
public UserAgreementResponse status(String status)
```
    status.
    
    Returns:
    
    UserAgreementResponse
  - getStatus
```
public String getStatus()
```
    User agreement status. One of: - `created` - `agreed` - `declined`.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(String status)
```
    setStatus.
  - style
```
public UserAgreementResponse style(Map<String,String> style)
```
    style.
    
    Returns:
    
    UserAgreementResponse
  - putStyleItem
```
public UserAgreementResponse putStyleItem(String key,
                                          String styleItem)
```
    putStyleItem.
    
    Returns:
    
    UserAgreementResponse
  - getStyle
```
public Map<String,String> getStyle()
```
    This property specifies the custom style provided when the agreement was created by [customizing the template appearance][]. [customizing the template appearance]: /docs/click-api/click101/customize-elastic-template-appearance/ .
    
    Returns:
    
    style
  - setStyle
```
public void setStyle(Map<String,String> style)
```
    setStyle.
  - version
```
public UserAgreementResponse version(String version)
```
    version.
    
    Returns:
    
    UserAgreementResponse
  - getVersion
```
public String getVersion()
```
    The human-readable semver version string..
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(String version)
```
    setVersion.
  - versionId
```
public UserAgreementResponse versionId(String versionId)
```
    versionId.
    
    Returns:
    
    UserAgreementResponse
  - getVersionId
```
public String getVersionId()
```
    The ID of the version..
    
    Returns:
    
    versionId
  - setVersionId
```
public void setVersionId(String versionId)
```
    setVersionId.
  - versionNumber
```
public UserAgreementResponse versionNumber(Integer versionNumber)
```
    versionNumber.
    
    Returns:
    
    UserAgreementResponse
  - getVersionNumber
```
public Integer getVersionNumber()
```
    Version of the clickwrap..
    
    Returns:
    
    versionNumber
  - setVersionNumber
```
public void setVersionNumber(Integer versionNumber)
```
    setVersionNumber.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class UserAgreementResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserAgreementResponse

Method Detail

accountId

getAccountId

setAccountId

agreedOn

getAgreedOn

setAgreedOn

agreementId

getAgreementId

setAgreementId

agreementUrl

getAgreementUrl

setAgreementUrl

clickwrapId

getClickwrapId

setClickwrapId

clientUserId

getClientUserId

setClientUserId

consumerDisclosureEnabled

isConsumerDisclosureEnabled

setConsumerDisclosureEnabled

consumerDisclosureHtml

getConsumerDisclosureHtml

setConsumerDisclosureHtml

createdOn

getCreatedOn

setCreatedOn

dataFields

addDataFieldsItem

getDataFields

setDataFields

declinedOn

getDeclinedOn

setDeclinedOn

documentData

putDocumentDataItem

getDocumentData

setDocumentData

documents

addDocumentsItem

getDocuments

setDocuments

metadata

getMetadata

setMetadata

returnUrl

getReturnUrl

setReturnUrl

settings

getSettings

setSettings

status

getStatus

setStatus

style

putStyleItem

getStyle

setStyle

version

getVersion

setVersion

versionId

getVersionId

setVersionId

versionNumber

getVersionNumber

setVersionNumber

equals

hashCode

toString