algolia 3.0.0.beta.6 → 3.0.0.beta.8

data/lib/algolia/models/query-suggestions/configuration_response.rb

@@ -0,0 +1,298 @@
+# 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 QuerySuggestions
+    # API response for retrieving Query Suggestions configurations.
+    class ConfigurationResponse
+      # Algolia application ID to which this Query Suggestions configuration belongs.
+      attr_accessor :app_id
+
+      # Name of the Query Suggestions index (case-sensitive).
+      attr_accessor :index_name
+
+      # Algolia indices from which to get the popular searches for query suggestions.
+      attr_accessor :source_indices
+
+      attr_accessor :languages
+
+      attr_accessor :exclude
+
+      # Whether to turn on personalized query suggestions.
+      attr_accessor :enable_personalization
+
+      # Whether to include suggestions with special characters.
+      attr_accessor :allow_special_characters
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :app_id => :appID,
+          :index_name => :indexName,
+          :source_indices => :sourceIndices,
+          :languages => :languages,
+          :exclude => :exclude,
+          :enable_personalization => :enablePersonalization,
+          :allow_special_characters => :allowSpecialCharacters
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :app_id => :String,
+          :index_name => :String,
+          :source_indices => :'Array<SourceIndex>',
+          :languages => :Languages,
+          :exclude => :'Array<String>',
+          :enable_personalization => :Boolean,
+          :allow_special_characters => :Boolean
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([
+                  :exclude
+                ])
+      end
+
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :AppID,
+          :ConfigurationWithIndex
+        ]
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ConfigurationResponse` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::ConfigurationResponse`. 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
+        end
+
+        if attributes.key?(:app_id)
+          self.app_id = attributes[:app_id]
+        else
+          self.app_id = nil
+        end
+
+        if attributes.key?(:index_name)
+          self.index_name = attributes[:index_name]
+        else
+          self.index_name = nil
+        end
+
+        if attributes.key?(:source_indices)
+          if (value = attributes[:source_indices]).is_a?(Array)
+            self.source_indices = value
+          end
+        else
+          self.source_indices = nil
+        end
+
+        if attributes.key?(:languages)
+          self.languages = attributes[:languages]
+        else
+          self.languages = nil
+        end
+
+        if attributes.key?(:exclude)
+          if (value = attributes[:exclude]).is_a?(Array)
+            self.exclude = value
+          end
+        else
+          self.exclude = nil
+        end
+
+        if attributes.key?(:enable_personalization)
+          self.enable_personalization = attributes[:enable_personalization]
+        else
+          self.enable_personalization = nil
+        end
+
+        if attributes.key?(:allow_special_characters)
+          self.allow_special_characters = attributes[:allow_special_characters]
+        else
+          self.allow_special_characters = nil
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] source_indices Value to be assigned
+      def source_indices=(source_indices)
+        if source_indices.nil?
+          raise ArgumentError, 'source_indices cannot be nil'
+        end
+
+        if source_indices.length < 1
+          raise ArgumentError, 'invalid value for "source_indices", number of items must be greater than or equal to 1.'
+        end
+
+        @source_indices = source_indices
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          app_id == other.app_id &&
+          index_name == other.index_name &&
+          source_indices == other.source_indices &&
+          languages == other.languages &&
+          exclude == other.exclude &&
+          enable_personalization == other.enable_personalization &&
+          allow_special_characters == other.allow_special_characters
+      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
+        [app_id, index_name, source_indices, languages, exclude, enable_personalization, allow_special_characters].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
+        else # model
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::QuerySuggestions.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/query-suggestions/configuration_with_index.rb

@@ -0,0 +1,277 @@
+# 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 QuerySuggestions
+    # Query Suggestions configuration.
+    class ConfigurationWithIndex
+      # Algolia indices from which to get the popular searches for query suggestions.
+      attr_accessor :source_indices
+
+      attr_accessor :languages
+
+      attr_accessor :exclude
+
+      # Whether to turn on personalized query suggestions.
+      attr_accessor :enable_personalization
+
+      # Whether to include suggestions with special characters.
+      attr_accessor :allow_special_characters
+
+      # Name of the Query Suggestions index (case-sensitive).
+      attr_accessor :index_name
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :source_indices => :sourceIndices,
+          :languages => :languages,
+          :exclude => :exclude,
+          :enable_personalization => :enablePersonalization,
+          :allow_special_characters => :allowSpecialCharacters,
+          :index_name => :indexName
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :source_indices => :'Array<SourceIndex>',
+          :languages => :Languages,
+          :exclude => :'Array<String>',
+          :enable_personalization => :Boolean,
+          :allow_special_characters => :Boolean,
+          :index_name => :String
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([
+                  :exclude
+                ])
+      end
+
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :Configuration
+        ]
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ConfigurationWithIndex` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::ConfigurationWithIndex`. 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
+        end
+
+        if attributes.key?(:source_indices)
+          if (value = attributes[:source_indices]).is_a?(Array)
+            self.source_indices = value
+          end
+        else
+          self.source_indices = nil
+        end
+
+        if attributes.key?(:languages)
+          self.languages = attributes[:languages]
+        end
+
+        if attributes.key?(:exclude)
+          if (value = attributes[:exclude]).is_a?(Array)
+            self.exclude = value
+          end
+        end
+
+        if attributes.key?(:enable_personalization)
+          self.enable_personalization = attributes[:enable_personalization]
+        end
+
+        if attributes.key?(:allow_special_characters)
+          self.allow_special_characters = attributes[:allow_special_characters]
+        end
+
+        if attributes.key?(:index_name)
+          self.index_name = attributes[:index_name]
+        else
+          self.index_name = nil
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] source_indices Value to be assigned
+      def source_indices=(source_indices)
+        if source_indices.nil?
+          raise ArgumentError, 'source_indices cannot be nil'
+        end
+
+        if source_indices.length < 1
+          raise ArgumentError, 'invalid value for "source_indices", number of items must be greater than or equal to 1.'
+        end
+
+        @source_indices = source_indices
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          source_indices == other.source_indices &&
+          languages == other.languages &&
+          exclude == other.exclude &&
+          enable_personalization == other.enable_personalization &&
+          allow_special_characters == other.allow_special_characters &&
+          index_name == other.index_name
+      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
+        [source_indices, languages, exclude, enable_personalization, allow_special_characters, index_name].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
+        else # model
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::QuerySuggestions.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/recommend/redirect.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Recommend
-    # [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/).
+    # [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
     class Redirect
       attr_accessor :index