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

algolia/api-clients-automation#5486

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>

Author: 3 people

lib/algolia/models/composition/facet_ordering.rb

@@ -25,7 +25,7 @@ def self.attribute_map
       # Attribute type mapping.
       def self.types_mapping
         {
-          :facets => :"Facets",
+          :facets => :"IndexSettingsFacets",
           :values => :"Hash<String, Value>"
         }
       end

lib/algolia/models/composition/facets.rb renamed to lib/algolia/models/composition/index_settings_facets.rb

@@ -8,7 +8,7 @@
 module Algolia
   module Composition
     # Order of facet names.
-    class Facets
+    class IndexSettingsFacets
       # Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
       attr_accessor :order
 
@@ -37,15 +37,18 @@ def self.openapi_nullable
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
         if (!attributes.is_a?(Hash))
-          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Facets` initialize method"
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::IndexSettingsFacets` initialize method"
+          )
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
         attributes = attributes.each_with_object({}) { |(k, v), h|
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::Facets`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::IndexSettingsFacets`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

lib/algolia/models/composition/params.rb

@@ -23,6 +23,9 @@ class Params
       # Relevancy threshold below which less relevant results aren't included in the results You can only set `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.
       attr_accessor :relevancy_strictness
 
+      # 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).
+      attr_accessor :facets
+
       attr_accessor :facet_filters
 
       attr_accessor :optional_filters
@@ -91,6 +94,7 @@ def self.attribute_map
           :page => :page,
           :get_ranking_info => :getRankingInfo,
           :relevancy_strictness => :relevancyStrictness,
+          :facets => :facets,
           :facet_filters => :facetFilters,
           :optional_filters => :optionalFilters,
           :numeric_filters => :numericFilters,
@@ -124,6 +128,7 @@ def self.types_mapping
           :page => :"Integer",
           :get_ranking_info => :"Boolean",
           :relevancy_strictness => :"Integer",
+          :facets => :"Array<String>",
           :facet_filters => :"FacetFilters",
           :optional_filters => :"OptionalFilters",
           :numeric_filters => :"NumericFilters",
@@ -198,6 +203,12 @@ def initialize(attributes = {})
           self.relevancy_strictness = attributes[:relevancy_strictness]
         end
 
+        if attributes.key?(:facets)
+          if (value = attributes[:facets]).is_a?(Array)
+            self.facets = value
+          end
+        end
+
         if attributes.key?(:facet_filters)
           self.facet_filters = attributes[:facet_filters]
         end
@@ -309,6 +320,7 @@ def ==(other)
           page == other.page &&
           get_ranking_info == other.get_ranking_info &&
           relevancy_strictness == other.relevancy_strictness &&
+          facets == other.facets &&
           facet_filters == other.facet_filters &&
           optional_filters == other.optional_filters &&
           numeric_filters == other.numeric_filters &&
@@ -348,6 +360,7 @@ def hash
           page,
           get_ranking_info,
           relevancy_strictness,
+          facets,
           facet_filters,
           optional_filters,
           numeric_filters,