algolia 3.37.1 → 3.39.0

data/lib/algolia/models/search/search_extensions_query_categorization.rb

@@ -0,0 +1,218 @@
+# 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 Search
+    # Parameters for the [Query Categorization](https://www.algolia.com/doc/guides/algolia-ai/query-categorization/) AI feature.
+    class SearchExtensionsQueryCategorization
+      # Whether to retrieve category predictions in the response `extensions.queryCategorization` field.
+      attr_accessor :enable_categories_retrieval
+
+      # Whether to automatically apply category-based filters and boosts to search results.
+      attr_accessor :enable_auto_filtering
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :enable_categories_retrieval => :enableCategoriesRetrieval,
+          :enable_auto_filtering => :enableAutoFiltering
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :enable_categories_retrieval => :"Boolean",
+          :enable_auto_filtering => :"Boolean"
+        }
+      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::SearchExtensionsQueryCategorization` 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::SearchExtensionsQueryCategorization`. 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?(:enable_categories_retrieval)
+          self.enable_categories_retrieval = attributes[:enable_categories_retrieval]
+        end
+
+        if attributes.key?(:enable_auto_filtering)
+          self.enable_auto_filtering = attributes[:enable_auto_filtering]
+        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 &&
+          enable_categories_retrieval == other.enable_categories_retrieval &&
+          enable_auto_filtering == other.enable_auto_filtering
+      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
+        [enable_categories_retrieval, enable_auto_filtering].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::Search.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/search/search_for_hits.rb

@@ -216,6 +216,8 @@ module Algolia
 
       attr_accessor :type
 
+      attr_accessor :extensions
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -294,7 +296,8 @@ module Algolia
           :enable_re_ranking => :enableReRanking,
           :re_ranking_apply_filter => :reRankingApplyFilter,
           :index_name => :indexName,
-          :type => :type
+          :type => :type,
+          :extensions => :extensions
         }
       end
 
@@ -376,7 +379,8 @@ module Algolia
           :enable_re_ranking => :"Boolean",
           :re_ranking_apply_filter => :"ReRankingApplyFilter",
           :index_name => :"String",
-          :type => :"SearchTypeDefault"
+          :type => :"SearchTypeDefault",
+          :extensions => :"SearchExtensions"
         }
       end
 
@@ -758,6 +762,10 @@ module Algolia
         if attributes.key?(:type)
           self.type = attributes[:type]
         end
+
+        if attributes.key?(:extensions)
+          self.extensions = attributes[:extensions]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -840,7 +848,8 @@ module Algolia
           enable_re_ranking == other.enable_re_ranking &&
           re_ranking_apply_filter == other.re_ranking_apply_filter &&
           index_name == other.index_name &&
-          type == other.type
+          type == other.type &&
+          extensions == other.extensions
       end
 
       # @see the `==` method
@@ -928,7 +937,8 @@ module Algolia
           enable_re_ranking,
           re_ranking_apply_filter,
           index_name,
-          type
+          type,
+          extensions
         ].hash
       end
 

data/lib/algolia/models/search/search_response.rb

@@ -104,6 +104,8 @@ module Algolia
       # URL-encoded string of all search parameters.
       attr_accessor :params
 
+      attr_accessor :extensions
+
       attr_accessor :additional_properties
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -141,7 +143,8 @@ module Algolia
           :hits_per_page => :hitsPerPage,
           :hits => :hits,
           :query => :query,
-          :params => :params
+          :params => :params,
+          :extensions => :extensions
         }
       end
 
@@ -180,7 +183,8 @@ module Algolia
           :hits_per_page => :"Integer",
           :hits => :"Array<Hit>",
           :query => :"String",
-          :params => :"String"
+          :params => :"String",
+          :extensions => :"ResponseExtensions"
         }
       end
 
@@ -354,6 +358,10 @@ module Algolia
           self.params = attributes[:params]
         end
 
+        if attributes.key?(:extensions)
+          self.extensions = attributes[:extensions]
+        end
+
         # add extra attribute to additional_properties
         self.additional_properties ||= {}
         self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
@@ -396,7 +404,8 @@ module Algolia
           hits_per_page == other.hits_per_page &&
           hits == other.hits &&
           query == other.query &&
-          params == other.params
+          params == other.params &&
+          extensions == other.extensions
       end
 
       # @see the `==` method
