Release: v5.0.0

- Support new Recommend Items to Item Segment endpoint
- Series API improvements:
	- Add Series endpoint creates associated Item for the Series automatically (based on the cascadeCreate parameter)
	- Breaking change: Remove From Series no longer requires the time parameter
- Removed deprecated Groups endpoints

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.1.5</version>
+        <version>5.0.0</version>
     </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.recombee</groupId>
     <artifactId>api-client</artifactId>
-    <version>4.1.5</version>
+    <version>5.0.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>
@@ -45,32 +45,31 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>
-            <version>2.13.2</version>
+            <version>2.18.1</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.13.2.2</version>
+            <version>2.18.1</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
-            <version>4.13.1</version>
+            <version>4.13.2</version>
+            <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>commons-lang</groupId>
-            <artifactId>commons-lang</artifactId>
-            <version>2.6</version>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.12.0</version>
         </dependency>
         <dependency>
             <groupId>commons-codec</groupId>
             <artifactId>commons-codec</artifactId>
-            <version>1.10</version>
+            <version>1.15</version>
         </dependency>
-
     </dependencies>
 
-
     <distributionManagement>
         <snapshotRepository>
             <id>ossrh</id>
@@ -83,7 +82,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.5.1</version>
+                <version>3.10.1</version>
                 <configuration>
                     <source>1.8</source>
                     <target>1.8</target>
@@ -92,7 +91,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
-                <version>2.2.1</version>
+                <version>3.2.1</version>
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -105,7 +104,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>2.9.1</version>
+                <version>3.4.0</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -115,11 +114,10 @@
                     </execution>
                 </executions>
             </plugin>
-
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-gpg-plugin</artifactId>
-                <version>1.6</version>
+                <version>3.0.1</version>
                 <executions>
                     <execution>
                         <id>sign-artifacts</id>
@@ -130,7 +128,6 @@
                     </execution>
                 </executions>
             </plugin>
-
             <plugin>
                 <groupId>org.sonatype.plugins</groupId>
                 <artifactId>nexus-staging-maven-plugin</artifactId>
@@ -142,7 +139,6 @@
                     <autoReleaseAfterClose>true</autoReleaseAfterClose>
                 </configuration>
             </plugin>
-
         </plugins>
     </build>
 

src/examples/java/com/recombee/api_client/examples/BasicExample.java

@@ -43,4 +43,4 @@ public static void main(String[] args) {
             //use fallback
         }
     }
-}
+}

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

@@ -49,8 +49,6 @@
 import com.recombee.api_client.api_requests.DeleteMoreItems;
 import com.recombee.api_client.api_requests.ListSeries;
 import com.recombee.api_client.api_requests.ListSeriesItems;
-import com.recombee.api_client.api_requests.ListGroups;
-import com.recombee.api_client.api_requests.ListGroupItems;
 import com.recombee.api_client.api_requests.GetUserValues;
 import com.recombee.api_client.api_requests.ListUsers;
 import com.recombee.api_client.api_requests.GetUserPropertyInfo;
@@ -75,6 +73,7 @@
 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.RecommendItemsToItemSegment;
 import com.recombee.api_client.api_requests.SearchItems;
 import com.recombee.api_client.api_requests.SearchItemSegments;
 import com.recombee.api_client.api_requests.AddSearchSynonym;
@@ -97,7 +96,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.1.5";
+    final String USER_AGENT = "recombee-java-api-client/5.0.0";
 
     private final OkHttpClient httpClient = new OkHttpClient();
 
@@ -213,26 +212,6 @@ public SeriesItem[] send(ListSeriesItems request) throws ApiException {
          return null;
     }
 
