Package com.hellosign.openapi.model

Class SubSignatureRequestSigner

java.lang.Object

com.hellosign.openapi.model.SubSignatureRequestSigner

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SubSignatureRequestSigner
extends java.lang.Object

SubSignatureRequestSigner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubSignatureRequestSigner.SmsPhoneNumberTypeEnum	Specifies the feature used with the `sms_phone_number`.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	JSON_PROPERTY_EMAIL_ADDRESS
static java.lang.String	JSON_PROPERTY_NAME
static java.lang.String	JSON_PROPERTY_ORDER
static java.lang.String	JSON_PROPERTY_PIN
static java.lang.String	JSON_PROPERTY_SMS_PHONE_NUMBER
static java.lang.String	JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE

Constructor Summary

Constructors

Constructor	Description
SubSignatureRequestSigner()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	createFormData()
SubSignatureRequestSigner	emailAddress(java.lang.String emailAddress)
boolean	equals(java.lang.Object o)	Return true if this SubSignatureRequestSigner object is equal to o.
java.lang.String	getEmailAddress()	The email address of the signer.
java.lang.String	getName()	The name of the signer.
java.lang.Integer	getOrder()	The order the signer is required to sign in.
java.lang.String	getPin()	The 4- to 12-character access code that will secure this signer's signature page.
java.lang.String	getSmsPhoneNumber()	An E.164 formatted phone number.
SubSignatureRequestSigner.SmsPhoneNumberTypeEnum	getSmsPhoneNumberType()	Specifies the feature used with the `sms_phone_number`.
int	hashCode()
SubSignatureRequestSigner	name(java.lang.String name)
SubSignatureRequestSigner	order(java.lang.Integer order)
SubSignatureRequestSigner	pin(java.lang.String pin)
void	setEmailAddress(java.lang.String emailAddress)
void	setName(java.lang.String name)
void	setOrder(java.lang.Integer order)
void	setPin(java.lang.String pin)
void	setSmsPhoneNumber(java.lang.String smsPhoneNumber)
void	setSmsPhoneNumberType(SubSignatureRequestSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)
SubSignatureRequestSigner	smsPhoneNumber(java.lang.String smsPhoneNumber)
SubSignatureRequestSigner	smsPhoneNumberType(SubSignatureRequestSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_NAME

public static final java.lang.String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_EMAIL_ADDRESS

public static final java.lang.String JSON_PROPERTY_EMAIL_ADDRESS

See Also:

Constant Field Values

JSON_PROPERTY_ORDER

public static final java.lang.String JSON_PROPERTY_ORDER

See Also:

Constant Field Values

JSON_PROPERTY_PIN

public static final java.lang.String JSON_PROPERTY_PIN

See Also:

Constant Field Values

JSON_PROPERTY_SMS_PHONE_NUMBER

public static final java.lang.String JSON_PROPERTY_SMS_PHONE_NUMBER

See Also:

Constant Field Values

JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE

public static final java.lang.String JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE

See Also:

Constant Field Values

Constructor Detail

SubSignatureRequestSigner

public SubSignatureRequestSigner()

Method Detail

name

public SubSignatureRequestSigner name(java.lang.String name)

getName

@Nonnull
public java.lang.String getName()

The name of the signer.

Returns:

name

setName

public void setName(java.lang.String name)

emailAddress

public SubSignatureRequestSigner emailAddress(java.lang.String emailAddress)

getEmailAddress

@Nonnull
public java.lang.String getEmailAddress()

The email address of the signer.

Returns:

emailAddress

setEmailAddress

public void setEmailAddress(java.lang.String emailAddress)

order

public SubSignatureRequestSigner order(java.lang.Integer order)

getOrder

@Nullable
public java.lang.Integer getOrder()

The order the signer is required to sign in.

Returns:

order

setOrder

public void setOrder(java.lang.Integer order)

pin

public SubSignatureRequestSigner pin(java.lang.String pin)

getPin

@Nullable
public java.lang.String getPin()

The 4- to 12-character access code that will secure this signer's signature page.

Returns:

pin

setPin

public void setPin(java.lang.String pin)

smsPhoneNumber

public SubSignatureRequestSigner smsPhoneNumber(java.lang.String smsPhoneNumber)

getSmsPhoneNumber

@Nullable
public java.lang.String getSmsPhoneNumber()

An E.164 formatted phone number. **Note**: Not available in test mode and requires a Standard plan or higher.

Returns:

smsPhoneNumber

setSmsPhoneNumber

public void setSmsPhoneNumber(java.lang.String smsPhoneNumber)

smsPhoneNumberType

public SubSignatureRequestSigner smsPhoneNumberType(SubSignatureRequestSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)

getSmsPhoneNumberType

@Nullable
public SubSignatureRequestSigner.SmsPhoneNumberTypeEnum getSmsPhoneNumberType()

Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, the completed signature request is delivered via SMS (_and_ email).

Returns:

smsPhoneNumberType

setSmsPhoneNumberType

public void setSmsPhoneNumberType(SubSignatureRequestSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)

equals

public boolean equals(java.lang.Object o)

Return true if this SubSignatureRequestSigner object is equal to o.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createFormData

public java.util.Map<java.lang.String,java.lang.Object> createFormData()
                                                                      throws ApiException

Throws:

ApiException