Class UnclaimedDraftResponse


  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
    public class UnclaimedDraftResponse
    extends java.lang.Object
    A group of documents that a user can take ownership of via the claim URL.
    • Field Detail

      • JSON_PROPERTY_SIGNATURE_REQUEST_ID

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

        public static final java.lang.String JSON_PROPERTY_CLAIM_URL
        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_REQUESTING_REDIRECT_URL

        public static final java.lang.String JSON_PROPERTY_REQUESTING_REDIRECT_URL
        See Also:
        Constant Field Values
      • JSON_PROPERTY_EXPIRES_AT

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

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

      • UnclaimedDraftResponse

        public UnclaimedDraftResponse()
    • Method Detail

      • signatureRequestId

        public UnclaimedDraftResponse signatureRequestId​(java.lang.String signatureRequestId)
      • getSignatureRequestId

        @Nullable
        public java.lang.String getSignatureRequestId()
        The ID of the signature request that is represented by this UnclaimedDraft.
        Returns:
        signatureRequestId
      • setSignatureRequestId

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

        @Nullable
        public java.lang.String getClaimUrl()
        The URL to be used to claim this UnclaimedDraft.
        Returns:
        claimUrl
      • setClaimUrl

        public void setClaimUrl​(java.lang.String claimUrl)
      • signingRedirectUrl

        public UnclaimedDraftResponse signingRedirectUrl​(java.lang.String signingRedirectUrl)
      • getSigningRedirectUrl

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

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

        public UnclaimedDraftResponse requestingRedirectUrl​(java.lang.String requestingRedirectUrl)
      • getRequestingRedirectUrl

        @Nullable
        public java.lang.String getRequestingRedirectUrl()
        The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).
        Returns:
        requestingRedirectUrl
      • setRequestingRedirectUrl

        public void setRequestingRedirectUrl​(java.lang.String requestingRedirectUrl)
      • getExpiresAt

        @Nullable
        public java.lang.Integer getExpiresAt()
        When the link expires.
        Returns:
        expiresAt
      • setExpiresAt

        public void setExpiresAt​(java.lang.Integer expiresAt)
      • getTestMode

        @Nullable
        public java.lang.Boolean getTestMode()
        Whether this is a test draft. Signature requests made from test drafts have no legal value.
        Returns:
        testMode
      • setTestMode

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

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