Package com.hellosign.openapi.model

Class TemplateCreateEmbeddedDraftRequest

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

    • Field Detail

      • JSON_PROPERTY_CLIENT_ID

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

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

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

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

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

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

    • Constructor Detail

      • TemplateCreateEmbeddedDraftRequest

        public TemplateCreateEmbeddedDraftRequest()

    • Method Detail

      • getClientId

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

      • setClientId

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

      • 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 creating a template.
        Returns:
        allowCcs

      • setAllowCcs

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

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

      • getCcRoles

        @Nullable
public java.util.List<java.lang.String> getCcRoles()
        The CC roles that must be assigned when using the template to send a signature request
        Returns:
        ccRoles

      • setCcRoles

        public void setCcRoles​(java.util.List<java.lang.String> ccRoles)

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

      • getForceSignerRoles

        @Nullable
public java.lang.Boolean getForceSignerRoles()
        Provide users the ability to review/edit the template signer roles.
        Returns:
        forceSignerRoles

      • setForceSignerRoles

        public void setForceSignerRoles​(java.lang.Boolean forceSignerRoles)

      • getForceSubjectMessage

        @Nullable
public java.lang.Boolean getForceSubjectMessage()
        Provide users the ability to review/edit the template 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

      • getMergeFields

        @Nullable
public java.util.List<SubMergeField> getMergeFields()
        Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
        Returns:
        mergeFields

      • setMergeFields

        public void setMergeFields​(java.util.List<SubMergeField> mergeFields)

      • getMessage

        @Nullable
public java.lang.String getMessage()
        The default template email message.
        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)

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

      • getSignerRoles

        @Nullable
public java.util.List<SubTemplateRole> getSignerRoles()
        An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
        Returns:
        signerRoles

      • setSignerRoles

        public void setSignerRoles​(java.util.List<SubTemplateRole> signerRoles)

      • 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 template title (alias).
        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)

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

      • getUsePreexistingFields

        @Nullable
public java.lang.Boolean getUsePreexistingFields()
        Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).
        Returns:
        usePreexistingFields

      • setUsePreexistingFields

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

      • equals

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