Package com.hellosign.openapi.model

Class SignatureRequestResponseCustomFieldBase

  • Direct Known Subclasses:
    SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText
    @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class SignatureRequestResponseCustomFieldBase
extends java.lang.Object
    An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`

    • Field Detail

      • JSON_PROPERTY_TYPE

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

      • JSON_PROPERTY_NAME

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

      • JSON_PROPERTY_REQUIRED

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

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

    • Constructor Detail

      • SignatureRequestResponseCustomFieldBase

        public SignatureRequestResponseCustomFieldBase()

    • Method Detail

      • getType

        @Nonnull
public java.lang.String getType()
        The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
        Returns:
        type

      • setType

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

      • getName

        @Nonnull
public java.lang.String getName()
        The name of the Custom Field.
        Returns:
        name

      • setName

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

      • getRequired

        @Nullable
public java.lang.Boolean getRequired()
        A boolean value denoting if this field is required.
        Returns:
        required

      • setRequired

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

      • getApiId

        @Nullable
public java.lang.String getApiId()
        The unique ID for this field.
        Returns:
        apiId

      • setApiId

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

      • getEditor

        @Nullable
public java.lang.String getEditor()
        The name of the Role that is able to edit this field.
        Returns:
        editor

      • setEditor

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

      • equals

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