algolia 3.21.1 → 3.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a5e39d35817a8422093311ebd458f87bba18346808a138a8b45ca3ca86917c1
-  data.tar.gz: 5407640c35307096179c4b3ff1c5875bd8d62b19d2d64fb51ae250fd6be8046c
+  metadata.gz: 31c57dd38d31a525efb169f39ee223c30334d1f17f4e2e31288e3d47a9385ca0
+  data.tar.gz: 1d8c171978f9ac404996faf0bd3464a9aae3ad89e415c9a1c5d55d06d85ec732
 SHA512:
-  metadata.gz: 3a107416244b5e4cac43ad07c3f6605f31ceab1c8bec776e373ad760a189cd5eb463708b6500b76cb70d71d4bcde74af46f2a0d0bf244231784d2c0c5b01f351
-  data.tar.gz: 11e88b59830fd81a37d7b8a2e0f832b85824c792e5539e6877927c66eea86184e87f3351c3ca09bdd3bb5d90acbda29f7e5c9edb8c0211610b2780c69a4ef87b
+  metadata.gz: 23275035d3a2904e2c604ab70e4551b642d78c2f620baf4681454195b95015c72e8e67b2d129965a28d7f6aef33f5d2a6a26dec3e497d83e1bcda1766c6590a9
+  data.tar.gz: 18c62b811bb45a9ed586ed5e0ecff98aedd4d7704ec6dab4fad9b9a5ce73da4893bc8f5bc5f6af9ef8df34ae216fff1f2dcb835e4a504a310b8d6e84f9d59558

data/.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4.4
+          ruby-version: 3.4.5
           bundler-cache: true
 
       - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [3.22.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.22.0...3.22.1)
