Package com.hellosign.openapi.model

Class SignatureRequestSendRequest

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

    • Field Detail

      • JSON_PROPERTY_SIGNERS

        public static final java.lang.String JSON_PROPERTY_SIGNERS
        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_ALLOW_DECLINE

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

      • JSON_PROPERTY_ALLOW_REASSIGN

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

      • JSON_PROPERTY_ATTACHMENTS

        public static final java.lang.String JSON_PROPERTY_ATTACHMENTS
        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_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_FIELD_OPTIONS

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

      • JSON_PROPERTY_FORM_FIELD_GROUPS

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

      • JSON_PROPERTY_FORM_FIELD_RULES

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

      • JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT

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

      • JSON_PROPERTY_HIDE_TEXT_TAGS

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

      • JSON_PROPERTY_USE_TEXT_TAGS

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

    • Constructor Detail

      • SignatureRequestSendRequest

        public SignatureRequestSendRequest()

    • Method Detail

      • getSigners

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

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

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

      • getAllowReassign

        @Nullable
public java.lang.Boolean getAllowReassign()
        Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
        Returns:
        allowReassign

      • setAllowReassign

        public void setAllowReassign​(java.lang.Boolean allowReassign)

      • getAttachments

        @Nullable
public java.util.List<SubAttachment> getAttachments()
        A list describing the attachments
        Returns:
        attachments

      • setAttachments

        public void setAttachments​(java.util.List<SubAttachment> attachments)

      • getCcEmailAddresses

        @Nullable
public java.util.List<java.lang.String> getCcEmailAddresses()
        The email addresses that should be CCed.
        Returns:
        ccEmailAddresses

      • setCcEmailAddresses

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

      • getClientId

        @Nullable
public java.lang.String getClientId()
        The client id of the API App you want to associate with this 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()
        When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the HelloSign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
        Returns:
        customFields

      • setCustomFields

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

      • getFieldOptions

        @Nullable
public SubFieldOptions getFieldOptions()
        Get fieldOptions
        Returns:
        fieldOptions

      • setFieldOptions

        public void setFieldOptions​(SubFieldOptions fieldOptions)

      • getFormFieldGroups

        @Nullable
public java.util.List<SubFormFieldGroup> getFormFieldGroups()
        Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
        Returns:
        formFieldGroups

      • setFormFieldGroups

        public void setFormFieldGroups​(java.util.List<SubFormFieldGroup> formFieldGroups)

      • getFormFieldRules

        @Nullable
public java.util.List<SubFormFieldRule> getFormFieldRules()
        Conditional Logic rules for fields defined in `form_fields_per_document`.
        Returns:
        formFieldRules

      • setFormFieldRules

        public void setFormFieldRules​(java.util.List<SubFormFieldRule> formFieldRules)

      • getFormFieldsPerDocument

        @Nullable
public java.util.List<SubFormFieldsPerDocumentBase> getFormFieldsPerDocument()
        The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/placing-fields/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.) **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
        Returns:
        formFieldsPerDocument

      • getHideTextTags

        @Nullable
public java.lang.Boolean getHideTextTags()
        Enables automatic Text Tag removal when set to true. **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
        Returns:
        hideTextTags

      • setHideTextTags

        public void setHideTextTags​(java.lang.Boolean hideTextTags)

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

      • getUseTextTags

        @Nullable
public java.lang.Boolean getUseTextTags()
        Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
        Returns:
        useTextTags

      • setUseTextTags

        public void setUseTextTags​(java.lang.Boolean useTextTags)

      • equals

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