Package com.hellosign.openapi.model

Class SignatureRequestResponse

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SignatureRequestResponse
extends java.lang.Object
    Contains information about a signature request.

    • Field Detail

      • JSON_PROPERTY_TEST_MODE

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

      • JSON_PROPERTY_SIGNATURE_REQUEST_ID

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

      • JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS

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

      • JSON_PROPERTY_TITLE

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

      • JSON_PROPERTY_ORIGINAL_TITLE

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

      • JSON_PROPERTY_SUBJECT

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

      • JSON_PROPERTY_MESSAGE

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

      • JSON_PROPERTY_METADATA

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

      • JSON_PROPERTY_CREATED_AT

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

      • JSON_PROPERTY_IS_COMPLETE

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

      • JSON_PROPERTY_IS_DECLINED

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

      • JSON_PROPERTY_HAS_ERROR

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

      • JSON_PROPERTY_FILES_URL

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

      • JSON_PROPERTY_SIGNING_URL

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

      • JSON_PROPERTY_DETAILS_URL

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

      • JSON_PROPERTY_CC_EMAIL_ADDRESSES

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

      • JSON_PROPERTY_SIGNING_REDIRECT_URL

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

      • JSON_PROPERTY_TEMPLATE_IDS

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

      • JSON_PROPERTY_CUSTOM_FIELDS

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

      • JSON_PROPERTY_ATTACHMENTS

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

      • JSON_PROPERTY_RESPONSE_DATA

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

      • JSON_PROPERTY_SIGNATURES

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

    • Constructor Detail

      • SignatureRequestResponse

        public SignatureRequestResponse()

    • Method Detail

      • getTestMode

        @Nullable
public java.lang.Boolean getTestMode()
        Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
        Returns:
        testMode

      • setTestMode

        public void setTestMode​(java.lang.Boolean testMode)

      • getSignatureRequestId

        @Nullable
public java.lang.String getSignatureRequestId()
        The id of the SignatureRequest.
        Returns:
        signatureRequestId

      • setSignatureRequestId

        public void setSignatureRequestId​(java.lang.String signatureRequestId)

      • requesterEmailAddress

        public SignatureRequestResponse requesterEmailAddress​(java.lang.String requesterEmailAddress)

      • getRequesterEmailAddress

        @Nullable
public java.lang.String getRequesterEmailAddress()
        The email address of the initiator of the SignatureRequest.
        Returns:
        requesterEmailAddress

      • setRequesterEmailAddress

        public void setRequesterEmailAddress​(java.lang.String requesterEmailAddress)

      • getTitle

        @Nullable
public java.lang.String getTitle()
        The title the specified Account uses for the SignatureRequest.
        Returns:
        title

      • setTitle

        public void setTitle​(java.lang.String title)

      • getOriginalTitle

        @Nullable
public java.lang.String getOriginalTitle()
        Default Label for account.
        Returns:
        originalTitle

      • setOriginalTitle

        public void setOriginalTitle​(java.lang.String originalTitle)

      • getSubject

        @Nullable
public java.lang.String getSubject()
        The subject in the email that was initially sent to the signers.
        Returns:
        subject

      • setSubject

        public void setSubject​(java.lang.String subject)

      • getMessage

        @Nullable
public java.lang.String getMessage()
        The custom message in the email that was initially sent to the signers.
        Returns:
        message

      • setMessage

        public void setMessage​(java.lang.String message)

      • getMetadata

        @Nullable
public java.lang.Object getMetadata()
        The metadata attached to the signature request.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(java.lang.Object metadata)

      • getCreatedAt

        @Nullable
public java.lang.Integer getCreatedAt()
        Time the signature request was created.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(java.lang.Integer createdAt)

      • getIsComplete

        @Nullable
public java.lang.Boolean getIsComplete()
        Whether or not the SignatureRequest has been fully executed by all signers.
        Returns:
        isComplete

      • setIsComplete

        public void setIsComplete​(java.lang.Boolean isComplete)

      • getIsDeclined

        @Nullable
public java.lang.Boolean getIsDeclined()
        Whether or not the SignatureRequest has been declined by a signer.
        Returns:
        isDeclined

      • setIsDeclined

        public void setIsDeclined​(java.lang.Boolean isDeclined)

      • getHasError

        @Nullable
public java.lang.Boolean getHasError()
        Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
        Returns:
        hasError

      • setHasError

        public void setHasError​(java.lang.Boolean hasError)

      • getFilesUrl

        @Nullable
public java.lang.String getFilesUrl()
        The URL where a copy of the request's documents can be downloaded.
        Returns:
        filesUrl

      • setFilesUrl

        public void setFilesUrl​(java.lang.String filesUrl)

      • getSigningUrl

        @Nullable
public java.lang.String getSigningUrl()
        The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.
        Returns:
        signingUrl

      • setSigningUrl

        public void setSigningUrl​(java.lang.String signingUrl)

      • getDetailsUrl

        @Nullable
public java.lang.String getDetailsUrl()
        The URL where the requester and the signers can view the current status of the SignatureRequest.
        Returns:
        detailsUrl

      • setDetailsUrl

        public void setDetailsUrl​(java.lang.String detailsUrl)

      • ccEmailAddresses

        public SignatureRequestResponse ccEmailAddresses​(java.util.List<java.lang.String> ccEmailAddresses)

      • addCcEmailAddressesItem

        public SignatureRequestResponse addCcEmailAddressesItem​(java.lang.String ccEmailAddressesItem)

      • getCcEmailAddresses

        @Nullable
public java.util.List<java.lang.String> getCcEmailAddresses()
        A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
        Returns:
        ccEmailAddresses

      • setCcEmailAddresses

        public void setCcEmailAddresses​(java.util.List<java.lang.String> ccEmailAddresses)

      • getSigningRedirectUrl

        @Nullable
public java.lang.String getSigningRedirectUrl()
        The URL you want the signer redirected to after they successfully sign.
        Returns:
        signingRedirectUrl

      • setSigningRedirectUrl

        public void setSigningRedirectUrl​(java.lang.String signingRedirectUrl)

      • getTemplateIds

        @Nullable
public java.util.List<java.lang.String> getTemplateIds()
        Templates IDs used in this SignatureRequest (if any).
        Returns:
        templateIds

      • setTemplateIds

        public void setTemplateIds​(java.util.List<java.lang.String> templateIds)

      • getCustomFields

        @Nullable
public java.util.List<SignatureRequestResponseCustomFieldBase> getCustomFields()
        An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
        Returns:
        customFields

      • getResponseData

        @Nullable
public java.util.List<SignatureRequestResponseDataBase> getResponseData()
        An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
        Returns:
        responseData

      • getSignatures

        @Nullable
public java.util.List<SignatureRequestResponseSignatures> getSignatures()
        An array of signature objects, 1 for each signer.
        Returns:
        signatures

      • equals

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