Package com.hellosign.openapi.model

Class SignatureRequestSendWithTemplateRequest

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

    • Field Detail

      • JSON_PROPERTY_TEMPLATE_IDS

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

      • JSON_PROPERTY_SIGNERS

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

      • JSON_PROPERTY_ALLOW_DECLINE

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

      • JSON_PROPERTY_CCS

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

      • JSON_PROPERTY_CLIENT_ID

        public static final java.lang.String JSON_PROPERTY_CLIENT_ID
        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_FILE

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

      • JSON_PROPERTY_FILE_URL

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

      • JSON_PROPERTY_IS_QUALIFIED_SIGNATURE

        public static final java.lang.String JSON_PROPERTY_IS_QUALIFIED_SIGNATURE
        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_SIGNING_OPTIONS

        public static final java.lang.String JSON_PROPERTY_SIGNING_OPTIONS
        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_SUBJECT

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

      • JSON_PROPERTY_TEST_MODE

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

      • JSON_PROPERTY_TITLE

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

    • Constructor Detail

      • SignatureRequestSendWithTemplateRequest

        public SignatureRequestSendWithTemplateRequest()

    • Method Detail

      • getTemplateIds

        @Nonnull
public java.util.List<java.lang.String> getTemplateIds()
        Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
        Returns:
        templateIds

      • setTemplateIds

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

      • getSigners

        @Nonnull
public java.util.List<SubSignatureRequestTemplateSigner> getSigners()
        Add Signers to your Templated-based Signature Request.
        Returns:
        signers

      • getAllowDecline

        @Nullable
public java.lang.Boolean getAllowDecline()
        Allows signers to decline to sign a document if `true`. Defaults to `false`.
        Returns:
        allowDecline

      • setAllowDecline

        public void setAllowDecline​(java.lang.Boolean allowDecline)

      • getCcs

        @Nullable
public java.util.List<SubCC> getCcs()
        Add CC email recipients. Required when a CC role exists for the Template.
        Returns:
        ccs

      • setCcs

        public void setCcs​(java.util.List<SubCC> ccs)

      • getClientId

        @Nullable
public java.lang.String getClientId()
        Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
        Returns:
        clientId

      • setClientId

        public void setClientId​(java.lang.String clientId)

      • getCustomFields

        @Nullable
public java.util.List<SubCustomField> getCustomFields()
        An array defining values and options for custom fields. Required when a custom field exists in the Template.
        Returns:
        customFields

      • setCustomFields

        public void setCustomFields​(java.util.List<SubCustomField> customFields)

      • getFile

        @Nullable
public java.util.List<java.io.File> getFile()
        Use `file[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **file** or **file_url[]**, but not both.
        Returns:
        file

      • setFile

        public void setFile​(java.util.List<java.io.File> file)

      • getFileUrl

        @Nullable
public java.util.List<java.lang.String> getFileUrl()
        Use `file_url[]` to have HelloSign download the file(s) to send for signature. This endpoint requires either **file** or **file_url[]**, but not both.
        Returns:
        fileUrl

      • setFileUrl

        public void setFileUrl​(java.util.List<java.lang.String> fileUrl)

      • getIsQualifiedSignature

        @Nullable
public java.lang.Boolean getIsQualifiedSignature()
        Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.
        Returns:
        isQualifiedSignature

      • setIsQualifiedSignature

        public void setIsQualifiedSignature​(java.lang.Boolean isQualifiedSignature)

      • getMessage

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

      • setMessage

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

      • getMetadata

        @Nullable
public java.util.Map<java.lang.String,​java.lang.Object> getMetadata()
        Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(java.util.Map<java.lang.String,​java.lang.Object> metadata)

      • getSigningOptions

        @Nullable
public SubSigningOptions getSigningOptions()
        Get signingOptions
        Returns:
        signingOptions

      • setSigningOptions

        public void setSigningOptions​(SubSigningOptions signingOptions)

      • 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)

      • getSubject

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

      • setSubject

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

      • getTestMode

        @Nullable
public java.lang.Boolean getTestMode()
        Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
        Returns:
        testMode

      • setTestMode

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

      • getTitle

        @Nullable
public java.lang.String getTitle()
        The title you want to assign to the SignatureRequest.
        Returns:
        title

      • setTitle

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

      • equals

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