com.docusign.esign.model.RecipientViewRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docusign-esign-java Show documentation
Show all versions of docusign-esign-java Show documentation
The official Docusign eSignature JAVA client is based on version 2.1 of the Docusign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.
package com.docusign.esign.model;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Objects;
/**
* The request body for the [EnvelopeViews:
* createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and
* [EnvelopeViews:
* createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/)
* methods..
*/
@Schema(
description =
"The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and [EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods.")
public class RecipientViewRequest {
@JsonProperty("assertionId")
private String assertionId = null;
@JsonProperty("authenticationInstant")
private String authenticationInstant = null;
@JsonProperty("authenticationMethod")
private String authenticationMethod = null;
@JsonProperty("clientURLs")
private RecipientTokenClientURLs clientURLs = null;
@JsonProperty("clientUserId")
private String clientUserId = null;
@JsonProperty("email")
private String email = null;
@JsonProperty("frameAncestors")
private java.util.List frameAncestors = null;
@JsonProperty("messageOrigins")
private java.util.List messageOrigins = null;
@JsonProperty("pingFrequency")
private String pingFrequency = null;
@JsonProperty("pingUrl")
private String pingUrl = null;
@JsonProperty("recipientId")
private String recipientId = null;
@JsonProperty("returnUrl")
private String returnUrl = null;
@JsonProperty("securityDomain")
private String securityDomain = null;
@JsonProperty("userId")
private String userId = null;
@JsonProperty("userName")
private String userName = null;
@JsonProperty("xFrameOptions")
private String xFrameOptions = null;
@JsonProperty("xFrameOptionsAllowFromUrl")
private String xFrameOptionsAllowFromUrl = null;
/**
* assertionId.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest assertionId(String assertionId) {
this.assertionId = assertionId;
return this;
}
/**
* A unique identifier of the authentication event executed by the client application..
*
* @return assertionId
*/
@Schema(
description =
"A unique identifier of the authentication event executed by the client application.")
public String getAssertionId() {
return assertionId;
}
/** setAssertionId. */
public void setAssertionId(String assertionId) {
this.assertionId = assertionId;
}
/**
* authenticationInstant.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest authenticationInstant(String authenticationInstant) {
this.authenticationInstant = authenticationInstant;
return this;
}
/**
* A sender generated value that indicates the date/time that the signer was authenticated..
*
* @return authenticationInstant
*/
@Schema(
description =
"A sender generated value that indicates the date/time that the signer was authenticated.")
public String getAuthenticationInstant() {
return authenticationInstant;
}
/** setAuthenticationInstant. */
public void setAuthenticationInstant(String authenticationInstant) {
this.authenticationInstant = authenticationInstant;
}
/**
* authenticationMethod.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest authenticationMethod(String authenticationMethod) {
this.authenticationMethod = authenticationMethod;
return this;
}
/**
* A sender created value that indicates the convention used to authenticate the signer. This
* information is included in the Certificate of Completion..
*
* @return authenticationMethod
*/
@Schema(
description =
"A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.")
public String getAuthenticationMethod() {
return authenticationMethod;
}
/** setAuthenticationMethod. */
public void setAuthenticationMethod(String authenticationMethod) {
this.authenticationMethod = authenticationMethod;
}
/**
* clientURLs.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest clientURLs(RecipientTokenClientURLs clientURLs) {
this.clientURLs = clientURLs;
return this;
}
/**
* .
*
* @return clientURLs
*/
@Schema(description = "")
public RecipientTokenClientURLs getClientURLs() {
return clientURLs;
}
/** setClientURLs. */
public void setClientURLs(RecipientTokenClientURLs clientURLs) {
this.clientURLs = clientURLs;
}
/**
* clientUserId.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest clientUserId(String clientUserId) {
this.clientUserId = clientUserId;
return this;
}
/**
* A sender created value that shows the recipient is embedded (captive). Maximum length: 100
* characters..
*
* @return clientUserId
*/
@Schema(
description =
"A sender created value that shows the recipient is embedded (captive). Maximum length: 100 characters.")
public String getClientUserId() {
return clientUserId;
}
/** setClientUserId. */
public void setClientUserId(String clientUserId) {
this.clientUserId = clientUserId;
}
/**
* email.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest email(String email) {
this.email = email;
return this;
}
/**
* Specifies the email of the recipient. You can use either email and userName or userId to
* identify the recipient..
*
* @return email
*/
@Schema(
description =
"Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.")
public String getEmail() {
return email;
}
/** setEmail. */
public void setEmail(String email) {
this.email = email;
}
/**
* frameAncestors.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest frameAncestors(java.util.List frameAncestors) {
this.frameAncestors = frameAncestors;
return this;
}
/**
* addFrameAncestorsItem.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest addFrameAncestorsItem(String frameAncestorsItem) {
if (this.frameAncestors == null) {
this.frameAncestors = new java.util.ArrayList<>();
}
this.frameAncestors.add(frameAncestorsItem);
return this;
}
/**
* .
*
* @return frameAncestors
*/
@Schema(description = "")
public java.util.List getFrameAncestors() {
return frameAncestors;
}
/** setFrameAncestors. */
public void setFrameAncestors(java.util.List frameAncestors) {
this.frameAncestors = frameAncestors;
}
/**
* messageOrigins.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest messageOrigins(java.util.List messageOrigins) {
this.messageOrigins = messageOrigins;
return this;
}
/**
* addMessageOriginsItem.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest addMessageOriginsItem(String messageOriginsItem) {
if (this.messageOrigins == null) {
this.messageOrigins = new java.util.ArrayList<>();
}
this.messageOrigins.add(messageOriginsItem);
return this;
}
/**
* .
*
* @return messageOrigins
*/
@Schema(description = "")
public java.util.List getMessageOrigins() {
return messageOrigins;
}
/** setMessageOrigins. */
public void setMessageOrigins(java.util.List messageOrigins) {
this.messageOrigins = messageOrigins;
}
/**
* pingFrequency.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest pingFrequency(String pingFrequency) {
this.pingFrequency = pingFrequency;
return this;
}
/**
* Only used if pingUrl is specified. This is the interval, in seconds, between pings on the
* pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds..
*
* @return pingFrequency
*/
@Schema(
description =
"Only used if pingUrl is specified. This is the interval, in seconds, between pings on the pingUrl. The default is 300 seconds. Valid values are 60-1200 seconds.")
public String getPingFrequency() {
return pingFrequency;
}
/** setPingFrequency. */
public void setPingFrequency(String pingFrequency) {
this.pingFrequency = pingFrequency;
}
/**
* pingUrl.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest pingUrl(String pingUrl) {
this.pingUrl = pingUrl;
return this;
}
/**
* A client Url to be pinged by the DocuSign Signing experience to indicate to the client that
* Signing is active. An HTTP Get is executed against the client. The response from the client is
* ignored. The intent is for the client to reset it's session timer when the request is
* received..
*
* @return pingUrl
*/
@Schema(
description =
"A client Url to be pinged by the DocuSign Signing experience to indicate to the client that Signing is active. An HTTP Get is executed against the client. The response from the client is ignored. The intent is for the client to reset it's session timer when the request is received.")
public String getPingUrl() {
return pingUrl;
}
/** setPingUrl. */
public void setPingUrl(String pingUrl) {
this.pingUrl = pingUrl;
}
/**
* recipientId.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest recipientId(String recipientId) {
this.recipientId = recipientId;
return this;
}
/**
* Unique for the recipient. It is used by the tab element to indicate which recipient is to sign
* the Document..
*
* @return recipientId
*/
@Schema(
description =
"Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.")
public String getRecipientId() {
return recipientId;
}
/** setRecipientId. */
public void setRecipientId(String recipientId) {
this.recipientId = recipientId;
}
/**
* returnUrl.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest returnUrl(String returnUrl) {
this.returnUrl = returnUrl;
return this;
}
/**
* The url the recipient is redirected to after the signing session has ended. DocuSign redirects
* to the url and includes an event parameter that can be used by your application. Possible event
* parameter values: * cancel (recipient canceled the signing operation) * decline (recipient
* declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax
* pending) * session_timeout (session timed out) * signing_complete (signer completed the signing
* ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient
* completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might
* not succeed on some browsers. .
*
* @return returnUrl
*/
@Schema(
description =
"The url the recipient is redirected to after the signing session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your application. Possible event parameter values: * cancel (recipient canceled the signing operation) * decline (recipient declined to sign) * exception (an exception occurred) * fax_pending (recipient has a fax pending) * session_timeout (session timed out) * signing_complete (signer completed the signing ceremony) * ttl_expired (the TTL, time to live, timer expired) * viewing_complete (recipient completed viewing the envelope) ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. ")
public String getReturnUrl() {
return returnUrl;
}
/** setReturnUrl. */
public void setReturnUrl(String returnUrl) {
this.returnUrl = returnUrl;
}
/**
* securityDomain.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest securityDomain(String securityDomain) {
this.securityDomain = securityDomain;
return this;
}
/**
* The domain in which the user authenticated..
*
* @return securityDomain
*/
@Schema(description = "The domain in which the user authenticated.")
public String getSecurityDomain() {
return securityDomain;
}
/** setSecurityDomain. */
public void setSecurityDomain(String securityDomain) {
this.securityDomain = securityDomain;
}
/**
* userId.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest userId(String userId) {
this.userId = userId;
return this;
}
/**
* Specifies the user ID of the recipient. You can use with user ID or email and user name to
* identify the recipient. If user ID is used and a client user ID is provided, the value in the
* `userId` property must match a recipient ID (which can be retrieved with a GET recipients call)
* for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match
* the user ID of the authenticating user..
*
* @return userId
*/
@Schema(
description =
"Specifies the user ID of the recipient. You can use with user ID or email and user name to identify the recipient. If user ID is used and a client user ID is provided, the value in the `userId` property must match a recipient ID (which can be retrieved with a GET recipients call) for the envelope. If a user ID is used and a clientUser ID is not provided, the user ID match the user ID of the authenticating user.")
public String getUserId() {
return userId;
}
/** setUserId. */
public void setUserId(String userId) {
this.userId = userId;
}
/**
* userName.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest userName(String userName) {
this.userName = userName;
return this;
}
/**
* Specifies the username of the recipient. You can use either email and userName or userId to
* identify the recipient..
*
* @return userName
*/
@Schema(
description =
"Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.")
public String getUserName() {
return userName;
}
/** setUserName. */
public void setUserName(String userName) {
this.userName = userName;
}
/**
* xFrameOptions.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest xFrameOptions(String xFrameOptions) {
this.xFrameOptions = xFrameOptions;
return this;
}
/**
* .
*
* @return xFrameOptions
*/
@Schema(description = "")
public String getXFrameOptions() {
return xFrameOptions;
}
/** setXFrameOptions. */
public void setXFrameOptions(String xFrameOptions) {
this.xFrameOptions = xFrameOptions;
}
/**
* xFrameOptionsAllowFromUrl.
*
* @return RecipientViewRequest
*/
public RecipientViewRequest xFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl) {
this.xFrameOptionsAllowFromUrl = xFrameOptionsAllowFromUrl;
return this;
}
/**
* .
*
* @return xFrameOptionsAllowFromUrl
*/
@Schema(description = "")
public String getXFrameOptionsAllowFromUrl() {
return xFrameOptionsAllowFromUrl;
}
/** setXFrameOptionsAllowFromUrl. */
public void setXFrameOptionsAllowFromUrl(String xFrameOptionsAllowFromUrl) {
this.xFrameOptionsAllowFromUrl = xFrameOptionsAllowFromUrl;
}
/**
* Compares objects.
*
* @return true or false depending on comparison result.
*/
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
RecipientViewRequest recipientViewRequest = (RecipientViewRequest) o;
return Objects.equals(this.assertionId, recipientViewRequest.assertionId)
&& Objects.equals(this.authenticationInstant, recipientViewRequest.authenticationInstant)
&& Objects.equals(this.authenticationMethod, recipientViewRequest.authenticationMethod)
&& Objects.equals(this.clientURLs, recipientViewRequest.clientURLs)
&& Objects.equals(this.clientUserId, recipientViewRequest.clientUserId)
&& Objects.equals(this.email, recipientViewRequest.email)
&& Objects.equals(this.frameAncestors, recipientViewRequest.frameAncestors)
&& Objects.equals(this.messageOrigins, recipientViewRequest.messageOrigins)
&& Objects.equals(this.pingFrequency, recipientViewRequest.pingFrequency)
&& Objects.equals(this.pingUrl, recipientViewRequest.pingUrl)
&& Objects.equals(this.recipientId, recipientViewRequest.recipientId)
&& Objects.equals(this.returnUrl, recipientViewRequest.returnUrl)
&& Objects.equals(this.securityDomain, recipientViewRequest.securityDomain)
&& Objects.equals(this.userId, recipientViewRequest.userId)
&& Objects.equals(this.userName, recipientViewRequest.userName)
&& Objects.equals(this.xFrameOptions, recipientViewRequest.xFrameOptions)
&& Objects.equals(
this.xFrameOptionsAllowFromUrl, recipientViewRequest.xFrameOptionsAllowFromUrl);
}
/** Returns the HashCode. */
@Override
public int hashCode() {
return Objects.hash(
assertionId,
authenticationInstant,
authenticationMethod,
clientURLs,
clientUserId,
email,
frameAncestors,
messageOrigins,
pingFrequency,
pingUrl,
recipientId,
returnUrl,
securityDomain,
userId,
userName,
xFrameOptions,
xFrameOptionsAllowFromUrl);
}
/** Converts the given object to string. */
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class RecipientViewRequest {\n");
sb.append(" assertionId: ").append(toIndentedString(assertionId)).append("\n");
sb.append(" authenticationInstant: ")
.append(toIndentedString(authenticationInstant))
.append("\n");
sb.append(" authenticationMethod: ")
.append(toIndentedString(authenticationMethod))
.append("\n");
sb.append(" clientURLs: ").append(toIndentedString(clientURLs)).append("\n");
sb.append(" clientUserId: ").append(toIndentedString(clientUserId)).append("\n");
sb.append(" email: ").append(toIndentedString(email)).append("\n");
sb.append(" frameAncestors: ").append(toIndentedString(frameAncestors)).append("\n");
sb.append(" messageOrigins: ").append(toIndentedString(messageOrigins)).append("\n");
sb.append(" pingFrequency: ").append(toIndentedString(pingFrequency)).append("\n");
sb.append(" pingUrl: ").append(toIndentedString(pingUrl)).append("\n");
sb.append(" recipientId: ").append(toIndentedString(recipientId)).append("\n");
sb.append(" returnUrl: ").append(toIndentedString(returnUrl)).append("\n");
sb.append(" securityDomain: ").append(toIndentedString(securityDomain)).append("\n");
sb.append(" userId: ").append(toIndentedString(userId)).append("\n");
sb.append(" userName: ").append(toIndentedString(userName)).append("\n");
sb.append(" xFrameOptions: ").append(toIndentedString(xFrameOptions)).append("\n");
sb.append(" xFrameOptionsAllowFromUrl: ")
.append(toIndentedString(xFrameOptionsAllowFromUrl))
.append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}