Package com.hellosign.openapi.model

Class UnclaimedDraftCreateEmbeddedRequest

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

    • Field Detail

      • JSON_PROPERTY_CLIENT_ID

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

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

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

      • JSON_PROPERTY_EDITOR_OPTIONS

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

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

      • JSON_PROPERTY_FORCE_SUBJECT_MESSAGE

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

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

      • JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING

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

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

      • JSON_PROPERTY_SHOW_PREVIEW

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

      • JSON_PROPERTY_SHOW_PROGRESS_STEPPER

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

      • JSON_PROPERTY_SIGNERS

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

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

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

      • JSON_PROPERTY_USE_PREEXISTING_FIELDS

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

      • JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS

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

    • Constructor Detail

      • UnclaimedDraftCreateEmbeddedRequest

        public UnclaimedDraftCreateEmbeddedRequest()

    • Method Detail

      • getClientId

        @Nonnull
public java.lang.String getClientId()
        Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
        Returns:
        clientId

      • setClientId

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

      • getRequesterEmailAddress

        @Nonnull
public java.lang.String getRequesterEmailAddress()
        The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
        Returns:
        requesterEmailAddress

      • setRequesterEmailAddress

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

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

      • getAllowCcs

        @Nullable
public java.lang.Boolean getAllowCcs()
        This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
        Returns:
        allowCcs

      • setAllowCcs

        public void setAllowCcs​(java.lang.Boolean allowCcs)

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

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

      • getEditorOptions

        @Nullable
public SubEditorOptions getEditorOptions()
        Get editorOptions
        Returns:
        editorOptions

      • setEditorOptions

        public void setEditorOptions​(SubEditorOptions editorOptions)

      • getFieldOptions

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

      • setFieldOptions

        public void setFieldOptions​(SubFieldOptions fieldOptions)

      • getForceSignerPage

        @Nullable
public java.lang.Boolean getForceSignerPage()
        Provide users the ability to review/edit the signers.
        Returns:
        forceSignerPage

      • setForceSignerPage

        public void setForceSignerPage​(java.lang.Boolean forceSignerPage)

      • getForceSubjectMessage

        @Nullable
public java.lang.Boolean getForceSubjectMessage()
        Provide users the ability to review/edit the subject and message.
        Returns:
        forceSubjectMessage

      • setForceSubjectMessage

        public void setForceSubjectMessage​(java.lang.Boolean forceSubjectMessage)

      • 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()
        Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
        Returns:
        hideTextTags

      • setHideTextTags

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

      • getHoldRequest

        @Nullable
public java.lang.Boolean getHoldRequest()
        The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
        Returns:
        holdRequest

      • setHoldRequest

        public void setHoldRequest​(java.lang.Boolean holdRequest)

      • getIsForEmbeddedSigning

        @Nullable
public java.lang.Boolean getIsForEmbeddedSigning()
        The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
        Returns:
        isForEmbeddedSigning

      • setIsForEmbeddedSigning

        public void setIsForEmbeddedSigning​(java.lang.Boolean isForEmbeddedSigning)

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

      • getRequestingRedirectUrl

        @Nullable
public java.lang.String getRequestingRedirectUrl()
        The URL you want signers redirected to after they successfully request a signature.
        Returns:
        requestingRedirectUrl

      • setRequestingRedirectUrl

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

      • getShowPreview

        @Nullable
public java.lang.Boolean getShowPreview()
        This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.
        Returns:
        showPreview

      • setShowPreview

        public void setShowPreview​(java.lang.Boolean showPreview)

      • getShowProgressStepper

        @Nullable
public java.lang.Boolean getShowProgressStepper()
        When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
        Returns:
        showProgressStepper

      • setShowProgressStepper

        public void setShowProgressStepper​(java.lang.Boolean showProgressStepper)

      • getSigners

        @Nullable
public java.util.List<SubUnclaimedDraftSigner> getSigners()
        Add Signers to your Unclaimed Draft Signature Request.
        Returns:
        signers

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

      • getSkipMeNow

        @Nullable
public java.lang.Boolean getSkipMeNow()
        Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
        Returns:
        skipMeNow

      • setSkipMeNow

        public void setSkipMeNow​(java.lang.Boolean skipMeNow)

      • 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 created from this draft will not be legally binding if set to `true`. Defaults to `false`.
        Returns:
        testMode

      • setTestMode

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

      • getType

        @Nullable
public UnclaimedDraftCreateEmbeddedRequest.TypeEnum getType()
        The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.
        Returns:
        type

      • getUsePreexistingFields

        @Nullable
public java.lang.Boolean getUsePreexistingFields()
        Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
        Returns:
        usePreexistingFields

      • setUsePreexistingFields

        public void setUsePreexistingFields​(java.lang.Boolean usePreexistingFields)

      • getUseTextTags

        @Nullable
public java.lang.Boolean getUseTextTags()
        Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
        Returns:
        useTextTags

      • setUseTextTags

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

      • getPopulateAutoFillFields

        @Nullable
public java.lang.Boolean getPopulateAutoFillFields()
        Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
        Returns:
        populateAutoFillFields

      • setPopulateAutoFillFields

        public void setPopulateAutoFillFields​(java.lang.Boolean populateAutoFillFields)

      • equals

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