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

lib/Model/Composition/FacetOrdering.php

@@ -22,7 +22,7 @@ class FacetOrdering extends AbstractModel implements ModelInterface, \ArrayAcces
      * @var string[]
      */
     protected static $modelTypes = [
-        'facets' => '\Algolia\AlgoliaSearch\Model\Composition\Facets',
+        'facets' => '\Algolia\AlgoliaSearch\Model\Composition\IndexSettingsFacets',
         'values' => 'array<string,\Algolia\AlgoliaSearch\Model\Composition\Value>',
     ];
 
@@ -164,7 +164,7 @@ public function valid()
     /**
      * Gets facets.
      *
-     * @return null|Facets
+     * @return null|IndexSettingsFacets
      */
     public function getFacets()
     {
@@ -174,7 +174,7 @@ public function getFacets()
     /**
      * Sets facets.
      *
-     * @param null|Facets $facets facets
+     * @param null|IndexSettingsFacets $facets facets
      *
      * @return self
      */

lib/Model/Composition/Facets.php renamed to lib/Model/Composition/IndexSettingsFacets.php

@@ -8,13 +8,13 @@
 use Algolia\AlgoliaSearch\Model\ModelInterface;
 
 /**
- * Facets Class Doc Comment.
+ * IndexSettingsFacets Class Doc Comment.
  *
  * @category Class
  *
  * @description Order of facet names.
  */
-class Facets extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
+class IndexSettingsFacets extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * Array of property to type mappings. Used for (de)serialization.

lib/Model/Composition/Params.php

@@ -25,6 +25,7 @@ class Params extends AbstractModel implements ModelInterface, \ArrayAccess, \Jso
         'page' => 'int',
         'getRankingInfo' => 'bool',
         'relevancyStrictness' => 'int',
+        'facets' => 'string[]',
         'facetFilters' => '\Algolia\AlgoliaSearch\Model\Composition\FacetFilters',
         'optionalFilters' => '\Algolia\AlgoliaSearch\Model\Composition\OptionalFilters',
         'numericFilters' => '\Algolia\AlgoliaSearch\Model\Composition\NumericFilters',
@@ -60,6 +61,7 @@ class Params extends AbstractModel implements ModelInterface, \ArrayAccess, \Jso
         'page' => null,
         'getRankingInfo' => null,
         'relevancyStrictness' => null,
+        'facets' => null,
         'facetFilters' => null,
         'optionalFilters' => null,
         'numericFilters' => null,
@@ -96,6 +98,7 @@ class Params extends AbstractModel implements ModelInterface, \ArrayAccess, \Jso
         'page' => 'page',
         'getRankingInfo' => 'getRankingInfo',
         'relevancyStrictness' => 'relevancyStrictness',
+        'facets' => 'facets',
         'facetFilters' => 'facetFilters',
         'optionalFilters' => 'optionalFilters',
         'numericFilters' => 'numericFilters',
@@ -131,6 +134,7 @@ class Params extends AbstractModel implements ModelInterface, \ArrayAccess, \Jso
         'page' => 'setPage',
         'getRankingInfo' => 'setGetRankingInfo',
         'relevancyStrictness' => 'setRelevancyStrictness',
+        'facets' => 'setFacets',
         'facetFilters' => 'setFacetFilters',
         'optionalFilters' => 'setOptionalFilters',
         'numericFilters' => 'setNumericFilters',
@@ -166,6 +170,7 @@ class Params extends AbstractModel implements ModelInterface, \ArrayAccess, \Jso
         'page' => 'getPage',
         'getRankingInfo' => 'getGetRankingInfo',
         'relevancyStrictness' => 'getRelevancyStrictness',
+        'facets' => 'getFacets',
         'facetFilters' => 'getFacetFilters',
         'optionalFilters' => 'getOptionalFilters',
         'numericFilters' => 'getNumericFilters',
@@ -219,6 +224,9 @@ public function __construct(?array $data = null)
         if (isset($data['relevancyStrictness'])) {
             $this->container['relevancyStrictness'] = $data['relevancyStrictness'];
         }
+        if (isset($data['facets'])) {
+            $this->container['facets'] = $data['facets'];
+        }
         if (isset($data['facetFilters'])) {
             $this->container['facetFilters'] = $data['facetFilters'];
         }
@@ -479,6 +487,30 @@ public function setRelevancyStrictness($relevancyStrictness)
         return $this;
     }
 
+    /**
+     * Gets facets.
+     *
+     * @return null|string[]
+     */
+    public function getFacets()
+    {
+        return $this->container['facets'] ?? null;
+    }
+
+    /**
+     * Sets facets.
+     *
+     * @param null|string[] $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).
+     *
+     * @return self
+     */
+    public function setFacets($facets)
+    {
+        $this->container['facets'] = $facets;
+
+        return $this;
+    }
+
     /**
      * Gets facetFilters.
      *