feat(specs): add facets query parameter available at run time (generated)

algolia/api-clients-automation#5486

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clara Muller <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 3 people

src/main/scala/algoliasearch/composition/FacetOrdering.scala

@@ -36,6 +36,6 @@ package algoliasearch.composition
   *   Order of facet values. One object for each facet.
   */
 case class FacetOrdering(
-    facets: Option[Facets] = scala.None,
+    facets: Option[IndexSettingsFacets] = scala.None,
     values: Option[Map[String, Value]] = scala.None
 )

src/main/scala/algoliasearch/composition/Facets.scala renamed to src/main/scala/algoliasearch/composition/IndexSettingsFacets.scala

@@ -36,6 +36,6 @@ package algoliasearch.composition
   *   Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the
   *   top of the list.
   */
-case class Facets(
+case class IndexSettingsFacets(
     order: Option[Seq[String]] = scala.None
 )

src/main/scala/algoliasearch/composition/Params.scala

@@ -59,6 +59,10 @@ import algoliasearch.composition.SupportedLanguage._
   *   `relevancyStrictness` on [virtual replica
   *   indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas).
   *   Use this setting to strike a balance between the relevance and number of returned results.
+  * @param facets
+  *   Facets for which to retrieve facet values that match the search criteria and the number of matching facet values
+  *   To retrieve all facets, use the wildcard character `*`. For more information, see
+  *   [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
   * @param hitsPerPage
   *   Number of hits per page.
   * @param aroundLatLng
@@ -125,6 +129,7 @@ case class Params(
     page: Option[Int] = scala.None,
     getRankingInfo: Option[Boolean] = scala.None,
     relevancyStrictness: Option[Int] = scala.None,
+    facets: Option[Seq[String]] = scala.None,
     facetFilters: Option[FacetFilters] = scala.None,
     optionalFilters: Option[OptionalFilters] = scala.None,
     numericFilters: Option[NumericFilters] = scala.None,