Added parameters amount,price,profit to AddPurchase and amount,price to AddCartAddition

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>1.5.0</version>
+        <version>1.6.0</version>
     </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.recombee</groupId>
     <artifactId>api-client</artifactId>
-    <version>1.5.0</version>
+    <version>1.6.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

@@ -61,6 +61,10 @@
 import com.recombee.api_client.api_requests.ListUserBookmarks;
 import com.recombee.api_client.api_requests.ListItemViewPortions;
 import com.recombee.api_client.api_requests.ListUserViewPortions;
+import com.recombee.api_client.api_requests.RecommendItemsToUser;
+import com.recombee.api_client.api_requests.RecommendUsersToUser;
+import com.recombee.api_client.api_requests.RecommendItemsToItem;
+import com.recombee.api_client.api_requests.RecommendUsersToItem;
 import com.recombee.api_client.api_requests.UserBasedRecommendation;
 import com.recombee.api_client.api_requests.ItemBasedRecommendation;
 
@@ -79,7 +83,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/1.5.0";
+    final String USER_AGENT = "recombee-java-api-client/1.6.0";
 
     public RecombeeClient(String databaseId, String token) {
         this.databaseId = databaseId;
@@ -300,6 +304,46 @@ public ViewPortion[] send(ListUserViewPortions request) throws ApiException {
          return null;
     }
 
+    public RecommendationResponse send(RecommendItemsToUser request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, RecommendationResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
+    public RecommendationResponse send(RecommendUsersToUser request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, RecommendationResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
+    public RecommendationResponse send(RecommendItemsToItem request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, RecommendationResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
+    public RecommendationResponse send(RecommendUsersToItem request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, RecommendationResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
     /* End of the generated code */
 
     public BatchResponse[] send(Batch batchRequest) throws ApiException {
@@ -384,6 +428,13 @@ else if (request instanceof ListUsers)
                             parsedResponse = ar;
                         }
                     }
+                    else if ((request instanceof RecommendItemsToUser) ||
+                            (request instanceof RecommendUsersToUser) ||
+                            (request instanceof RecommendItemsToItem) ||
+                            (request instanceof RecommendUsersToItem))
+                    {
+                        parsedResponse = mapper.convertValue(parsedResponse, RecommendationResponse.class);
+                    }
                     /* Start of the generated code */
                     else if (request instanceof GetItemPropertyInfo)
                     {
@@ -627,14 +678,14 @@ public Map<String, Object> send(GetUserValues request) throws ApiException {
 
 
     public Recommendation[] send(UserBasedRecommendation request) throws ApiException {
-        return sendRecomm(request);
+        return sendDeprecatedRecomm(request);
     }
 
     public Recommendation[] send(ItemBasedRecommendation request) throws ApiException {
-        return sendRecomm(request);
+        return sendDeprecatedRecomm(request);
     }
 
-    protected Recommendation[] sendRecomm(Request request) throws ApiException {
+    protected Recommendation[] sendDeprecatedRecomm(Request request) throws ApiException {
         String responseStr = sendRequest(request);
 
         try {

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

@@ -31,6 +31,14 @@ public class AddCartAddition extends Request {
      * Sets whether the given user/item should be created if not present in the database.
      */
     protected Boolean cascadeCreate;
+    /**
+     * Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
+     */
+    protected Double amount;
+    /**
+     * Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
+     */
+    protected Double price;
 
     /**
      * Construct the request
@@ -59,6 +67,22 @@ public AddCartAddition setCascadeCreate(boolean cascadeCreate) {
          return this;
     }
 
+    /**
+     * @param amount Amount (number) added to cart. The default is 1. For example if `user-x` adds two `item-y` during a single order (session...), the `amount` should equal to 2.
+     */
+    public AddCartAddition setAmount(double amount) {
+         this.amount = amount;
+         return this;
+    }
+
+    /**
+     * @param price Price of the added item. If `amount` is greater than 1, sum of prices of all the items should be given.
+     */
+    public AddCartAddition setPrice(double price) {
+         this.price = price;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -76,6 +100,14 @@ public boolean getCascadeCreate() {
          return this.cascadeCreate;
     }
 
+    public double getAmount() {
+         return this.amount;
+    }
+
+    public double getPrice() {
+         return this.price;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -117,6 +149,12 @@ public Map<String, Object> getBodyParameters() {
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }
+        if (this.amount!=null) {
+            params.put("amount", this.amount);
+        }
+        if (this.price!=null) {
+            params.put("price", this.price);
+        }
         return params;
     }
 

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

@@ -32,7 +32,7 @@ public class AddItemProperty extends Request {
     public AddItemProperty (String propertyName,String type) {
         this.propertyName = propertyName;
         this.type = type;
-        this.timeout = 1000;
+        this.timeout = 100000;
     }
 
 

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

@@ -31,6 +31,18 @@ public class AddPurchase extends Request {
      * Sets whether the given user/item should be created if not present in the database.
      */
     protected Boolean cascadeCreate;
+    /**
+     * Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
+     */
+    protected Double amount;
+    /**
+     * Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
+     */
+    protected Double price;
+    /**
+     * 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;
 
     /**
      * Construct the request
@@ -59,6 +71,30 @@ public AddPurchase setCascadeCreate(boolean cascadeCreate) {
          return this;
     }
 
+    /**
+     * @param amount Amount (number) of purchased items. The default is 1. For example if `user-x` purchases two `item-y` during a single order (session...), the `amount` should equal to 2.
+     */
+    public AddPurchase setAmount(double amount) {
+         this.amount = amount;
+         return this;
+    }
+
+    /**
+     * @param price Price paid by the user for the item. If `amount` is greater than 1, sum of prices of all the items should be given.
+     */
+    public AddPurchase setPrice(double price) {
+         this.price = price;
+         return this;
+    }
+
+    /**
+     * @param profit 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.
+     */
+    public AddPurchase setProfit(double profit) {
+         this.profit = profit;
+         return this;
+    }
+
     public String getUserId() {
          return this.userId;
     }
@@ -76,6 +112,18 @@ public boolean getCascadeCreate() {
          return this.cascadeCreate;
     }
 
+    public double getAmount() {
+         return this.amount;
+    }
+
+    public double getPrice() {
+         return this.price;
+    }
+
+    public double getProfit() {
+         return this.profit;
+    }
+
     /**
      * @return Used HTTP method
      */
@@ -117,6 +165,15 @@ public Map<String, Object> getBodyParameters() {
         if (this.cascadeCreate!=null) {
             params.put("cascadeCreate", this.cascadeCreate);
         }
+        if (this.amount!=null) {
+            params.put("amount", this.amount);
+        }
+        if (this.price!=null) {
+            params.put("price", this.price);
+        }
+        if (this.profit!=null) {
+            params.put("profit", this.profit);
+        }
         return params;
     }
 

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

@@ -32,7 +32,7 @@ public class AddUserProperty extends Request {
     public AddUserProperty (String propertyName,String type) {
         this.propertyName = propertyName;
         this.type = type;
-        this.timeout = 1000;
+        this.timeout = 100000;
     }
 
 

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

@@ -75,6 +75,15 @@ public HTTPMethod getHTTPMethod() {
         return HTTPMethod.POST;
     }
 
+    /**
+     * Returns true if HTTPS must be chosen over HTTP for this request
+     * @return True if HTTPS must be chosen
+     */
+    @Override
+    public boolean getEnsureHttps() {
+        return true;
+    }
+
     /**
      * @return URI to the endpoint
      */

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

@@ -26,7 +26,7 @@ public class DeleteItemProperty extends Request {
      */
     public DeleteItemProperty (String propertyName) {
         this.propertyName = propertyName;
-        this.timeout = 1000;
+        this.timeout = 100000;
     }
 
 

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

@@ -26,7 +26,7 @@ public class DeleteUserProperty extends Request {
      */
     public DeleteUserProperty (String propertyName) {
         this.propertyName = propertyName;
-        this.timeout = 1000;
+        this.timeout = 100000;
     }