Package com.hellosign.openapi.model

Class SubCustomField

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SubCustomField
extends java.lang.Object
    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.

    • Field Detail

      • JSON_PROPERTY_NAME

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

      • JSON_PROPERTY_EDITOR

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

      • JSON_PROPERTY_REQUIRED

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

      • JSON_PROPERTY_VALUE

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

    • Constructor Detail

      • SubCustomField

        public SubCustomField()

    • Method Detail

      • getName

        @Nonnull
public java.lang.String getName()
        The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)

      • getEditor

        @Nullable
public java.lang.String getEditor()
        Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
        Returns:
        editor

      • setEditor

        public void setEditor​(java.lang.String editor)

      • required

        public SubCustomField required​(java.lang.Boolean required)

      • getRequired

        @Nullable
public java.lang.Boolean getRequired()
        Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
        Returns:
        required

      • setRequired

        public void setRequired​(java.lang.Boolean required)

      • getValue

        @Nullable
public java.lang.String getValue()
        The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing.
        Returns:
        value

      • setValue

        public void setValue​(java.lang.String value)

      • equals

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