@@ -441,7 +450,8 @@ module Algolia
           hits_per_page,
           hits,
           query,
-          params
+          params,
+          extensions
         ].hash
       end
 

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.37.1"
+  VERSION = "3.39.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.37.1
+  version: 3.39.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -280,8 +280,6 @@ files:
 - lib/algolia/models/composition/composition_rules_batch_params.rb
 - lib/algolia/models/composition/composition_run_applied_rules.rb
 - lib/algolia/models/composition/composition_run_search_response.rb
-- lib/algolia/models/composition/composition_source.rb
-- lib/algolia/models/composition/composition_source_search.rb
 - lib/algolia/models/composition/compositions_search_response.rb
 - lib/algolia/models/composition/condition.rb
 - lib/algolia/models/composition/dedup_positioning.rb
@@ -292,11 +290,9 @@ files:
 - lib/algolia/models/composition/error_base.rb
 - lib/algolia/models/composition/exact_on_single_word_query.rb
 - lib/algolia/models/composition/exhaustive.rb
-- lib/algolia/models/composition/external.rb
 - lib/algolia/models/composition/external_injected_item.rb
 - lib/algolia/models/composition/external_injection.rb
 - lib/algolia/models/composition/external_ordering.rb
-- lib/algolia/models/composition/external_source.rb
 - lib/algolia/models/composition/facet_filters.rb
 - lib/algolia/models/composition/facet_hits.rb
 - lib/algolia/models/composition/facet_ordering.rb
@@ -310,17 +306,28 @@ files:
 - 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_external.rb
+- lib/algolia/models/composition/injected_item_external_source.rb
 - lib/algolia/models/composition/injected_item_hits_metadata.rb
 - lib/algolia/models/composition/injected_item_metadata.rb
+- lib/algolia/models/composition/injected_item_recommend_source.rb
+- lib/algolia/models/composition/injected_item_search.rb
+- lib/algolia/models/composition/injected_item_search_source.rb
 - lib/algolia/models/composition/injected_item_source.rb
 - lib/algolia/models/composition/injection.rb
+- lib/algolia/models/composition/injection_injected_item.rb
+- lib/algolia/models/composition/injection_main.rb
+- lib/algolia/models/composition/injection_main_recommend_source.rb
+- lib/algolia/models/composition/injection_main_search_source.rb
+- lib/algolia/models/composition/injection_main_source.rb
 - lib/algolia/models/composition/inside_bounding_box.rb
 - lib/algolia/models/composition/list_compositions_response.rb
-- lib/algolia/models/composition/main.rb
 - lib/algolia/models/composition/main_injection_query_parameters.rb
+- lib/algolia/models/composition/main_recommend.rb
+- lib/algolia/models/composition/main_search.rb
 - lib/algolia/models/composition/match_level.rb
 - lib/algolia/models/composition/matched_geo_location.rb
+- lib/algolia/models/composition/model.rb
 - lib/algolia/models/composition/multifeed.rb
 - lib/algolia/models/composition/multiple_batch_request.rb
 - lib/algolia/models/composition/multiple_batch_response.rb
@@ -331,6 +338,7 @@ files:
 - lib/algolia/models/composition/personalization.rb
 - lib/algolia/models/composition/query_type.rb
 - lib/algolia/models/composition/range.rb
+- lib/algolia/models/composition/recommend.rb
 - lib/algolia/models/composition/redirect.rb
 - lib/algolia/models/composition/redirect_rule_index_data.rb
 - lib/algolia/models/composition/redirect_rule_index_metadata.rb
@@ -345,7 +353,6 @@ files:
 - lib/algolia/models/composition/rules_batch_composition_action.rb
 - lib/algolia/models/composition/rules_multiple_batch_request.rb
 - lib/algolia/models/composition/rules_multiple_batch_response.rb
-- lib/algolia/models/composition/search.rb
 - lib/algolia/models/composition/search_composition_rules_params.rb
 - lib/algolia/models/composition/search_composition_rules_response.rb
 - lib/algolia/models/composition/search_for_facet_values_params.rb
@@ -354,7 +361,6 @@ files:
 - lib/algolia/models/composition/search_for_facet_values_results.rb
 - lib/algolia/models/composition/search_response.rb
 - lib/algolia/models/composition/search_results_item.rb
