Add ux_version parameter to requests. Add template/files support.

Author: Chris Paul

pom.xml

@@ -6,7 +6,7 @@
   <groupId>com.hellosign</groupId>
   <artifactId>hellosign-java-sdk</artifactId>
   <packaging>jar</packaging>
-  <version>3.2.3</version>
+  <version>3.3.0</version>
   <name>HelloSign Java SDK</name>
   <url>https://github.com/HelloFax/hellosign-java-sdk</url>
   <properties>

src/main/java/com/hellosign/sdk/HelloSignClient.java

@@ -114,6 +114,7 @@ public class HelloSignClient {
     private String URL_SIGNATURE_REQUEST_LIST;
     private String URL_SIGNATURE_REQUEST_SEND;
     private String URL_TEMPLATE;
+    private String URL_TEMPLATE_FILE;
     private String URL_TEMPLATE_LIST;
     private String URL_TEMPLATE_ADD_USER;
     private String URL_TEMPLATE_REMOVE_USER;
@@ -142,6 +143,9 @@ public class HelloSignClient {
     public static final String FILES_FILE_NAME = "files";
     public static final String FILES_FILE_EXT = "pdf";
 
+    public static final String TEMPLATE_FILE_NAME = "template";
+    public static final String TEMPLATE_FILE_EXT = "pdf";
+
     public static final String OAUTH_CODE = "code";
     public static final String OAUTH_STATE = "state";
     public static final String OAUTH_GRANT_TYPE = "grant_type";
@@ -186,6 +190,7 @@ private void initApiEndpoints() {
         URL_SIGNATURE_REQUEST_LIST = URL_SIGNATURE_REQUEST + "/list";
         URL_SIGNATURE_REQUEST_SEND = URL_SIGNATURE_REQUEST + "/send";
         URL_TEMPLATE = URL_API + "/template";
+        URL_TEMPLATE_FILE = URL_TEMPLATE + "/files";
         URL_TEMPLATE_LIST = URL_TEMPLATE + "/list";
         URL_TEMPLATE_ADD_USER = URL_TEMPLATE + "/add_user";
         URL_TEMPLATE_REMOVE_USER = URL_TEMPLATE + "/remove_user";
@@ -613,6 +618,20 @@ public TemplateList getTemplates(int page) throws HelloSignException {
         return new TemplateList(request.getJsonResponse());
     }
 
+
+    /**
+     * Retrieves the PDF file backing the Template specified by
+     * the provided Template ID.
+     * @param templateId String Template ID
+     * @return File PDF file object
+     * @throws HelloSignException
+     */
+    public File getTemplateFile(String templateId) throws HelloSignException {
+        String url = URL_TEMPLATE_FILE + "/" + templateId;
+        HttpGetRequest request = new HttpGetRequest(url, auth);
+        return request.getFileResponse(TEMPLATE_FILE_NAME + "." + TEMPLATE_FILE_EXT);
+    }
+
     /**
      * Retrieves a specific Template based on the provided Template ID.
      * @param templateId String Template ID

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

@@ -56,11 +56,19 @@ public abstract class AbstractRequest extends AbstractResource {
     public static final String REQUEST_USE_PREEXISTING_FIELDS = "use_preexisting_fields";
     public static final String REQUEST_HIDE_TEXT_TAGS = "hide_text_tags";
     public static final String REQUEST_METADATA = "metadata";
+    public static final String REQUEST_UX_VERSION = "ux_version";
+
+    // UX Version 1 = Original, non-responsive signer page is used
+    public static final int UX_VERSION_1 = 1;
+
+    // UX Version 2 = Responsive signer page is displayed to signer(s)
+    public static final int UX_VERSION_2 = 2;
 
     private Metadata metadata;
     private List<Document> documents = new ArrayList<Document>();
     private List<String> fileUrls = new ArrayList<String>();
     private boolean orderMatters = false;
+    private int uxVersion = UX_VERSION_1;
 
     public AbstractRequest() {
         super();
@@ -89,6 +97,10 @@ protected Map<String, Serializable> getPostFields() throws HelloSignException {
         } catch (Exception ex) {
             throw new HelloSignException("Could not extract metadata fields.", ex);
         }
+        // For now, only send the UX version if it's the non-default (2)
+        if (this.getUxVersion() == UX_VERSION_2) {
+            fields.put(REQUEST_UX_VERSION, UX_VERSION_2);
+        }
         return fields;
     }
 
@@ -313,4 +325,23 @@ public List<String> getFileUrls() {
     public void setFileUrls(List<String> fileUrls) {
         this.fileUrls = fileUrls;
     }
+
+    /**
+     * Set the UX version for this request. This determines the version
+     * of the signer page displayed to signer(s). The default is
+     * UX_VERSION_1 (non-responsive). Use UX_VERSION_2 for the responsive
+     * signer page.
+     * @param uxVersion int
+     */
+    public void setUxVersion(int uxVersion) {
+        this.uxVersion = uxVersion;
+    }
+
+    /**
+     * Return the UX version for this request.
+     * @return int UX version (UX_VERSION_1 or UX_VERSION_2)
+     */
+    public int getUxVersion() {
+        return this.uxVersion;
+    }
 }