Release: v6.2.0

- Added recommend-next-item-segments endpoint support
- Added `searchQuery` parameter support for composite recommendations

Author: MichalDemko

Src/Recombee.ApiClient.Tests/RecommendNextItemSegmentsBatchUnitTest.cs

@@ -0,0 +1,66 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Xunit;
+using Recombee.ApiClient.ApiRequests;
+using Recombee.ApiClient.Bindings;
+
+namespace Recombee.ApiClient.Tests
+{
+    public class RecommendNextItemSegmentsBatchUnitTest: RecombeeUnitTest
+    {
+
+        [Fact]
+        public  void TestRecommendNextItemSegments()
+        {
+            Object resp2;
+            try
+        {
+            client.Send(new RecommendNextItemSegments("invalid_recomm_id", 5));
+            Assert.True(false,"No exception thrown");
+        }
+        catch (ResponseException ex)
+        {
+            Assert.Equal(400, (int)ex.StatusCode);
+        }
+        
+            resp2 = client.Send(new RecommendItemsToUser("entity_id", 3));
+        
+            Request[] requests = new Request[] {
+                new RecommendNextItemSegments(((RecommendationResponse)resp2).RecommId, 5)
+            };
+        
+            BatchResponse batchResponse = client.Send(new Batch(requests));
+            Assert.Equal(400, (int)batchResponse.StatusCodes.ElementAt(0));
+        }
+
+        [Fact]
+        public async void TestRecommendNextItemSegmentsAsync()
+        {
+            Object resp2;
+            try
+        {
+            await client.SendAsync(new RecommendNextItemSegments("invalid_recomm_id", 5));
+            Assert.True(false,"No exception thrown");
+        }
+        catch (ResponseException ex)
+        {
+            Assert.Equal(400, (int)ex.StatusCode);
+        }
+        
+            resp2 = await client.SendAsync(new RecommendItemsToUser("entity_id", 3));
+        
+            Request[] requests = new Request[] {
+                new RecommendNextItemSegments(((RecommendationResponse)resp2).RecommId, 5)
+            };
+        
+            BatchResponse batchResponse = await client.SendAsync(new Batch(requests));
+            Assert.Equal(400, (int)batchResponse.StatusCodes.ElementAt(0));
+        }
+    }
+}

Src/Recombee.ApiClient.Tests/RecommendNextItemSegmentsUnitTest.cs

@@ -0,0 +1,76 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Xunit;
+using Recombee.ApiClient.ApiRequests;
+using Recombee.ApiClient.Bindings;
+
+namespace Recombee.ApiClient.Tests
+{
+    public class RecommendNextItemSegmentsUnitTest: RecombeeUnitTest
+    {
+
+        [Fact]
+        public  void TestRecommendNextItemSegments()
+        {
+            RecommendNextItemSegments req;
+            RecommendationResponse resp;
+            Object resp2;
+            // it 'rejects request with invalid recommId'
+            try
+            {
+                client.Send(new RecommendNextItemSegments("invalid_recomm_id", 5));
+                Assert.True(false,"No exception thrown");
+            }
+            catch (ResponseException ex)
+            {
+                Assert.Equal(400, (int)ex.StatusCode);
+            }
+            // it 'rejects request to recommId which does not return item-segments'
+            resp2 = client.Send(new RecommendItemsToUser("entity_id", 3));
+            try
+            {
+                client.Send(new RecommendNextItemSegments(((RecommendationResponse)resp2).RecommId, 5));
+                Assert.True(false,"No exception thrown");
+            }
+            catch (ResponseException ex)
+            {
+                Assert.Equal(400, (int)ex.StatusCode);
+            }
+        }
+
+        [Fact]
+        public async void TestRecommendNextItemSegmentsAsync()
+        {
+            RecommendNextItemSegments req;
+            RecommendationResponse resp;
+            Object resp2;
+            // it 'rejects request with invalid recommId'
+            try
+            {
+                await client.SendAsync(new RecommendNextItemSegments("invalid_recomm_id", 5));
+                Assert.True(false,"No exception thrown");
+            }
+            catch (ResponseException ex)
+            {
+                Assert.Equal(400, (int)ex.StatusCode);
+            }
+            // it 'rejects request to recommId which does not return item-segments'
+            resp2 = await client.SendAsync(new RecommendItemsToUser("entity_id", 3));
+            try
+            {
+                await client.SendAsync(new RecommendNextItemSegments(((RecommendationResponse)resp2).RecommId, 5));
+                Assert.True(false,"No exception thrown");
+            }
+            catch (ResponseException ex)
+            {
+                Assert.Equal(400, (int)ex.StatusCode);
+            }
+        }
+    }
+}

Src/Recombee.ApiClient/ApiRequests/CompositeRecommendation.cs