-- lib/algolia/models/composition/search_source.rb
 - lib/algolia/models/composition/snippet_result.rb
 - lib/algolia/models/composition/snippet_result_option.rb
 - lib/algolia/models/composition/sort_remaining_by.rb
@@ -459,6 +465,7 @@ files:
 - lib/algolia/models/ingestion/shopify_market.rb
 - lib/algolia/models/ingestion/shopify_metafield.rb
 - lib/algolia/models/ingestion/source.rb
+- lib/algolia/models/ingestion/source_algolia_index.rb
 - lib/algolia/models/ingestion/source_big_commerce.rb
 - lib/algolia/models/ingestion/source_big_query.rb
 - lib/algolia/models/ingestion/source_commercetools.rb
@@ -474,6 +481,7 @@ files:
 - lib/algolia/models/ingestion/source_sort_keys.rb
 - lib/algolia/models/ingestion/source_type.rb
 - lib/algolia/models/ingestion/source_update.rb
+- lib/algolia/models/ingestion/source_update_algolia_index.rb
 - lib/algolia/models/ingestion/source_update_commercetools.rb
 - lib/algolia/models/ingestion/source_update_docker.rb
 - lib/algolia/models/ingestion/source_update_input.rb
@@ -677,6 +685,8 @@ files:
 - lib/algolia/models/search/around_radius_all.rb
 - lib/algolia/models/search/assign_user_id_params.rb
 - lib/algolia/models/search/attribute_to_update.rb
+- lib/algolia/models/search/auto_filtering_filter_entry.rb
+- lib/algolia/models/search/auto_filtering_result.rb
 - lib/algolia/models/search/automatic_facet_filter.rb
 - lib/algolia/models/search/automatic_facet_filters.rb
 - lib/algolia/models/search/banner.rb
@@ -697,6 +707,8 @@ files:
 - lib/algolia/models/search/built_in_operation.rb
 - lib/algolia/models/search/built_in_operation_type.rb
 - lib/algolia/models/search/built_in_operation_value.rb
+- lib/algolia/models/search/category_prediction.rb
+- lib/algolia/models/search/category_prediction_bin.rb
 - lib/algolia/models/search/condition.rb
 - lib/algolia/models/search/consequence.rb
 - lib/algolia/models/search/consequence_hide.rb
@@ -740,6 +752,7 @@ files:
 - lib/algolia/models/search/get_task_response.rb
 - lib/algolia/models/search/get_top_user_ids_response.rb
 - lib/algolia/models/search/has_pending_mappings_response.rb
+- lib/algolia/models/search/hierarchy_path_entry.rb
 - lib/algolia/models/search/highlight_result.rb
 - lib/algolia/models/search/highlight_result_option.rb
 - lib/algolia/models/search/hit.rb
@@ -768,6 +781,8 @@ files:
 - lib/algolia/models/search/promote.rb
 - lib/algolia/models/search/promote_object_id.rb
 - lib/algolia/models/search/promote_object_ids.rb
+- lib/algolia/models/search/query_categorization.rb
+- lib/algolia/models/search/query_categorization_type.rb
 - lib/algolia/models/search/query_type.rb
 - lib/algolia/models/search/range.rb
 - lib/algolia/models/search/ranking_info.rb
@@ -783,12 +798,15 @@ files:
 - lib/algolia/models/search/replace_all_objects_response.rb
 - lib/algolia/models/search/replace_all_objects_with_transformation_response.rb
 - lib/algolia/models/search/replace_source_response.rb
+- lib/algolia/models/search/response_extensions.rb
 - lib/algolia/models/search/rule.rb
 - lib/algolia/models/search/save_object_response.rb
 - lib/algolia/models/search/save_synonym_response.rb
 - lib/algolia/models/search/scope_type.rb
 - lib/algolia/models/search/search_dictionary_entries_params.rb
 - lib/algolia/models/search/search_dictionary_entries_response.rb
+- lib/algolia/models/search/search_extensions.rb
+- lib/algolia/models/search/search_extensions_query_categorization.rb
 - lib/algolia/models/search/search_for_facet_values_request.rb
 - lib/algolia/models/search/search_for_facet_values_response.rb
 - lib/algolia/models/search/search_for_facets.rb