algolia 3.28.1 → 3.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a9a8d49f4f5bc3ae8b75a1c9470c8c6a4b6f1af6e3c3609e166aa2835af5813
-  data.tar.gz: 382f6cdab4882f0c945134500e700f6a92ee4adf12845b780d0ee56fe9f575a5
+  metadata.gz: bcde7ae71c32fa6e073950147008629bff66d7ecbf6b12a444eb77940b2554ee
+  data.tar.gz: f56588ae532e018f7a7b98ce88cef47b68d99eef0c5fe1652eca50823ac36d1a
 SHA512:
-  metadata.gz: fad587a7862d83615860d0abbfb1f64b253bb1f90648d7568c3e48fe69a9be5f9c670f115b58534a787c763d9f16719fbbedc863f2414271ed0194f18c71ef08
-  data.tar.gz: 103375b059468d554ef7578fe8f01eb240fb5e1eee585c914a3dde2f52243e2995d31f36adebedfe313e4a0e8ae30bec25568a090e9b16a1e0f02abdb7123d6b
+  metadata.gz: 1d1a35d5c6b0b0d0496ea9602fe3d7b8b7d451bfbb01c76403dbb8247910d99e7080ab5e4d0df11b20c38a5a9fbf8215d3669ba8a1a935c9ba9e807ed02e1daa
+  data.tar.gz: '0812ca5adb24357e0dfa5d48be4ef7f5e206b3ecd105bba4dd2c1cb8cc456b7b346677f793b0e8cef4e2defacf1ba949b4dc32dc473ef7a5860c997c56a540c1'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.29.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.28.1...3.29.0)
+
+- [7f9de7cd9](https://github.com/algolia/api-clients-automation/commit/7f9de7cd9) fix(specs): ingestion small fix + added source input descriptions ([#5515](https://github.com/algolia/api-clients-automation/pull/5515)) by [@sbellone](https://github.com/sbellone/)
+- [7287faaa7](https://github.com/algolia/api-clients-automation/commit/7287faaa7) feat(specs): add `facets` query parameter available at run time ([#5486](https://github.com/algolia/api-clients-automation/pull/5486)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+
 ## [3.28.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.28.0...3.28.1)
 
 - [9a92b3269](https://github.com/algolia/api-clients-automation/commit/9a92b3269) chore(deps): dependencies 2025-10-13 ([#5453](https://github.com/algolia/api-clients-automation/pull/5453)) by [@algolia-bot](https://github.com/algolia-bot/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.28.1)
+    algolia (3.29.0)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/models/composition/facet_ordering.rb

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

data/lib/algolia/models/composition/{facets.rb → index_settings_facets.rb}

@@ -8,7 +8,7 @@ require "time"
 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,7 +37,10 @@ module Algolia
       # @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
@@ -45,7 +48,7 @@ module Algolia
           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

data/lib/algolia/models/composition/params.rb

@@ -23,6 +23,9 @@ module Algolia
       # 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 @@ module Algolia
           :page => :page,
           :get_ranking_info => :getRankingInfo,
           :relevancy_strictness => :relevancyStrictness,
+          :facets => :facets,
           :facet_filters => :facetFilters,
           :optional_filters => :optionalFilters,
           :numeric_filters => :numericFilters,
@@ -124,6 +128,7 @@ module Algolia
           :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 @@ module Algolia
           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 @@ module Algolia
           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 @@ module Algolia
           page,
           get_ranking_info,
           relevancy_strictness,
+          facets,
           facet_filters,
           optional_filters,
           numeric_filters,

data/lib/algolia/models/ingestion/authentication_update.rb

@@ -14,8 +14,6 @@ module Algolia
       # Descriptive name for the resource.
       attr_accessor :name
 
-      attr_accessor :platform
-
       attr_accessor :input
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -23,7 +21,6 @@ module Algolia
         {
           :type => :type,
           :name => :name,
-          :platform => :platform,
           :input => :input
         }
       end
@@ -33,7 +30,6 @@ module Algolia
         {
           :type => :"AuthenticationType",
           :name => :"String",
-          :platform => :"Platform",
           :input => :"AuthInputPartial"
         }
       end
@@ -41,9 +37,7 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          [
-            :platform
-          ]
+          []
         )
       end
 
@@ -78,10 +72,6 @@ module Algolia
           self.name = attributes[:name]
         end
 
-        if attributes.key?(:platform)
-          self.platform = attributes[:platform]
-        end
-
         if attributes.key?(:input)
           self.input = attributes[:input]
         end
@@ -94,7 +84,6 @@ module Algolia
         self.class == other.class &&
           type == other.type &&
           name == other.name &&
-          platform == other.platform &&
           input == other.input
       end
 
@@ -107,7 +96,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [type, name, platform, input].hash
+        [type, name, input].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/source_big_commerce.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `bigcommerce` source.
     class SourceBigCommerce
       # Store hash identifying your BigCommerce store.
       attr_accessor :store_hash

data/lib/algolia/models/ingestion/source_big_query.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `bigquery` source.
     class SourceBigQuery
       # Project ID of the BigQuery source.
       attr_accessor :project_id

data/lib/algolia/models/ingestion/source_commercetools.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `commercetools` source.
     class SourceCommercetools
       attr_accessor :store_keys
 

data/lib/algolia/models/ingestion/source_csv.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `csv` source.
     class SourceCSV
       # URL of the file.
       attr_accessor :url

data/lib/algolia/models/ingestion/source_docker.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `docker` source.
     class SourceDocker
       # Name of the connector.
       attr_accessor :image

data/lib/algolia/models/ingestion/source_ga4_big_query_export.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `ga4BigqueryExport` source.
     class SourceGA4BigQueryExport
       # GCP project ID that the BigQuery export writes to.
       attr_accessor :project_id

data/lib/algolia/models/ingestion/source_json.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `json` source.
     class SourceJSON
       # URL of the file.
       attr_accessor :url

data/lib/algolia/models/ingestion/source_update_commercetools.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `commercetools` source.
     class SourceUpdateCommercetools
       attr_accessor :store_keys
 

data/lib/algolia/models/ingestion/source_update_docker.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `docker` source.
     class SourceUpdateDocker
       # Configuration of the spec.
       attr_accessor :configuration

data/lib/algolia/models/ingestion/source_update_shopify.rb

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Ingestion
+    # Specific configuration attributes of a `shopify` source.
     class SourceUpdateShopify
       # Feature flags for the Shopify source.
       attr_accessor :feature_flags

data/lib/algolia/version.rb

@@ -3,5 +3,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.28.1"
+  VERSION = "3.29.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.28.1
+  version: 3.29.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -301,7 +301,6 @@ files:
 - lib/algolia/models/composition/facet_hits.rb
 - lib/algolia/models/composition/facet_ordering.rb
 - lib/algolia/models/composition/facet_stats.rb
-- lib/algolia/models/composition/facets.rb
 - lib/algolia/models/composition/get_task_response.rb
 - lib/algolia/models/composition/highlight_result.rb
 - lib/algolia/models/composition/highlight_result_option.rb
@@ -309,6 +308,7 @@ files:
 - lib/algolia/models/composition/hit_metadata.rb
 - lib/algolia/models/composition/hit_ranking_info.rb
 - lib/algolia/models/composition/ignore_plurals.rb
+- lib/algolia/models/composition/index_settings_facets.rb
 - lib/algolia/models/composition/injected_item.rb
 - lib/algolia/models/composition/injected_item_hits_metadata.rb
 - lib/algolia/models/composition/injected_item_metadata.rb