Package com.hellosign.openapi.model

Class SignatureRequestResponseSignatures

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SignatureRequestResponseSignatures
extends java.lang.Object
    An array of signature objects, 1 for each signer.

    • Field Detail

      • JSON_PROPERTY_SIGNATURE_ID

        public static final java.lang.String JSON_PROPERTY_SIGNATURE_ID
        See Also:
        Constant Field Values

      • JSON_PROPERTY_SIGNER_EMAIL_ADDRESS

        public static final java.lang.String JSON_PROPERTY_SIGNER_EMAIL_ADDRESS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_SIGNER_NAME

        public static final java.lang.String JSON_PROPERTY_SIGNER_NAME
        See Also:
        Constant Field Values

      • JSON_PROPERTY_SIGNER_ROLE

        public static final java.lang.String JSON_PROPERTY_SIGNER_ROLE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ORDER

        public static final java.lang.String JSON_PROPERTY_ORDER
        See Also:
        Constant Field Values

      • JSON_PROPERTY_STATUS_CODE

        public static final java.lang.String JSON_PROPERTY_STATUS_CODE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DECLINE_REASON

        public static final java.lang.String JSON_PROPERTY_DECLINE_REASON
        See Also:
        Constant Field Values

      • JSON_PROPERTY_SIGNED_AT

        public static final java.lang.String JSON_PROPERTY_SIGNED_AT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LAST_VIEWED_AT

        public static final java.lang.String JSON_PROPERTY_LAST_VIEWED_AT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_LAST_REMINDED_AT

        public static final java.lang.String JSON_PROPERTY_LAST_REMINDED_AT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HAS_PIN

        public static final java.lang.String JSON_PROPERTY_HAS_PIN
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HAS_SMS_AUTH

        public static final java.lang.String JSON_PROPERTY_HAS_SMS_AUTH
        See Also:
        Constant Field Values

      • JSON_PROPERTY_HAS_SMS_DELIVERY

        public static final java.lang.String JSON_PROPERTY_HAS_SMS_DELIVERY
        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_REASSIGNED_BY

        public static final java.lang.String JSON_PROPERTY_REASSIGNED_BY
        See Also:
        Constant Field Values

      • JSON_PROPERTY_REASSIGNMENT_REASON

        public static final java.lang.String JSON_PROPERTY_REASSIGNMENT_REASON
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ERROR

        public static final java.lang.String JSON_PROPERTY_ERROR
        See Also:
        Constant Field Values

    • Constructor Detail

      • SignatureRequestResponseSignatures

        public SignatureRequestResponseSignatures()

    • Method Detail

      • getSignatureId

        @Nullable
public java.lang.String getSignatureId()
        Signature identifier.
        Returns:
        signatureId

      • setSignatureId

        public void setSignatureId​(java.lang.String signatureId)

      • getSignerEmailAddress

        @Nullable
public java.lang.String getSignerEmailAddress()
        The email address of the signer.
        Returns:
        signerEmailAddress

      • setSignerEmailAddress

        public void setSignerEmailAddress​(java.lang.String signerEmailAddress)

      • getSignerName

        @Nullable
public java.lang.String getSignerName()
        The name of the signer.
        Returns:
        signerName

      • setSignerName

        public void setSignerName​(java.lang.String signerName)

      • getSignerRole

        @Nullable
public java.lang.String getSignerRole()
        The role of the signer.
        Returns:
        signerRole

      • setSignerRole

        public void setSignerRole​(java.lang.String signerRole)

      • getOrder

        @Nullable
public java.lang.Integer getOrder()
        If signer order is assigned this is the 0-based index for this signer.
        Returns:
        order

      • setOrder

        public void setOrder​(java.lang.Integer order)

      • getStatusCode

        @Nullable
public java.lang.String getStatusCode()
        The current status of the signature. eg: awaiting_signature, signed, declined.
        Returns:
        statusCode

      • setStatusCode

        public void setStatusCode​(java.lang.String statusCode)

      • getDeclineReason

        @Nullable
public java.lang.String getDeclineReason()
        The reason provided by the signer for declining the request.
        Returns:
        declineReason

      • setDeclineReason

        public void setDeclineReason​(java.lang.String declineReason)

      • getSignedAt

        @Nullable
public java.lang.Integer getSignedAt()
        Time that the document was signed or null.
        Returns:
        signedAt

      • setSignedAt

        public void setSignedAt​(java.lang.Integer signedAt)

      • getLastViewedAt

        @Nullable
public java.lang.Integer getLastViewedAt()
        The time that the document was last viewed by this signer or null.
        Returns:
        lastViewedAt

      • setLastViewedAt

        public void setLastViewedAt​(java.lang.Integer lastViewedAt)

      • getLastRemindedAt

        @Nullable
public java.lang.Integer getLastRemindedAt()
        The time the last reminder email was sent to the signer or null.
        Returns:
        lastRemindedAt

      • setLastRemindedAt

        public void setLastRemindedAt​(java.lang.Integer lastRemindedAt)

      • getHasPin

        @Nullable
public java.lang.Boolean getHasPin()
        Boolean to indicate whether this signature requires a PIN to access.
        Returns:
        hasPin

      • setHasPin

        public void setHasPin​(java.lang.Boolean hasPin)

      • getHasSmsAuth

        @Nullable
public java.lang.Boolean getHasSmsAuth()
        Boolean to indicate whether this signature has SMS authentication enabled.
        Returns:
        hasSmsAuth

      • setHasSmsAuth

        public void setHasSmsAuth​(java.lang.Boolean hasSmsAuth)

      • getHasSmsDelivery

        @Nullable
public java.lang.Boolean getHasSmsDelivery()
        Boolean to indicate whether this signature has SMS delivery enabled.
        Returns:
        hasSmsDelivery

      • setHasSmsDelivery

        public void setHasSmsDelivery​(java.lang.Boolean hasSmsDelivery)

      • getSmsPhoneNumber

        @Nullable
public java.lang.String getSmsPhoneNumber()
        The SMS phone number used for authentication or signature request delivery.
        Returns:
        smsPhoneNumber

      • setSmsPhoneNumber

        public void setSmsPhoneNumber​(java.lang.String smsPhoneNumber)

      • getReassignedBy

        @Nullable
public java.lang.String getReassignedBy()
        Email address of original signer who reassigned to this signer.
        Returns:
        reassignedBy

      • setReassignedBy

        public void setReassignedBy​(java.lang.String reassignedBy)

      • getReassignmentReason

        @Nullable
public java.lang.String getReassignmentReason()
        Reason provided by original signer who reassigned to this signer.
        Returns:
        reassignmentReason

      • setReassignmentReason

        public void setReassignmentReason​(java.lang.String reassignmentReason)

      • getError

        @Nullable
public java.lang.String getError()
        Error message pertaining to this signer, or null.
        Returns:
        error

      • setError

        public void setError​(java.lang.String error)

      • equals

        public boolean equals​(java.lang.Object o)
        Return true if this SignatureRequestResponseSignatures 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