Support fmt_options and hidden_fields for Recommendations

constructorio-client/src/main/java/io/constructor/client/ConstructorIO.java

@@ -1818,6 +1818,22 @@ public String recommendationsAsJSON(RecommendationsRequest req, UserInfo userInf
                                 .build();
             }
 
+            for (String formatOptionKey : req.getFormatOptions().keySet()) {
+                String formatOptionValue = req.getFormatOptions().get(formatOptionKey);
+                url =
+                        url.newBuilder()
+                                .addQueryParameter(
+                                        "fmt_options[" + formatOptionKey + "]", formatOptionValue)
+                                .build();
+            }
+
+            for (String hiddenField : req.getHiddenFields()) {
+                url =
+                        url.newBuilder()
+                                .addQueryParameter("fmt_options[hidden_fields]", hiddenField)
+                                .build();
+            }
+
             Request request = this.makeUserRequestBuilder(userInfo).url(url).get().build();
 
             Response response = clientWithRetry.newCall(request).execute();

constructorio-client/src/main/java/io/constructor/client/RecommendationsRequest.java

@@ -1,5 +1,6 @@
 package io.constructor.client;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -15,6 +16,8 @@ public class RecommendationsRequest {
     private String section;
     private String preFilterExpression;
     private VariationsMap variationsMap;
+    private Map<String, String> formatOptions;
+    private List<String> hiddenFields;
 
     /**
      * Creates a recommendations request
@@ -34,6 +37,8 @@ public RecommendationsRequest(String podId) throws IllegalArgumentException {
         this.variationsMap = null;
         this.preFilterExpression = null;
         this.facets = new HashMap<String, List<String>>();
+        this.formatOptions = new HashMap<String, String>();
+        this.hiddenFields = new ArrayList<String>();
     }
 
     /**
@@ -149,4 +154,33 @@ public void setPreFilterExpression(String preFilterExpression) {
     public String getPreFilterExpression() {
         return preFilterExpression;
     }
+
+    /**
+     * @param formatOptions the formatOptions to set. Please refer to
+     *     https://docs.constructor.com/reference/v1-recommendations-get-pod-results for details
+     */
+    public void setFormatOptions(Map<String, String> formatOptions) {
+        this.formatOptions = formatOptions;
+    }
+
+    /**
+     * @return the format options
+     */
+    public Map<String, String> getFormatOptions() {
+        return formatOptions;
+    }
+
+    /**
+     * @param hiddenFields the hiddenFields to set
+     */
+    public void setHiddenFields(List<String> hiddenFields) {
+        this.hiddenFields = hiddenFields;
+    }
+
+    /**
+     * @return the hidden fields
+     */
+    public List<String> getHiddenFields() {
+        return hiddenFields;
+    }
 }

constructorio-client/src/test/java/io/constructor/client/ConstructorIORecommendationsTest.java

@@ -7,6 +7,7 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
@@ -139,4 +140,25 @@ public void getRecommendationsShouldReturnAResultTerm() throws Exception {
         assertEquals(response.getRequest().get("term"), "test");
         assertTrue("recommendation result id exists", response.getResultId() != null);
     }
+
+    @Test
+    public void getRecommendationsShouldReturnAResultWithFmtOptionsAndHiddenFields()
+            throws Exception {
+        ConstructorIO constructor = new ConstructorIO("", apiKey, true, null);
+        UserInfo userInfo = new UserInfo(3, "c62a-2a09-faie");
+        RecommendationsRequest request = new RecommendationsRequest("item_page_1");
+        request.setItemIds(Arrays.asList("power_drill", "drill"));
+        request.setNumResults(5);
+        request.getHiddenFields().add("testField");
+        request.getFormatOptions().put("groups_max_depth", "3");
+
+        RecommendationsResponse response = constructor.recommendations(request, userInfo);
+        Map<String, Object> fmtOptions =
+                (Map<String, Object>) response.getRequest().get("fmt_options");
+
+        assertTrue("recommendation results exist", response.getResponse().getResults().size() >= 0);
+        assertTrue("recommendation result id exists", response.getResultId() != null);
+        assertEquals(fmtOptions.get("groups_max_depth"), Double.valueOf("3.0"));
+        assertTrue(((List<String>) fmtOptions.get("hidden_fields")).contains("testField"));
+    }
 }

constructorio-client/src/test/java/io/constructor/client/RecommendationsRequestTest.java

@@ -47,18 +47,25 @@ public void settersShouldSet() throws Exception {
         RecommendationsRequest request = new RecommendationsRequest(podId);
         Map<String, List<String>> facets = new HashMap<String, List<String>>();
         facets.put("Flavors", Arrays.asList("Honey Roasted", "Dry Roasted", "Unsalted"));
+        Map<String, String> formatOptions = new HashMap<String, String>();
+        formatOptions.put("groups_start", "top");
+        List<String> hiddenFields = Arrays.asList("hiddenField1", "hiddenField2");
 
         request.setPodId("zero_results_1");
         request.setNumResults(3);
         request.setItemIds(Arrays.asList("1", "2", "3"));
         request.setSection("Search Suggestions");
         request.setFacets(facets);
         request.setTerm(term);
+        request.setFormatOptions(formatOptions);
+        request.setHiddenFields(hiddenFields);
 
         assertEquals(request.getPodId(), "zero_results_1");
         assertEquals(request.getNumResults(), 3);
         assertEquals(request.getSection(), "Search Suggestions");
         assertEquals(request.getFacets(), facets);
         assertEquals(request.getTerm(), term);
+        assertEquals(request.getFormatOptions(), formatOptions);
+        assertEquals(request.getHiddenFields(), hiddenFields);
     }
 }