Add support for editable merge fields. Closes #8

Author: Chris Paul

src/main/java/com/hellosign/sdk/resource/TemplateSignatureRequest.java

@@ -25,11 +25,15 @@
  */
 
 import java.io.Serializable;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+import org.json.JSONArray;
+
 import com.hellosign.sdk.HelloSignException;
+import com.hellosign.sdk.resource.support.CustomField;
 import com.hellosign.sdk.resource.support.Signer;
 
 /**
@@ -57,7 +61,7 @@ public class TemplateSignatureRequest extends AbstractRequest {
     // fields are stored, so we can support this association. 
     private Map<String, Signer> signers = new HashMap<String, Signer>();    
     private Map<String, String> ccs = new HashMap<String, String>();
-    private Map<String, String> customFields = new HashMap<String, String>();
+    private List<CustomField> customFields = new ArrayList<CustomField>();
 
     public TemplateSignatureRequest() {
         super();
@@ -169,13 +173,25 @@ public void removeSignerByEmail(String email) throws HelloSignException {
         }
     }
 
+    /**
+     * Add the custom field to this request. This is useful for specifying
+     * a pre-filled value and/or a field editor.
+     * @param field CustomField
+     */
+    public void addCustomField(CustomField field) {
+        customFields.add(field);
+    }
+
     /**
      * Adds the value to fill in for a custom field with the given field name. 
      * @param fieldName String field name to be filled in
      * @param value String value
      */
     public void setCustomFieldValue(String fieldName, String value) {
-        customFields.put(fieldName, value);
+        CustomField f = new CustomField();
+        f.setName(fieldName);
+        f.setValue(value);
+        customFields.add(f);
     }
 
     /**
@@ -184,6 +200,18 @@ public void setCustomFieldValue(String fieldName, String value) {
      * @return Map
      */
     public Map<String, String> getCustomFields() {
+        Map<String, String> fields = new HashMap<String, String>();
+        for (CustomField f : customFields) {
+            fields.put(f.getName(), f.getValue());
+        }
+        return fields;
+    }
+
+    /**
+     * Returns a list of CustomField objects for this template.
+     * @return List of CustomFields
+     */
+    public List<CustomField> getCustomFieldsList() {
         return customFields;
     }
 
@@ -193,14 +221,20 @@ public Map<String, String> getCustomFields() {
      * @param fields Map
      */
     public void setCustomFields(Map<String, String> fields) {
-        customFields = fields;
+        clearCustomFields();
+        for (String key : fields.keySet()) {
+            CustomField f = new CustomField();
+            f.setName(key);
+            f.setValue(fields.get(key));
+            customFields.add(f);
+        }
     }
 
     /**
      * Clears the current custom fields for this request.
      */
     public void clearCustomFields() {
-        customFields = new HashMap<String, String>();
+        customFields = new ArrayList<CustomField>();
     }
 
     /**
@@ -320,11 +354,12 @@ public Map<String, Serializable> getPostFields() throws HelloSignException {
                         + "[" + role + "][" + TEMPLATE_CCS_EMAIL + "]", 
                         ccz.get(role));
             }
-            Map<String, String> customFields = getCustomFields();
-            for (String fieldName : customFields.keySet()) {
-                fields.put(TEMPLATE_CUSTOM_FIELDS 
-                        + "[" + fieldName + "]", 
-                        customFields.get(fieldName));
+            if (customFields.size() > 0) {
+                JSONArray array = new JSONArray();
+                for (CustomField f : customFields) {
+                    array.put(f.getJSONObject());
+                }
+                fields.put(TEMPLATE_CUSTOM_FIELDS, array.toString());
             }
             if (isTestMode()) {
                 fields.put(REQUEST_TEST_MODE, true);

src/main/java/com/hellosign/sdk/resource/support/CustomField.java

@@ -1,5 +1,7 @@
 package com.hellosign.sdk.resource.support;
 
+import org.json.JSONException;
+
 /**
  * The MIT License (MIT)
  * 
@@ -41,9 +43,12 @@
  */
 public class CustomField extends AbstractResource {
 
-    public static final String CUSTOM_FIELD_NAME = "name";
-    public static final String CUSTOM_FIELD_TYPE = "type";
-    public static final String CUSTOM_FIELD_API_ID = "api_id";
+    public static final String CUSTOM_FIELD_NAME     = "name";
+    public static final String CUSTOM_FIELD_TYPE     = "type";
+    public static final String CUSTOM_FIELD_API_ID   = "api_id";
+    public static final String CUSTOM_FIELD_VALUE    = "value";
+    public static final String CUSTOM_FIELD_EDITOR   = "editor";
+    public static final String CUSTOM_FIELD_REQUIRED = "required";
 
     public CustomField() {
         super();
@@ -56,6 +61,13 @@ public CustomField(JSONObject json) throws HelloSignException {
     public String getName() {
         return getString(CUSTOM_FIELD_NAME);
     }
+    /**
+     * Set the name of this custom field.
+     * @param name String
+     */
+    public void setName(String name) {
+        set(CUSTOM_FIELD_NAME, name);
+    }
     public FieldType getType() {
         return FieldType.valueOf(getString(CUSTOM_FIELD_TYPE));
     }
@@ -65,7 +77,51 @@ public String getTypeString() {
         }
         return null;
     }
+    /**
+     * Set the type for this custom field.
+     * @param type FieldType
+     */
+    public void setType(FieldType type) {
+        set(CUSTOM_FIELD_TYPE, type.toString());
+    }
+    public String getValue() {
+        return getString(CUSTOM_FIELD_VALUE);
+    }
+    /**
+     * Set the value for this field.
+     * @param value String
+     */
+    public void setValue(String value) {
+        set(CUSTOM_FIELD_VALUE, value);
+    }
     public String getApiId() {
         return getString(CUSTOM_FIELD_API_ID);
     }
-}
+    /**
+     * Set the API ID for this custom field.
+     * @param apiId String
+     */
+    public void setApiId(String apiId) {
+        set(CUSTOM_FIELD_API_ID, apiId);
+    }
+    public String getEditor() {
+        return getString(CUSTOM_FIELD_EDITOR);
+    }
+    /**
+     * Specify what signer role may edit this field.
+     * @param editor String
+     */
+    public void setEditor(String editor) {
+        set(CUSTOM_FIELD_EDITOR, editor);
+    }
+    public Boolean isRequired() {
+        return getBoolean(CUSTOM_FIELD_REQUIRED);
+    }
+    /**
+     * Specify whether this field is required.
+     * @param isRequired Boolean
+     */
+    public void setIsRequired(Boolean isRequired) {
+        set(CUSTOM_FIELD_REQUIRED, isRequired);
+    }
+}