Package com.hellosign.openapi.model

Class SignatureRequestBulkCreateEmbeddedWithTemplateRequest

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SignatureRequestBulkCreateEmbeddedWithTemplateRequest
extends java.lang.Object
    Calls SignatureRequestBulkSendWithTemplate in controller

    • Field Detail

      • JSON_PROPERTY_TEMPLATE_IDS

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

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

      • JSON_PROPERTY_SIGNER_LIST

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

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

      • SignatureRequestBulkCreateEmbeddedWithTemplateRequest

        public SignatureRequestBulkCreateEmbeddedWithTemplateRequest()

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

      • getClientId

        @Nonnull
public java.lang.String getClientId()
        Client id of the app you're using to create this embedded signature request. Used for security purposes.
        Returns:
        clientId

      • setClientId

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

      • getSignerFile

        @Nullable
public java.io.File getSignerFile()
        `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
        Returns:
        signerFile

      • setSignerFile

        public void setSignerFile​(java.io.File signerFile)

      • getSignerList

        @Nullable
public java.util.List<SubBulkSignerList> getSignerList()
        `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.
        Returns:
        signerList

      • setSignerList

        public void setSignerList​(java.util.List<SubBulkSignerList> signerList)

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

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

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

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