algolia 3.25.0 → 3.26.0

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

@@ -0,0 +1,219 @@
+# 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 Composition
+    class TimeRange
+      # When the rule should start to be active, in Unix epoch time.
+      attr_accessor :from
+
+      # When the rule should stop to be active, in Unix epoch time.
+      attr_accessor :_until
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :from => :from,
+          :_until => :until
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :from => :"Integer",
+          :_until => :"Integer"
+        }
+      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::TimeRange` 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::TimeRange`. 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?(:from)
+          self.from = attributes[:from]
+        end
+
+        if attributes.key?(:_until)
+          self._until = attributes[:_until]
+        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 &&
+          from == other.from &&
+          _until == other._until
+      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
+        [from, _until].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::Composition.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/composition/typo_tolerance.rb

@@ -0,0 +1,110 @@
+# 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 Composition
+    # Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
+    module TypoTolerance
+      class << self
+      # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :"Boolean",
+            :"TypoToleranceEnum"
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            begin
+              # "nullable: true"
+              next if klass == :AnyType
+              typed_data = find_and_cast_into_type(klass, data)
+              return typed_data if typed_data
+              # rescue all errors so we keep iterating even if the current item lookup raises
+            rescue
+            end
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when "Boolean"
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when "Float"
+            return data if data.instance_of?(Float)
+          when "Integer"
+            return data if data.instance_of?(Integer)
+          when "Time"
+            return Time.parse(data)
+          when "Date"
+            return Date.parse(data)
+          when "String"
+            return data if data.instance_of?(String)
+            # "type: object"
+          when "Object"
+            return data if data.instance_of?(Hash)
+            # "type: array"
+          when /\AArray<(?<sub_type>.+)>\z/
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+            # "type: object" with "additionalProperties: { ... }"
+          when /\AHash<String, (?<sub_type>.+)>\z/
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+            # model
+          else
+            const = Algolia::Composition.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of)
+                # nested oneOf model
+                model = const.build(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
+              else
+                # maybe it's an enum, or doens't have discriminators
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          # if no match by now, raise
+          raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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 Composition
+    class TypoToleranceEnum
+      MIN = "min".freeze
+      STRICT = "strict".freeze
+      TRUE = "true".freeze
+      FALSE = "false".freeze
+
+      def self.all_vars
+        @all_vars ||= [MIN, STRICT, TRUE, FALSE].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if TypoToleranceEnum.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #TypoToleranceEnum"
+      end
+    end
+  end
+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.25.0"
+  VERSION = "3.26.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.25.0
+  version: 3.26.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -257,6 +257,10 @@ files:
 - lib/algolia/models/analytics/top_searches_response.rb
 - lib/algolia/models/analytics/top_searches_response_with_analytics.rb
 - lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb
+- lib/algolia/models/composition/action.rb
+- lib/algolia/models/composition/advanced_syntax_features.rb
+- lib/algolia/models/composition/alternatives_as_exact.rb
+- lib/algolia/models/composition/anchoring.rb
 - lib/algolia/models/composition/around_precision.rb
 - lib/algolia/models/composition/around_radius.rb
 - lib/algolia/models/composition/around_radius_all.rb
@@ -264,51 +268,98 @@ files:
 - lib/algolia/models/composition/banner_image.rb
 - lib/algolia/models/composition/banner_image_url.rb
 - lib/algolia/models/composition/banner_link.rb
+- lib/algolia/models/composition/base_injection_query_parameters.rb
+- lib/algolia/models/composition/batch_composition_action.rb
+- lib/algolia/models/composition/batch_params.rb
+- lib/algolia/models/composition/boolean_string.rb
+- lib/algolia/models/composition/composition.rb
+- lib/algolia/models/composition/composition_behavior.rb
 - lib/algolia/models/composition/composition_id_ranking_info.rb
+- lib/algolia/models/composition/composition_rule.rb
+- lib/algolia/models/composition/composition_rule_consequence.rb
+- 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/delete_composition_action.rb
+- lib/algolia/models/composition/delete_composition_rule_action.rb
+- lib/algolia/models/composition/distinct.rb
 - 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
 - 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
 - lib/algolia/models/composition/hit.rb
 - 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/injected_item.rb
+- lib/algolia/models/composition/injected_item_hits_metadata.rb
+- lib/algolia/models/composition/injected_item_metadata.rb
+- lib/algolia/models/composition/injected_item_source.rb
+- lib/algolia/models/composition/injection.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/match_level.rb
 - lib/algolia/models/composition/matched_geo_location.rb
+- lib/algolia/models/composition/multiple_batch_request.rb
+- lib/algolia/models/composition/multiple_batch_response.rb
 - lib/algolia/models/composition/numeric_filters.rb
 - lib/algolia/models/composition/optional_filters.rb
+- lib/algolia/models/composition/optional_words.rb
 - lib/algolia/models/composition/params.rb
 - lib/algolia/models/composition/personalization.rb
+- lib/algolia/models/composition/query_type.rb
 - lib/algolia/models/composition/range.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
 - lib/algolia/models/composition/redirect_url.rb
+- lib/algolia/models/composition/remove_stop_words.rb
+- lib/algolia/models/composition/remove_words_if_no_results.rb
 - lib/algolia/models/composition/rendering_content.rb
 - lib/algolia/models/composition/request_body.rb
 - lib/algolia/models/composition/results_composition_info_response.rb
 - lib/algolia/models/composition/results_injected_item_applied_rules_info_response.rb
 - lib/algolia/models/composition/results_injected_item_info_response.rb
+- 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
 - lib/algolia/models/composition/search_for_facet_values_request.rb
 - lib/algolia/models/composition/search_for_facet_values_response.rb
 - 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
 - lib/algolia/models/composition/supported_language.rb
+- lib/algolia/models/composition/task_id_response.rb
+- lib/algolia/models/composition/task_status.rb
+- lib/algolia/models/composition/time_range.rb
+- lib/algolia/models/composition/typo_tolerance.rb
+- lib/algolia/models/composition/typo_tolerance_enum.rb
 - lib/algolia/models/composition/value.rb
 - lib/algolia/models/composition/widgets.rb
 - lib/algolia/models/ingestion/action.rb