+
+- [84a1f4e422](https://github.com/algolia/api-clients-automation/commit/84a1f4e422) refactor(specs): add interface to manipulate query parameter between composition API & Search API ([#5123](https://github.com/algolia/api-clients-automation/pull/5123)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [995f185c07](https://github.com/algolia/api-clients-automation/commit/995f185c07) chore(deps): dependencies 2025-07-21 ([#5129](https://github.com/algolia/api-clients-automation/pull/5129)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [f25e156dde](https://github.com/algolia/api-clients-automation/commit/f25e156dde) fix(specs): value/price clarifications in the Insights API ([#5154](https://github.com/algolia/api-clients-automation/pull/5154)) by [@kai687](https://github.com/kai687/)
+
+## [3.22.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.21.1...3.22.0)
+
+- [a7a3c5fc95](https://github.com/algolia/api-clients-automation/commit/a7a3c5fc95) feat(specs): document runMetadata parameter ([#5087](https://github.com/algolia/api-clients-automation/pull/5087)) by [@DevinCodes](https://github.com/DevinCodes/)
+- [f3717177c5](https://github.com/algolia/api-clients-automation/commit/f3717177c5) fix(specs): `averageClickPosition` return type ([#5089](https://github.com/algolia/api-clients-automation/pull/5089)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.21.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.21.0...3.21.1)
 
 - [4c9416a9fe](https://github.com/algolia/api-clients-automation/commit/4c9416a9fe) fix(specs): update sourceRun docs ([#5057](https://github.com/algolia/api-clients-automation/pull/5057)) by [@DevinCodes](https://github.com/DevinCodes/)

data/Gemfile.lock

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

data/lib/algolia/api/ingestion_client.rb

@@ -2322,9 +2322,10 @@ module Algolia
     #   - deleteIndex
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
+    # @param run_task_payload [RunTaskPayload]
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def run_task_with_http_info(task_id, request_options = {})
+    def run_task_with_http_info(task_id, run_task_payload = nil, request_options = {})
       # verify the required parameter 'task_id' is set
       if @api_client.config.client_side_validation && task_id.nil?
         raise ArgumentError, "Parameter `task_id` is required when calling `run_task`."
@@ -2336,7 +2337,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
 
-      post_body = request_options[:debug_body]
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(run_task_payload)
 
       new_options = request_options.merge(
         :operation => :"IngestionClient.run_task",
@@ -2356,10 +2357,11 @@ module Algolia
     #   - deleteIndex
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
+    # @param run_task_payload [RunTaskPayload]
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [RunResponse]
-    def run_task(task_id, request_options = {})
-      response = run_task_with_http_info(task_id, request_options)
+    def run_task(task_id, run_task_payload = nil, request_options = {})
+      response = run_task_with_http_info(task_id, run_task_payload, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
     end
 
@@ -2371,9 +2373,10 @@ module Algolia
     #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
+    # @param run_task_payload [RunTaskPayload]
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def run_task_v1_with_http_info(task_id, request_options = {})
+    def run_task_v1_with_http_info(task_id, run_task_payload = nil, request_options = {})
       # verify the required parameter 'task_id' is set
       if @api_client.config.client_side_validation && task_id.nil?
         raise ArgumentError, "Parameter `task_id` is required when calling `run_task_v1`."
@@ -2385,7 +2388,7 @@ module Algolia
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
 
-      post_body = request_options[:debug_body]
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(run_task_payload)
 
       new_options = request_options.merge(
         :operation => :"IngestionClient.run_task_v1",
@@ -2405,10 +2408,11 @@ module Algolia
     #   - deleteIndex
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
+    # @param run_task_payload [RunTaskPayload]
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [RunResponse]
-    def run_task_v1(task_id, request_options = {})
-      response = run_task_v1_with_http_info(task_id, request_options)
+    def run_task_v1(task_id, run_task_payload = nil, request_options = {})
+      response = run_task_v1_with_http_info(task_id, run_task_payload, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
     end
 

data/lib/algolia/models/abtesting/variant.rb

@@ -98,7 +98,7 @@ module Algolia
         {
           :add_to_cart_count => :"Integer",
           :add_to_cart_rate => :"Float",
-          :average_click_position => :"Integer",
+          :average_click_position => :"Float",
           :click_count => :"Integer",
           :click_through_rate => :"Float",
           :conversion_count => :"Integer",

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

@@ -17,7 +17,7 @@ module Algolia
       # Page of search results to retrieve.
       attr_accessor :page
 
-      # Whether the search response should include detailed ranking information.
+      # Whether the run response should include detailed ranking information.
       attr_accessor :get_ranking_info
 
       attr_accessor :relevancy_strictness
@@ -49,22 +49,22 @@ module Algolia
       # Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
       attr_accessor :inside_polygon
 
-      # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**.  **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+      # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
       attr_accessor :query_languages
 
-      # ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):  - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+      # ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
       attr_accessor :natural_languages
 
-      # Whether to enable rules.
+      # Whether to enable composition rules.
       attr_accessor :enable_rules
 
-      # Assigns a rule context to the search query.  [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
+      # Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
       attr_accessor :rule_contexts
 
       # Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
       attr_accessor :user_token
 
-      # Whether to include a `queryID` attribute in the response.  The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+      # Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
       attr_accessor :click_analytics
 
       # Whether this search will be included in Analytics.
@@ -73,10 +73,10 @@ module Algolia
       # Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
       attr_accessor :analytics_tags
 
-      # Whether to enable A/B testing for this search.
+      # Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the A/B test is ignored.
       attr_accessor :enable_ab_test
 
-      # Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).  This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+      # Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
       attr_accessor :enable_re_ranking
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,13 +19,17 @@ module Algolia
 
       attr_accessor :entity_type
 
+      # Additional information that will be passed to the created runs.
+      attr_accessor :run_metadata
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :index_to_include => :indexToInclude,
           :index_to_exclude => :indexToExclude,
           :entity_ids => :entityIDs,
-          :entity_type => :entityType
+          :entity_type => :entityType,
+          :run_metadata => :runMetadata
         }
       end
 
@@ -35,7 +39,8 @@ module Algolia
           :index_to_include => :"Array<String>",
           :index_to_exclude => :"Array<String>",
           :entity_ids => :"Array<String>",
-          :entity_type => :"EntityType"
+          :entity_type => :"EntityType",
+          :run_metadata => :"Hash<String, Object>"
         }
       end
 
@@ -90,6 +95,12 @@ module Algolia
         if attributes.key?(:entity_type)
           self.entity_type = attributes[:entity_type]
         end
+
+        if attributes.key?(:run_metadata)
+          if (value = attributes[:run_metadata]).is_a?(Hash)
+            self.run_metadata = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -100,7 +111,8 @@ module Algolia
           index_to_include == other.index_to_include &&
           index_to_exclude == other.index_to_exclude &&
           entity_ids == other.entity_ids &&
-          entity_type == other.entity_type
+          entity_type == other.entity_type &&
+          run_metadata == other.run_metadata
       end
 
       # @see the `==` method
@@ -112,7 +124,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_to_include, index_to_exclude, entity_ids, entity_type].hash
+        [index_to_include, index_to_exclude, entity_ids, entity_type, run_metadata].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+# 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.
+
+require "date"
+require "time"
+
+module Algolia
+  module Ingestion
+    class RunTaskPayload
+      # Additional information that will be passed to the created run.
+      attr_accessor :run_metadata
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :run_metadata => :runMetadata
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :run_metadata => :"Hash<String, Object>"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          []
+        )
+      end
+
+      # Initializes the object
+      # @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::RunTaskPayload` 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::RunTaskPayload`. Please check the name to make sure it's valid. List of attributes: " +
+                self.class.attribute_map.keys.inspect
+            )
+          end
+
+          h[k.to_sym] = v
+        }
+
+        if attributes.key?(:run_metadata)
+          if (value = attributes[:run_metadata]).is_a?(Hash)
+            self.run_metadata = value
+          end
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if self.equal?(other)
+        self.class == other.class &&
+          run_metadata == other.run_metadata
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [run_metadata].hash
+      end
+
+      # Builds the object from hash
+      # @param [Hash] attributes Model attributes in the form of hash
+      # @return [Object] Returns the model itself
+      def self.build_from_hash(attributes)
+        return nil unless attributes.is_a?(Hash)
+        attributes = attributes.transform_keys(&:to_sym)
+        transformed_hash = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = nil
+          elsif type =~ /\AArray<(.*)>/i
+            # check to ensure the input is an array given that the attribute
+            # is documented as an array but the input is not
+            if attributes[attribute_map[key]].is_a?(Array)
+              transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
+                _deserialize(::Regexp.last_match(1), v)
+              }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+          # model
+        else
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::Ingestion.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
+            .build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      end
+
+      # Returns the object in the form of hash
+      # @return [Hash] Returns the object in the form of hash
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+
+        hash
+      end
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to?(:to_hash)
+          value.to_hash
+        else
+          value
+        end
+      end
+
+    end
+
+  end
+end

data/lib/algolia/models/insights/price.rb

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Insights
-    # Total price of a product, including any discounts, in units of `currency`.
+    # Final price of a single product, including any discounts, in units of `currency`.
     module Price
       class << self
       # List of class defined in oneOf (OpenAPI v3)

data/lib/algolia/models/insights/value.rb

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module Insights
-    # Total monetary value of this event in units of `currency`.
+    # Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
     module Value
       class << self
       # List of class defined in oneOf (OpenAPI v3)

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.21.1"
+  VERSION = "3.22.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.21.1
+  version: 3.22.1
 platform: ruby
 authors:
 - https://alg.li/support
@@ -359,6 +359,7 @@ files:
 - lib/algolia/models/ingestion/run_source_payload.rb
 - lib/algolia/models/ingestion/run_source_response.rb
 - lib/algolia/models/ingestion/run_status.rb
+- lib/algolia/models/ingestion/run_task_payload.rb
 - lib/algolia/models/ingestion/run_type.rb
 - lib/algolia/models/ingestion/schedule_trigger.rb
 - lib/algolia/models/ingestion/schedule_trigger_input.rb
@@ -773,7 +774,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []