Package com.hellosign.openapi.model

Class SubFormFieldsPerDocumentBase

  • Direct Known Subclasses:
    SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge
    @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SubFormFieldsPerDocumentBase
extends java.lang.Object
    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`

    • Field Detail

      • JSON_PROPERTY_DOCUMENT_INDEX

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

      • JSON_PROPERTY_API_ID

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

      • JSON_PROPERTY_HEIGHT

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

      • JSON_PROPERTY_REQUIRED

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

      • JSON_PROPERTY_SIGNER

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

      • JSON_PROPERTY_TYPE

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

      • JSON_PROPERTY_WIDTH

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

      • JSON_PROPERTY_NAME

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

      • JSON_PROPERTY_PAGE

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

    • Constructor Detail

      • SubFormFieldsPerDocumentBase

        public SubFormFieldsPerDocumentBase()

    • Method Detail

      • getDocumentIndex

        @Nonnull
public java.lang.Integer getDocumentIndex()
        Represents the integer index of the `file` or `file_url` document the field should be attached to.
        Returns:
        documentIndex

      • setDocumentIndex

        public void setDocumentIndex​(java.lang.Integer documentIndex)

      • getApiId

        @Nonnull
public java.lang.String getApiId()
        An identifier for the field that is unique across all documents in the request.
        Returns:
        apiId

      • setApiId

        public void setApiId​(java.lang.String apiId)

      • getHeight

        @Nonnull
public java.lang.Integer getHeight()
        Size of the field in pixels.
        Returns:
        height

      • setHeight

        public void setHeight​(java.lang.Integer height)

      • getRequired

        @Nonnull
public java.lang.Boolean getRequired()
        Whether this field is required.
        Returns:
        required

      • setRequired

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

      • getSigner

        @Nonnull
public java.lang.String getSigner()
        Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
        Returns:
        signer

      • setSigner

        public void setSigner​(java.lang.String signer)

      • getType

        @Nonnull
public java.lang.String getType()
        Get type
        Returns:
        type

      • setType

        public void setType​(java.lang.String type)

      • getWidth

        @Nonnull
public java.lang.Integer getWidth()
        Size of the field in pixels.
        Returns:
        width

      • setWidth

        public void setWidth​(java.lang.Integer width)

      • getX

        @Nonnull
public java.lang.Integer getX()
        Location coordinates of the field in pixels.
        Returns:
        x

      • setX

        public void setX​(java.lang.Integer x)

      • getY

        @Nonnull
public java.lang.Integer getY()
        Location coordinates of the field in pixels.
        Returns:
        y

      • setY

        public void setY​(java.lang.Integer y)

      • getName

        @Nullable
public java.lang.String getName()
        Display name for the field.
        Returns:
        name

      • setName

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

      • getPage

        @Nullable
public java.lang.Integer getPage()
        Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
        Returns:
        page

      • setPage

        public void setPage​(java.lang.Integer page)

      • equals

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