Add recommId parameter to add interaction requests

Author: OndraFiedler

README.md

@@ -13,7 +13,7 @@ The client is available in the [Maven Central Repository](https://mvnrepository.
     <dependency>
         <groupId>com.recombee</groupId>
         <artifactId>api-client</artifactId>
-        <version>2.1.1</version>
+        <version>2.2.0</version>
     </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.recombee</groupId>
     <artifactId>api-client</artifactId>
-    <version>2.1.1</version>
+    <version>2.2.0</version>
     <name>Recombee API Client</name>
     <description>A client library for easy use of the Recombee recommendation API</description>
     <url>http://recombee.com</url>

src/main/java/com/recombee/api_client/RecombeeClient.java

@@ -85,7 +85,7 @@ public class RecombeeClient {
 
     final int BATCH_MAX_SIZE = 10000; //Maximal number of requests within one batch request
 
-    final String USER_AGENT = "recombee-java-api-client/2.1.1";
+    final String USER_AGENT = "recombee-java-api-client/2.2.0";
 
     private final OkHttpClient httpClient = new OkHttpClient();
 

src/main/java/com/recombee/api_client/api_requests/AddBookmark.java

@@ -31,6 +31,10 @@ public class AddBookmark extends Request {
      * Sets whether the given user/item should be created if not present in the database.
      */
     protected Boolean cascadeCreate;
+    /**
+     * If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     /**
      * Construct the request
@@ -59,6 +63,14 @@ public AddBookmark setCascadeCreate(boolean cascadeCreate) {
          return this;
     }
 
+    /**
+     * @param recommId If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    public AddBookmark setRecommId(String recommId) {
+         this.recommId = recommId;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -76,6 +88,10 @@ public boolean getCascadeCreate() {
          return this.cascadeCreate;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -117,6 +133,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }
+        if (this.recommId!=null) {
+            params.put("recommId", this.recommId);
+        }
         return params;
     }
 

src/main/java/com/recombee/api_client/api_requests/AddCartAddition.java

@@ -39,6 +39,10 @@ public class AddCartAddition extends Request {
      * Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
      */
     protected Double price;
+    /**
+     * If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     /**
      * Construct the request
@@ -83,6 +87,14 @@ public AddCartAddition setPrice(double price) {
          return this;
     }
 
+    /**
+     * @param recommId If this cart addition is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    public AddCartAddition setRecommId(String recommId) {
+         this.recommId = recommId;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -108,6 +120,10 @@ public double getPrice() {
          return this.price;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -155,6 +171,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.price!=null) {
             params.put("price", this.price);
         }
+        if (this.recommId!=null) {
+            params.put("recommId", this.recommId);
+        }
         return params;
     }
 

src/main/java/com/recombee/api_client/api_requests/AddDetailView.java

@@ -35,6 +35,10 @@ public class AddDetailView extends Request {
      * Sets whether the given user/item should be created if not present in the database.
      */
     protected Boolean cascadeCreate;
+    /**
+     * If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     /**
      * Construct the request
@@ -71,6 +75,14 @@ public AddDetailView setCascadeCreate(boolean cascadeCreate) {
          return this;
     }
 
+    /**
+     * @param recommId If this detail view is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    public AddDetailView setRecommId(String recommId) {
+         this.recommId = recommId;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -92,6 +104,10 @@ public boolean getCascadeCreate() {
          return this.cascadeCreate;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -136,6 +152,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }
+        if (this.recommId!=null) {
+            params.put("recommId", this.recommId);
+        }
         return params;
     }
 

src/main/java/com/recombee/api_client/api_requests/AddPurchase.java

@@ -43,6 +43,10 @@ public class AddPurchase extends Request {
      * Your profit from the purchased item. The profit is natural in e-commerce domain (for example if `user-x` purchases `item-y` for $100 and the gross margin is 30 %, then the profit is $30), but is applicable also in other domains (for example at a news company it may be income from displayed advertisement on article page). If `amount` is greater than 1, sum of profit of all the items should be given.
      */
     protected Double profit;
+    /**
+     * If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     /**
      * Construct the request
@@ -95,6 +99,14 @@ public AddPurchase setProfit(double profit) {
          return this;
     }
 
+    /**
+     * @param recommId If this purchase is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    public AddPurchase setRecommId(String recommId) {
+         this.recommId = recommId;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -124,6 +136,10 @@ public double getProfit() {
          return this.profit;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -174,6 +190,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.profit!=null) {
             params.put("profit", this.profit);
         }
+        if (this.recommId!=null) {
+            params.put("recommId", this.recommId);
+        }
         return params;
     }
 

src/main/java/com/recombee/api_client/api_requests/AddRating.java

@@ -35,6 +35,10 @@ public class AddRating extends Request {
      * Sets whether the given user/item should be created if not present in the database.
      */
     protected Boolean cascadeCreate;
+    /**
+     * If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     /**
      * Construct the request
@@ -65,6 +69,14 @@ public AddRating setCascadeCreate(boolean cascadeCreate) {
          return this;
     }
 
+    /**
+     * @param recommId If this rating is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    public AddRating setRecommId(String recommId) {
+         this.recommId = recommId;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -86,6 +98,10 @@ public boolean getCascadeCreate() {
          return this.cascadeCreate;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -128,6 +144,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }
+        if (this.recommId!=null) {
+            params.put("recommId", this.recommId);
+        }
         return params;
     }
 

src/main/java/com/recombee/api_client/api_requests/SetViewPortion.java

@@ -40,6 +40,10 @@ public class SetViewPortion extends Request {
      * Sets whether the given user/item should be created if not present in the database.
      */
     protected Boolean cascadeCreate;
+    /**
+     * If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     /**
      * Construct the request
@@ -78,6 +82,14 @@ public SetViewPortion setCascadeCreate(boolean cascadeCreate) {
          return this;
     }
 
+    /**
+     * @param recommId If this view portion is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    public SetViewPortion setRecommId(String recommId) {
+         this.recommId = recommId;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -103,6 +115,10 @@ public boolean getCascadeCreate() {
          return this.cascadeCreate;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -148,6 +164,9 @@ public Map<String, Object> getBodyParameters() {
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }
+        if (this.recommId!=null) {
+            params.put("recommId", this.recommId);
+        }
         return params;
     }
 

src/main/java/com/recombee/api_client/bindings/Bookmark.java

@@ -22,18 +22,24 @@ public class Bookmark extends RecombeeBinding {
      * UTC timestamp of the bookmark as ISO8601-1 pattern or UTC epoch time. The default value is the current time.
      */
     protected Date timestamp;
+    /**
+     * If this bookmark is based on a recommendation request, `recommId` is the id of the clicked recommendation.
+     */
+    protected String recommId;
 
     public Bookmark () {}
 
-    public Bookmark (String userId,String itemId,Date timestamp) {
+    public Bookmark (String userId,String itemId,Date timestamp,String recommId) {
         this.userId = userId;
         this.itemId = itemId;
         this.timestamp = timestamp;
+        this.recommId = recommId;
     }
 
     public Bookmark (Map<String, Object> jsonObject) {
         this.userId = (String) jsonObject.get("userId");
         this.itemId = (String) jsonObject.get("itemId");
+        this.recommId = (String) jsonObject.get("recommId");
         Double epoch = 1000*(Double)jsonObject.get("timestamp");
         this.timestamp = new Date(epoch.longValue());
     }
@@ -55,12 +61,17 @@ public Date getTimestamp() {
          return this.timestamp;
     }
 
+    public String getRecommId() {
+         return this.recommId;
+    }
+
     @Override
     public int hashCode() {
     return new HashCodeBuilder(17, 31).
         append(this.userId).
         append(this.itemId).
         append(this.timestamp).
+        append(this.recommId).
         toHashCode();
     }
 
@@ -76,6 +87,7 @@ public boolean equals(Object obj) {
             append(this.userId, rhs.userId).
             append(this.itemId, rhs.itemId).
             append(this.timestamp, rhs.timestamp).
+            append(this.recommId, rhs.recommId).
             isEquals();
     }
 }