Package com.hellosign.openapi.model

Class SubSignatureRequestTemplateSigner

java.lang.Object

com.hellosign.openapi.model.SubSignatureRequestTemplateSigner

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

SubSignatureRequestTemplateSigner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubSignatureRequestTemplateSigner.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_PIN
static java.lang.String	JSON_PROPERTY_ROLE
static java.lang.String	JSON_PROPERTY_SMS_PHONE_NUMBER
static java.lang.String	JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE

Constructor Summary

Constructors

Constructor	Description
SubSignatureRequestTemplateSigner()

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Object>	createFormData()
SubSignatureRequestTemplateSigner	emailAddress(java.lang.String emailAddress)
boolean	equals(java.lang.Object o)	Return true if this SubSignatureRequestTemplateSigner 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.String	getPin()	The 4- to 12-character access code that will secure this signer's signature page.
java.lang.String	getRole()	Must match an existing role in chosen Template(s).
java.lang.String	getSmsPhoneNumber()	An E.164 formatted phone number.
SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum	getSmsPhoneNumberType()	Specifies the feature used with the `sms_phone_number`.
int	hashCode()
SubSignatureRequestTemplateSigner	name(java.lang.String name)
SubSignatureRequestTemplateSigner	pin(java.lang.String pin)
SubSignatureRequestTemplateSigner	role(java.lang.String role)
void	setEmailAddress(java.lang.String emailAddress)
void	setName(java.lang.String name)
void	setPin(java.lang.String pin)
void	setRole(java.lang.String role)
void	setSmsPhoneNumber(java.lang.String smsPhoneNumber)
void	setSmsPhoneNumberType(SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)
SubSignatureRequestTemplateSigner	smsPhoneNumber(java.lang.String smsPhoneNumber)
SubSignatureRequestTemplateSigner	smsPhoneNumberType(SubSignatureRequestTemplateSigner.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_ROLE

public static final java.lang.String JSON_PROPERTY_ROLE

See Also:

Constant Field Values

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_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

SubSignatureRequestTemplateSigner

public SubSignatureRequestTemplateSigner()

Method Detail

role

public SubSignatureRequestTemplateSigner role(java.lang.String role)

getRole

@Nonnull
public java.lang.String getRole()

Must match an existing role in chosen Template(s). It's case-sensitive.

Returns:

role

setRole

public void setRole(java.lang.String role)

name

public SubSignatureRequestTemplateSigner 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 SubSignatureRequestTemplateSigner 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)

pin

public SubSignatureRequestTemplateSigner 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 SubSignatureRequestTemplateSigner 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 SubSignatureRequestTemplateSigner smsPhoneNumberType(SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)

getSmsPhoneNumberType

@Nullable
public SubSignatureRequestTemplateSigner.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(SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum smsPhoneNumberType)

equals

public boolean equals(java.lang.Object o)

Return true if this SubSignatureRequestTemplateSigner 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