deprecates: legacy personalization endpoint

algolia · Jan 30, 2020 · 2048442 · 2048442
1 parent a2240ad
commit 2048442
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 25 deletions.
diff --git a/src/Algolia.Search.Test/Serializer/SerializerTest.cs b/src/Algolia.Search.Test/Serializer/SerializerTest.cs
@@ -644,31 +644,6 @@ public void TestIndexSettingsWithCustomParameters()
             Assert.AreEqual(json, "{\"enableRules\":true,\"newParameter\":10}");
         }
 
-        [Test]
-        [Parallelizable]
-        public void TestPersonalization()
-        {
-            var strategyToSave = new SetStrategyRequest
-            {
-                EventsScoring = new Dictionary<string, EventScoring>
-                {
-                    { "Add to cart", new EventScoring { Score = 50, Type = "conversion" } },
-                    { "Purchase", new EventScoring { Score = 100, Type = "conversion" } }
-                },
-                FacetsScoring = new Dictionary<string, FacetScoring>
-                {
-                    { "brand", new FacetScoring { Score = 100 } },
-                    { "categories", new FacetScoring { Score = 10 } }
-                }
-            };
-
-            // Here we test the payload, as this settings are at app level all tests could overlap
-            string json = JsonConvert.SerializeObject(strategyToSave, JsonConfig.AlgoliaJsonSerializerSettings);
-            string expectedJson =
-                "{\"eventsScoring\":{\"Add to cart\":{\"type\":\"conversion\",\"score\":50},\"Purchase\":{\"type\":\"conversion\",\"score\":100}},\"facetsScoring\":{\"brand\":{\"score\":100},\"categories\":{\"score\":10}}}";
-            Assert.True(json.Equals(expectedJson));
-        }
-
         [Test]
         [Parallelizable]
         public void TestListIndicesResponses64BitsIntegers()

diff --git a/src/Algolia.Search/Clients/ISearchClient.cs b/src/Algolia.Search/Clients/ISearchClient.cs
@@ -536,13 +536,15 @@ public interface ISearchClient
         /// </summary>
         /// <param name="requestOptions"></param>
         /// <returns></returns>
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         GetStrategyResponse GetPersonalizationStrategy(RequestOptions requestOptions = null);
 
         /// <summary>
         /// Returns the personalization strategy of the application
         /// </summary>
         /// <param name="requestOptions"></param>
         /// <param name="ct">Optional cancellation token</param>
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         Task<GetStrategyResponse> GetPersonalizationStrategyAsync(RequestOptions requestOptions = null,
             CancellationToken ct = default);
 
@@ -552,6 +554,7 @@ public interface ISearchClient
         /// <param name="request">The personalization strategy</param>
         /// <param name="requestOptions">Request options for the query</param>
         /// <returns></returns>
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         SetStrategyResponse
             SetPersonalizationStrategy(SetStrategyRequest request, RequestOptions requestOptions = null);
 
@@ -562,6 +565,7 @@ public interface ISearchClient
         /// <param name="requestOptions">Request options for the query</param>
         /// <param name="ct">Request options for the query</param>
         /// <returns></returns>
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         Task<SetStrategyResponse> SetPersonalizationStrategyAsync(SetStrategyRequest request,
             RequestOptions requestOptions = null, CancellationToken ct = default);
 

diff --git a/src/Algolia.Search/Clients/SearchClient.cs b/src/Algolia.Search/Clients/SearchClient.cs
@@ -677,10 +677,12 @@ public AssignUserIdResponse
         }
 
         /// <inheritdoc />
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         public GetStrategyResponse GetPersonalizationStrategy(RequestOptions requestOptions = null) =>
             AsyncHelper.RunSync(() => GetPersonalizationStrategyAsync(requestOptions));
 
         /// <inheritdoc />
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         public async Task<GetStrategyResponse> GetPersonalizationStrategyAsync(RequestOptions requestOptions = null,
             CancellationToken ct = default)
         {
@@ -691,11 +693,13 @@ public AssignUserIdResponse
         }
 
         /// <inheritdoc />
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         public SetStrategyResponse SetPersonalizationStrategy(SetStrategyRequest request,
             RequestOptions requestOptions = null) =>
             AsyncHelper.RunSync(() => SetPersonalizationStrategyAsync(request, requestOptions));
 
         /// <inheritdoc />
+        [Obsolete("Endpoint will be deprecated, please use RecommendationClient instead.")]
         public async Task<SetStrategyResponse> SetPersonalizationStrategyAsync(SetStrategyRequest request,
             RequestOptions requestOptions = null, CancellationToken ct = default)
         {

diff --git a/src/Algolia.Search/Models/Personalization/EventScoring.cs b/src/Algolia.Search/Models/Personalization/EventScoring.cs
@@ -21,11 +21,14 @@
 * THE SOFTWARE.
 */
 
+using System;
+
 namespace Algolia.Search.Models.Personalization
 {
     /// <summary>
     ///
     /// </summary>
+    [Obsolete("Models are deprecated please use models located in Algolia.Search.Models.Recommendation.")]
     public class EventScoring
     {
         /// <summary>

diff --git a/src/Algolia.Search/Models/Personalization/FacetScoring.cs b/src/Algolia.Search/Models/Personalization/FacetScoring.cs
@@ -21,11 +21,14 @@
 * THE SOFTWARE.
 */
 
+using System;
+
 namespace Algolia.Search.Models.Personalization
 {
     /// <summary>
     ///
     /// </summary>
+    [Obsolete("Models are deprecated please use models located in Algolia.Search.Models.Recommendation.")]
     public class FacetScoring
     {
         /// <summary>

diff --git a/src/Algolia.Search/Models/Personalization/GetStrategyResponse.cs b/src/Algolia.Search/Models/Personalization/GetStrategyResponse.cs
@@ -21,13 +21,15 @@
 * THE SOFTWARE.
 */
 
+using System;
 using System.Collections.Generic;
 
 namespace Algolia.Search.Models.Personalization
 {
     /// <summary>
     /// Get personalization strategy response
     /// </summary>
+    [Obsolete("Models are deprecated please use models located in Algolia.Search.Models.Recommendation.")]
     public class GetStrategyResponse
     {
         /// <summary>

diff --git a/src/Algolia.Search/Models/Personalization/SetStrategyRequest.cs b/src/Algolia.Search/Models/Personalization/SetStrategyRequest.cs
@@ -21,13 +21,15 @@
 * THE SOFTWARE.
 */
 
+using System;
 using System.Collections.Generic;
 
 namespace Algolia.Search.Models.Personalization
 {
     /// <summary>
     /// Set personalization strategy request
     /// </summary>
+    [Obsolete("Models are deprecated please use models located in Algolia.Search.Models.Recommendation.")]
     public class SetStrategyRequest
     {
         /// <summary>

diff --git a/src/Algolia.Search/Models/Personalization/SetStrategyResponse.cs b/src/Algolia.Search/Models/Personalization/SetStrategyResponse.cs
@@ -28,6 +28,7 @@ namespace Algolia.Search.Models.Personalization
     /// <summary>
     /// Set strategy response
     /// </summary>
+    [Obsolete("Models are deprecated please use models located in Algolia.Search.Models.Recommendation.")]
     public class SetStrategyResponse
     {
         /// <summary>