Support Item Segmentations

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>4.0.0</version>
+        <version>4.1.0</version>
     </dependency>
 ```
 

pom.xml

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

@@ -72,9 +72,15 @@
 import com.recombee.api_client.api_requests.RecommendNextItems;
 import com.recombee.api_client.api_requests.RecommendUsersToUser;
 import com.recombee.api_client.api_requests.RecommendUsersToItem;
+import com.recombee.api_client.api_requests.RecommendItemSegmentsToUser;
+import com.recombee.api_client.api_requests.RecommendItemSegmentsToItem;
+import com.recombee.api_client.api_requests.RecommendItemSegmentsToItemSegment;
 import com.recombee.api_client.api_requests.SearchItems;
+import com.recombee.api_client.api_requests.SearchItemSegments;
 import com.recombee.api_client.api_requests.AddSearchSynonym;
 import com.recombee.api_client.api_requests.ListSearchSynonyms;
+import com.recombee.api_client.api_requests.ListSegmentations;
+import com.recombee.api_client.api_requests.GetSegmentation;
 
 /* End of the generated code */
 /**
@@ -91,7 +97,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/4.0.0";
+    final String USER_AGENT = "recombee-java-api-client/4.1.0";
 
     private final OkHttpClient httpClient = new OkHttpClient();
 
@@ -417,6 +423,36 @@ public RecommendationResponse send(RecommendUsersToItem request) throws ApiExcep
          return null;
     }
 
+    public RecommendationResponse send(RecommendItemSegmentsToUser 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(RecommendItemSegmentsToItem 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(RecommendItemSegmentsToItemSegment request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, RecommendationResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
     public SearchResponse send(SearchItems request) throws ApiException {
         String responseStr = sendRequest(request);
         try {
@@ -427,6 +463,16 @@ public SearchResponse send(SearchItems request) throws ApiException {
          return null;
     }
 
+    public SearchResponse send(SearchItemSegments request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, SearchResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
     public SearchSynonym send(AddSearchSynonym request) throws ApiException {
         String responseStr = sendRequest(request);
         try {
@@ -447,6 +493,26 @@ public ListSearchSynonymsResponse send(ListSearchSynonyms request) throws ApiExc
          return null;
     }
 
+    public ListSegmentationsResponse send(ListSegmentations request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, ListSegmentationsResponse.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
+    public Segmentation send(GetSegmentation request) throws ApiException {
+        String responseStr = sendRequest(request);
+        try {
+            return this.mapper.readValue(responseStr, Segmentation.class);
+        } catch (IOException e) {
+            e.printStackTrace();
+         }
+         return null;
+    }
+
     /* End of the generated code */
 
     public BatchResponse[] send(Batch batchRequest) throws ApiException {
@@ -522,7 +588,11 @@ else if ((request instanceof RecommendItemsToUser) ||
                             (request instanceof RecommendUsersToUser) ||
                             (request instanceof RecommendItemsToItem) ||
                             (request instanceof RecommendUsersToItem) ||
-                            (request instanceof RecommendNextItems))
+                            (request instanceof RecommendNextItems) ||
+                            (request instanceof RecommendItemSegmentsToUser) ||
+                            (request instanceof RecommendItemSegmentsToItem) ||
+                            (request instanceof RecommendItemSegmentsToItemSegment) ||
+                            (request instanceof SearchItemSegments))
                     {
                         parsedResponse = mapper.convertValue(parsedResponse, RecommendationResponse.class);
                     }
@@ -538,6 +608,10 @@ else if (request instanceof DeleteMoreItems)
                     {
                         parsedResponse = mapper.convertValue(parsedResponse, DeleteMoreItemsResponse.class);
                     }
+                    else if (request instanceof ListSegmentations)
+                    {
+                        parsedResponse = mapper.convertValue(parsedResponse, ListSegmentations.class);
+                    }
                     /* Start of the generated code */
                     else if (request instanceof GetItemPropertyInfo)
                     {
@@ -694,6 +768,12 @@ else if (request instanceof ListUserViewPortions)
                         for(int j=0;j<ar.length;j++) ar[j] = new ViewPortion(array.get(j));
                         parsedResponse = ar;
                     }
+
+                    else if (request instanceof GetSegmentation)
+                    {
+                        Map<String, Object> obj = (Map<String, Object>) parsedResponse;
+                        parsedResponse = new Segmentation(obj);
+                    }
                 /* End of the generated code */
                 }
 

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

@@ -12,7 +12,7 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Adds a bookmark of a given item made by a given user.
+ * Adds a bookmark of the given item made by the given user.
  */
 public class AddBookmark extends Request {
 

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

@@ -12,7 +12,7 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Adds a cart addition of a given item made by a given user.
+ * Adds a cart addition of the given item made by the given user.
  */
 public class AddCartAddition extends Request {
 
@@ -33,11 +33,11 @@ public class AddCartAddition extends Request {
      */
     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.
+     * 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 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.
+     * Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
      */
     protected Double price;
     /**
@@ -77,15 +77,15 @@ public AddCartAddition setCascadeCreate(boolean cascadeCreate) {
     }
 
     /**
-     * @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.
+     * @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 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.
+     * @param price Price of the added item. If `amount` is greater than 1, the sum of prices of all the items should be given.
      */
     public AddCartAddition setPrice(double price) {
          this.price = price;

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

@@ -12,7 +12,7 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Adds a detail view of a given item made by a given user.
+ * Adds a detail view of the given item made by the given user.
  */
 public class AddDetailView extends Request {
 

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

@@ -12,7 +12,7 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Creates new group in the database.
+ * Creates a new group in the database.
  */
 public class AddGroup extends Request {
 

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

@@ -12,8 +12,8 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Adds new item of given `itemId` to the items catalog.
- * All the item properties for the newly created items are set null.
+ * Adds new item of the given `itemId` to the items catalog.
+ * All the item properties for the newly created items are set to null.
  */
 public class AddItem extends Request {
 

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

@@ -17,7 +17,7 @@
 public class AddItemProperty extends Request {
 
     /**
-     * Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
+     * Name of the item property to be created. Currently, the following names are reserved: `id`, `itemid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
      */
     protected String propertyName;
     /**
@@ -35,7 +35,7 @@ public class AddItemProperty extends Request {
 
     /**
      * Construct the request
-     * @param propertyName Name of the item property to be created. Currently, the following names are reserved:`id`, `itemid`, case insensitively. Also, the length of the property name must not exceed 63 characters.
+     * @param propertyName Name of the item property to be created. Currently, the following names are reserved: `id`, `itemid`, case-insensitively. Also, the length of the property name must not exceed 63 characters.
      * @param type Value type of the item property to be created. One of: `int`, `double`, `string`, `boolean`, `timestamp`, `set`, `image` or `imageList`.
      * * `int`- Signed integer number.
      * * `double` - Floating point number. It uses 64-bit base-2 format (IEEE 754 standard).

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

@@ -0,0 +1,114 @@
+package com.recombee.api_client.api_requests;
+
+/*
+ This file is auto-generated, do not edit
+*/
+
+import java.util.Date;
+import java.util.Map;
+import java.util.HashMap;
+
+import com.recombee.api_client.bindings.Logic;
+import com.recombee.api_client.util.HTTPMethod;
+
+/**
+ * Adds a new Segment into a Manual ReQL Segmentation.
+ * The new Segment is defined by a [ReQL](https://docs.recombee.com/reql.html) filter that returns `true` for an item in case that this item belongs to the segment.
+ */
+public class AddManualReqlSegment extends Request {
+
+    /**
+     * ID of the Segmentation to which the new Segment should be added
+     */
+    protected String segmentationId;
+    /**
+     * ID of the newly created Segment
+     */
+    protected String segmentId;
+    /**
+     * ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
+     */
+    protected String filter;
+    /**
+     * Human-readable name of the Segment that is shown in the Recombee Admin UI.
+     */
+    protected String title;
+
+    /**
+     * Construct the request
+     * @param segmentationId ID of the Segmentation to which the new Segment should be added
+     * @param segmentId ID of the newly created Segment
+     * @param filter ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
+     */
+    public AddManualReqlSegment (String segmentationId,String segmentId,String filter) {
+        this.segmentationId = segmentationId;
+        this.segmentId = segmentId;
+        this.filter = filter;
+        this.timeout = 10000;
+    }
+
+    /**
+     * @param title Human-readable name of the Segment that is shown in the Recombee Admin UI.
+     */
+    public AddManualReqlSegment setTitle(String title) {
+         this.title = title;
+         return this;
+    }
+
+    public String getSegmentationId() {
+         return this.segmentationId;
+    }
+
+    public String getSegmentId() {
+         return this.segmentId;
+    }
+
+    public String getFilter() {
+         return this.filter;
+    }
+
+    public String getTitle() {
+         return this.title;
+    }
+
+    /**
+     * @return Used HTTP method
+     */
+    @Override
+    public HTTPMethod getHTTPMethod() {
+        return HTTPMethod.PUT;
+    }
+
+    /**
+     * @return URI to the endpoint including path parameters
+     */
+    @Override
+    public String getPath() {
+        return String.format("/segmentations/manual-reql/%s/segments/%s", this.segmentationId,this.segmentId);
+    }
+
+    /**
+     * Get query parameters
+     * @return Values of query parameters (name of parameter: value of the parameter)
+     */
+    @Override
+    public Map<String, Object> getQueryParameters() {
+        HashMap<String, Object> params = new HashMap<String, Object>();
+        return params;
+    }
+
+    /**
+     * Get body parameters
+     * @return Values of body parameters (name of parameter: value of the parameter)
+     */
+    @Override
+    public Map<String, Object> getBodyParameters() {
+        HashMap<String, Object> params = new HashMap<String, Object>();
+        params.put("filter", this.filter);
+        if (this.title!=null) {
+            params.put("title", this.title);
+        }
+        return params;
+    }
+
+}