@@ -12,7 +12,7 @@
 namespace Recombee.ApiClient.ApiRequests
 {
     /// <summary>Composite Recommendation</summary>
-    /// <remarks>Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations.html)) and a list of related recommendations in a single response.
+    /// <remarks>Composite Recommendation returns both a *source entity* (e.g., an Item or [Item Segment](https://docs.recombee.com/segmentations)) and a list of related recommendations in a single response.
     /// It is ideal for use cases such as personalized homepage sections (*Articles from <category>*), *Because You Watched <movie>*, or *Artists Related to Your Favorite Artist <artist>*.
     /// See detailed **examples and configuration guidance** in the [Composite Scenarios documentation](https://docs.recombee.com/scenarios#composite-recommendations).
     /// **Structure**
@@ -80,6 +80,13 @@ public string SegmentId
         {
             get {return segmentId;}
         }
+        private readonly string searchQuery;
+        /// <summary>Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+        /// </summary>
+        public string SearchQuery
+        {
+            get {return searchQuery;}
+        }
         private readonly bool? cascadeCreate;
         /// <summary>If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
         /// </summary>
@@ -127,6 +134,8 @@ public Dictionary<string, object> ExpertSettings
         /// </param>
         /// <param name="segmentId">ID of the segment from `contextSegmentationId` for which the recommendations are to be generated.
         /// </param>
+        /// <param name="searchQuery">Search query provided by the user. It is used for the full-text search. Only applicable if the *scenario* corresponds to a search scenario.
+        /// </param>
         /// <param name="cascadeCreate">If the entity for the source recommendation does not exist in the database, returns a list of non-personalized recommendations and creates the user in the database. This allows, for example, rotations in the following recommendations for that entity, as the entity will be already known to the system.
         /// </param>
         /// <param name="sourceSettings">Parameters applied for recommending the *Source* stage. The accepted parameters correspond with the recommendation sub-endpoint used to recommend the *Source*.
@@ -135,14 +144,15 @@ public Dictionary<string, object> ExpertSettings
         /// </param>
         /// <param name="expertSettings">Dictionary of custom options.
         /// </param>
-        public CompositeRecommendation (string scenario, long count, string itemId = null, string userId = null, Logic logic = null, string segmentId = null, bool? cascadeCreate = null, CompositeRecommendationStageParameters sourceSettings = null, CompositeRecommendationStageParameters resultSettings = null, Dictionary<string, object> expertSettings = null): base(HttpMethod.Post, 3000)
+        public CompositeRecommendation (string scenario, long count, string itemId = null, string userId = null, Logic logic = null, string segmentId = null, string searchQuery = null, bool? cascadeCreate = null, CompositeRecommendationStageParameters sourceSettings = null, CompositeRecommendationStageParameters resultSettings = null, Dictionary<string, object> expertSettings = null): base(HttpMethod.Post, 3000)
         {
             this.scenario = scenario;
             this.count = count;
             this.itemId = itemId;
             this.userId = userId;
             this.logic = logic;
             this.segmentId = segmentId;
+            this.searchQuery = searchQuery;
             this.cascadeCreate = cascadeCreate;
             this.sourceSettings = sourceSettings;
             this.resultSettings = resultSettings;
@@ -183,6 +193,8 @@ public override Dictionary<string, object> BodyParameters()
                 parameters["logic"] = this.Logic;
             if (this.SegmentId != null)
                 parameters["segmentId"] = this.SegmentId;
+            if (this.SearchQuery != null)
+                parameters["searchQuery"] = this.SearchQuery;
             if (this.CascadeCreate.HasValue)
                 parameters["cascadeCreate"] = this.CascadeCreate.Value;
             if (this.SourceSettings != null)

Src/Recombee.ApiClient/ApiRequests/RecommendNextItemSegments.cs

@@ -0,0 +1,83 @@
+/*
+ This file is auto-generated, do not edit
+*/
+
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using Recombee.ApiClient.Bindings;
+using Recombee.ApiClient.Util;
+
+
+namespace Recombee.ApiClient.ApiRequests
+{
+    /// <summary>Recommend Next Item segments</summary>
+    /// <remarks>Returns Item segments that shall be shown to a user as next recommendations when the user e.g. scrolls the page down (*infinite scroll*) or goes to the next page.
+    /// It accepts `recommId` of a base recommendation request (e.g., request from the first page) and the number of segments that shall be returned (`count`).
+    /// The base request can be one of:
+    ///   - [Recommend Item Segments to Item](https://docs.recombee.com/api#recommend-item-segments-to-item)
+    ///   - [Recommend Item Segments to User](https://docs.recombee.com/api#recommend-item-segments-to-user)
+    ///   - [Recommend Item Segments to Item Segment](https://docs.recombee.com/api#recommend-item-segments-to-item-segment)
+    ///   - [Search Item Segments](https://docs.recombee.com/api#search-item-segments)
+    /// All the other parameters are inherited from the base request.
+    /// *Recommend next Item segments* can be called many times for a single `recommId` and each call returns different (previously not recommended) segments.
+    /// The number of *Recommend next Item segments* calls performed so far is returned in the `numberNextRecommsCalls` field.
+    /// *Recommend next Item segments* can be requested up to 30 minutes after the base request or a previous *Recommend next Item segments* call.
+    /// For billing purposes, each call to *Recommend next Item segments* is counted as a separate recommendation request.
+    /// </remarks>
+    public class RecommendNextItemSegments : Request
+    {
+        private readonly string recommId;
+        /// <summary>ID of the base recommendation request for which next recommendations should be returned</summary>
+        public string RecommId
+        {
+            get {return recommId;}
+        }
+        private readonly long count;
+        /// <summary>Number of item segments to be recommended
+        /// </summary>
+        public long Count
+        {
+            get {return count;}
+        }
+    
+        /// <summary>Construct the request</summary>
+        /// <param name="recommId">ID of the base recommendation request for which next recommendations should be returned</param>
+        /// <param name="count">Number of item segments to be recommended
+        /// </param>
+        public RecommendNextItemSegments (string recommId, long count): base(HttpMethod.Post, 3000)
+        {
+            this.recommId = recommId;
+            this.count = count;
+        }
+    
+        /// <returns>URI to the endpoint including path parameters</returns>
+        public override string Path()
+        {
+            return string.Format("/recomms/next/item-segments/{0}", RecommId);
+        }
+    
+        /// <summary>Get query parameters</summary>
+        /// <returns>Dictionary containing values of query parameters (name of parameter: value of the parameter)</returns>
+        public override Dictionary<string, object> QueryParameters()
+        {
+           var parameters =  new Dictionary<string, object>()
+            {
+        
+            };
+            return parameters;
+        }
+    
+        /// <summary>Get body parameters</summary>
+        /// <returns>Dictionary containing  values of body parameters (name of parameter: value of the parameter)</returns>
+        public override Dictionary<string, object> BodyParameters()
+        {
+           var parameters =  new Dictionary<string, object>()
+            {
+                {"count", this.Count}
+            };
+            return parameters;
+        }
+    
+    }
+}

Src/Recombee.ApiClient/Recombee.ApiClient.csproj

@@ -12,7 +12,7 @@
   </ItemGroup>
 
   <PropertyGroup>
-    <Version>6.1.0</Version>
+    <Version>6.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>

Src/Recombee.ApiClient/RecombeeClient.Generated.cs

@@ -854,6 +854,35 @@ public RecommendationResponse Send(RecommendItemSegmentsToItemSegment request)
         }
 
 
+        /// <summary>Parse JSON response</summary>
+        /// <param name="json">JSON string from the API</param>
+        /// <param name="request">Request sent to the API</param>
+        /// <returns>Parsed response</returns>
+        protected RecommendationResponse ParseResponse(string json, RecommendNextItemSegments request)
+        {
+            return JsonConvert.DeserializeObject<RecommendationResponse>(json);
+        }
+        
+        /// <summary>Asynchronously send the RecommendNextItemSegments request</summary>
+        /// <param name="request">Request to be sent</param>
+        /// <returns>Task representing the asynchronous operation</returns>
+        public async Task<RecommendationResponse> SendAsync(RecommendNextItemSegments request)
+        {
+            var json = await SendRequestAsync(request);
+            return ParseResponse(json, request);
+        }
+        
+        /// <summary>Synchronously send the RecommendNextItemSegments request</summary>
+        /// <param name="request">Request to be sent</param>
+        /// <returns>Response from the API</returns>
+        public RecommendationResponse Send(RecommendNextItemSegments request)
+        {
+            var task = Task.Run(async () => await SendAsync(request));
+            var result = task.WaitAndUnwrapException();
+            return result;
+        }
+        
+        
         /// <summary>Parse JSON response</summary>
         /// <param name="json">JSON string from the API</param>
         /// <param name="request">Request sent to the API</param>
@@ -1155,6 +1184,8 @@ private object ParseOneBatchResponse(string json, int statusCode, Request reques
 
             if (request is RecommendItemSegmentsToItemSegment) return ParseResponse(json, (RecommendItemSegmentsToItemSegment) request); 
 
+            if (request is RecommendNextItemSegments) return ParseResponse(json, (RecommendNextItemSegments) request); 
+            
             if (request is CompositeRecommendation) return ParseResponse(json, (CompositeRecommendation) request); 
 
             if (request is SearchItems) return ParseResponse(json, (SearchItems) request); 

Src/Recombee.ApiClient/RecombeeClient.cs

@@ -92,7 +92,7 @@ private string getHostUri(string baseUri, Region? region) {
         private HttpClient createHttpClient()
         {
             var httpClient = new HttpClient();
-            httpClient.DefaultRequestHeaders.Add("User-Agent", "recombee-.net-api-client/6.1.0");
+            httpClient.DefaultRequestHeaders.Add("User-Agent", "recombee-.net-api-client/6.2.0");
             return httpClient;
         }