feat(specs): add (optional) _automaticInsights to search result (gene…

…rated) algolia/api-clients-automation#3688 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Raed <[email protected]>
algolia · Sep 11, 2024 · 641316f · 641316f
1 parent 2130dc9
commit 641316f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 2 deletions.
diff --git a/src/main/scala/algoliasearch/recommend/BaseSearchResponse.scala b/src/main/scala/algoliasearch/recommend/BaseSearchResponse.scala
@@ -79,6 +79,8 @@ import org.json4s.{Extraction, Formats, JField, JObject, JValue, Serializer, Typ
   * @param queryID
   *   Unique identifier for the query. This is used for [click
   *   analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+  * @param automaticInsights
+  *   Whether automatic events collection is enabled for the application.
   */
 case class BaseSearchResponse(
     abTestID: Option[Int] = scala.None,
@@ -105,6 +107,7 @@ case class BaseSearchResponse(
     serverUsed: Option[String] = scala.None,
     userData: Option[Any] = scala.None,
     queryID: Option[String] = scala.None,
+    automaticInsights: Option[Boolean] = scala.None,
     additionalProperties: Option[List[JField]] = None
 )
 
@@ -142,7 +145,8 @@ class BaseSearchResponseSerializer extends Serializer[BaseSearchResponse] {
             "serverTimeMS",
             "serverUsed",
             "userData",
-            "queryID"
+            "queryID",
+            "automaticInsights"
           )
           val additionalProperties = jobject removeField {
             case (name, _) if fields.contains(name) => true

diff --git a/src/main/scala/algoliasearch/recommend/RecommendationsResults.scala b/src/main/scala/algoliasearch/recommend/RecommendationsResults.scala
@@ -76,6 +76,8 @@ package algoliasearch.recommend
   * @param queryID
   *   Unique identifier for the query. This is used for [click
   *   analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+  * @param automaticInsights
+  *   Whether automatic events collection is enabled for the application.
   * @param page
   *   Page of search results to retrieve.
   * @param nbHits
@@ -110,6 +112,7 @@ case class RecommendationsResults(
     serverUsed: Option[String] = scala.None,
     userData: Option[Any] = scala.None,
     queryID: Option[String] = scala.None,
+    automaticInsights: Option[Boolean] = scala.None,
     page: Int,
     nbHits: Int,
     nbPages: Int,

diff --git a/src/main/scala/algoliasearch/search/BaseSearchResponse.scala b/src/main/scala/algoliasearch/search/BaseSearchResponse.scala
@@ -83,6 +83,8 @@ import org.json4s.{Extraction, Formats, JField, JObject, JValue, Serializer, Typ
   * @param queryID
   *   Unique identifier for the query. This is used for [click
   *   analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+  * @param automaticInsights
+  *   Whether automatic events collection is enabled for the application.
   */
 case class BaseSearchResponse(
     abTestID: Option[Int] = scala.None,
@@ -109,6 +111,7 @@ case class BaseSearchResponse(
     serverUsed: Option[String] = scala.None,
     userData: Option[Any] = scala.None,
     queryID: Option[String] = scala.None,
+    automaticInsights: Option[Boolean] = scala.None,
     additionalProperties: Option[List[JField]] = None
 )
 
@@ -146,7 +149,8 @@ class BaseSearchResponseSerializer extends Serializer[BaseSearchResponse] {
             "serverTimeMS",
             "serverUsed",
             "userData",
-            "queryID"
+            "queryID",
+            "automaticInsights"
           )
           val additionalProperties = jobject removeField {
             case (name, _) if fields.contains(name) => true

diff --git a/src/main/scala/algoliasearch/search/BrowseResponse.scala b/src/main/scala/algoliasearch/search/BrowseResponse.scala
@@ -80,6 +80,8 @@ package algoliasearch.search
   * @param queryID
   *   Unique identifier for the query. This is used for [click
   *   analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+  * @param automaticInsights
+  *   Whether automatic events collection is enabled for the application.
   * @param page
   *   Page of search results to retrieve.
   * @param nbHits
@@ -124,6 +126,7 @@ case class BrowseResponse(
     serverUsed: Option[String] = scala.None,
     userData: Option[Any] = scala.None,
     queryID: Option[String] = scala.None,
+    automaticInsights: Option[Boolean] = scala.None,
     page: Option[Int] = scala.None,
     nbHits: Option[Int] = scala.None,
     nbPages: Option[Int] = scala.None,

diff --git a/src/main/scala/algoliasearch/search/SearchResponse.scala b/src/main/scala/algoliasearch/search/SearchResponse.scala
@@ -80,6 +80,8 @@ package algoliasearch.search
   * @param queryID
   *   Unique identifier for the query. This is used for [click
   *   analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+  * @param automaticInsights
+  *   Whether automatic events collection is enabled for the application.
   * @param page
   *   Page of search results to retrieve.
   * @param nbHits
@@ -121,6 +123,7 @@ case class SearchResponse(
     serverUsed: Option[String] = scala.None,
     userData: Option[Any] = scala.None,
     queryID: Option[String] = scala.None,
+    automaticInsights: Option[Boolean] = scala.None,
     page: Int,
     nbHits: Int,
     nbPages: Int,