-    public Group[] send(ListGroups request) throws ApiException {
-        String responseStr = sendRequest(request);
-        try {
-            return this.mapper.readValue(responseStr, Group[].class);
-        } catch (IOException e) {
-            e.printStackTrace();
-         }
-         return null;
-    }
-
-    public GroupItem[] send(ListGroupItems request) throws ApiException {
-        String responseStr = sendRequest(request);
-        try {
-            return this.mapper.readValue(responseStr, GroupItem[].class);
-        } catch (IOException e) {
-            e.printStackTrace();
-         }
-         return null;
-    }
-
     public PropertyInfo send(GetUserPropertyInfo request) throws ApiException {
         String responseStr = sendRequest(request);
         try {
@@ -453,6 +432,16 @@ public RecommendationResponse send(RecommendItemSegmentsToItemSegment request) t
          return null;
     }
 
+    public RecommendationResponse send(RecommendItemsToItemSegment 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 {
@@ -591,6 +580,7 @@ else if ((request instanceof RecommendItemsToUser) ||
                             (request instanceof RecommendNextItems) ||
                             (request instanceof RecommendItemSegmentsToUser) ||
                             (request instanceof RecommendItemSegmentsToItem) ||
+                            (request instanceof RecommendItemsToItemSegment) ||
                             (request instanceof RecommendItemSegmentsToItemSegment) ||
                             (request instanceof SearchItemSegments))
                     {
@@ -610,7 +600,7 @@ else if (request instanceof DeleteMoreItems)
                     }
                     else if (request instanceof ListSegmentations)
                     {
-                        parsedResponse = mapper.convertValue(parsedResponse, ListSegmentations.class);
+                        parsedResponse = mapper.convertValue(parsedResponse, ListSegmentationsResponse.class);
                     }
                     /* Start of the generated code */
                     else if (request instanceof GetItemPropertyInfo)
@@ -643,22 +633,6 @@ else if (request instanceof ListSeriesItems)
                         parsedResponse = ar;
                     }
 
-                    else if (request instanceof ListGroups)
-                    {
-                        ArrayList<String> array = (ArrayList<String>) parsedResponse;
-                        Group[] ar = new Group[array.size()];
-                        for(int j=0;j<ar.length;j++) ar[j] = new Group(array.get(j));
-                        parsedResponse = ar;
-                    }
-
-                    else if (request instanceof ListGroupItems)
-                    {
-                        ArrayList<Map<String, Object>> array = (ArrayList<Map<String, Object>>) parsedResponse;
-                        GroupItem[] ar = new GroupItem[array.size()];
-                        for(int j=0;j<ar.length;j++) ar[j] = new GroupItem(array.get(j));
-                        parsedResponse = ar;
-                    }
-
                     else if (request instanceof GetUserPropertyInfo)
                     {
                         Map<String, Object> obj = (Map<String, Object>) parsedResponse;

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

@@ -49,7 +49,7 @@ public class AddBookmark extends Request {
     public AddBookmark (String userId,String itemId) {
         this.userId = userId;
         this.itemId = itemId;
-        this.timeout = 1000;
+        this.timeout = 3000;
     }
 
     /**

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

@@ -57,7 +57,7 @@ public class AddCartAddition extends Request {
     public AddCartAddition (String userId,String itemId) {
         this.userId = userId;
         this.itemId = itemId;
-        this.timeout = 1000;
+        this.timeout = 3000;
     }
 
     /**

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

@@ -53,7 +53,7 @@ public class AddDetailView extends Request {
     public AddDetailView (String userId,String itemId) {
         this.userId = userId;
         this.itemId = itemId;
-        this.timeout = 1000;
+        this.timeout = 3000;
     }
 
     /**

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

@@ -28,7 +28,7 @@ public class AddItem extends Request {
      */
     public AddItem (String itemId) {
         this.itemId = itemId;
-        this.timeout = 1000;
+        this.timeout = 3000;
     }
 
 

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

@@ -12,7 +12,7 @@
 import com.recombee.api_client.util.HTTPMethod;
 
 /**
- * Adding an item property is somehow equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
+ * Adding an item property is somewhat equivalent to adding a column to the table of items. The items may be characterized by various properties of different types.
  */
 public class AddItemProperty extends Request {
 

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

@@ -61,7 +61,7 @@ public class AddPurchase extends Request {
     public AddPurchase (String userId,String itemId) {
         this.userId = userId;
         this.itemId = itemId;
-        this.timeout = 1000;
+        this.timeout = 3000;
     }
 
     /**

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

@@ -55,7 +55,7 @@ public AddRating (String userId,String itemId,double rating) {
         this.userId = userId;
         this.itemId = itemId;
         this.rating = rating;
-        this.timeout = 1000;
+        this.timeout = 3000;
     }
 
     /**

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

@@ -14,7 +14,7 @@
 /**
  * Adds a new synonym for the [Search items](https://docs.recombee.com/api.html#search-items).
  * When the `term` is used in the search query, the `synonym` is also used for the full-text search.
- * Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
+ * Unless `oneWay=true`, it works also in the opposite way (`synonym` -> `term`).
  * An example of a synonym can be `science fiction` for the term `sci-fi`.
  */
 public class AddSearchSynonym extends Request {
@@ -28,7 +28,7 @@ public class AddSearchSynonym extends Request {
      */
     protected String synonym;
     /**
-     * If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+     * If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
      * Default: `false`.
      */
     protected Boolean oneWay;
@@ -45,7 +45,7 @@ public AddSearchSynonym (String term,String synonym) {
     }
 
     /**
-     * @param oneWay If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
+     * @param oneWay If set to `true`, only `term` -> `synonym` is considered. If set to `false`, also `synonym` -> `term` works.
      * Default: `false`.
      */
     public AddSearchSynonym setOneWay(boolean oneWay) {