algolia 3.0.0.beta.7 → 3.0.0.beta.9

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

@@ -1,7 +1,7 @@
 # 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'
+require "date"
+require "time"
 
 module Algolia
   module Search
@@ -71,43 +71,51 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :filters => :Integer,
-          :first_matched_word => :Integer,
-          :geo_distance => :Integer,
-          :geo_precision => :Integer,
-          :matched_geo_location => :MatchedGeoLocation,
-          :personalization => :Personalization,
-          :nb_exact_words => :Integer,
-          :nb_typos => :Integer,
-          :promoted => :Boolean,
-          :proximity_distance => :Integer,
-          :user_score => :Integer,
-          :words => :Integer,
-          :promoted_by_re_ranking => :Boolean
+          :filters => :"Integer",
+          :first_matched_word => :"Integer",
+          :geo_distance => :"Integer",
+          :geo_precision => :"Integer",
+          :matched_geo_location => :"MatchedGeoLocation",
+          :personalization => :"Personalization",
+          :nb_exact_words => :"Integer",
+          :nb_typos => :"Integer",
+          :promoted => :"Boolean",
+          :proximity_distance => :"Integer",
+          :user_score => :"Integer",
+          :words => :"Integer",
+          :promoted_by_re_ranking => :"Boolean"
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new(
+          []
+        )
       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::RankingInfo` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::RankingInfo` 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::RankingInfo`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        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::RankingInfo`. 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?(:filters)
           self.filters = attributes[:filters]
@@ -176,11 +184,11 @@ module Algolia
       # @param [Object] filters Value to be assigned
       def filters=(filters)
         if filters.nil?
-          raise ArgumentError, 'filters cannot be nil'
+          raise ArgumentError, "filters cannot be nil"
         end
 
         if filters < 0
-          raise ArgumentError, 'invalid value for "filters", must be greater than or equal to 0.'
+          raise ArgumentError, "invalid value for \"filters\", must be greater than or equal to 0."
         end
 
         @filters = filters
@@ -190,11 +198,11 @@ module Algolia
       # @param [Object] first_matched_word Value to be assigned
       def first_matched_word=(first_matched_word)
         if first_matched_word.nil?
-          raise ArgumentError, 'first_matched_word cannot be nil'
+          raise ArgumentError, "first_matched_word cannot be nil"
         end
 
         if first_matched_word < 0
-          raise ArgumentError, 'invalid value for "first_matched_word", must be greater than or equal to 0.'
+          raise ArgumentError, "invalid value for \"first_matched_word\", must be greater than or equal to 0."
         end
 
         @first_matched_word = first_matched_word
@@ -204,11 +212,11 @@ module Algolia
       # @param [Object] geo_distance Value to be assigned
       def geo_distance=(geo_distance)
         if geo_distance.nil?
-          raise ArgumentError, 'geo_distance cannot be nil'
+          raise ArgumentError, "geo_distance cannot be nil"
         end
 
         if geo_distance < 0
-          raise ArgumentError, 'invalid value for "geo_distance", must be greater than or equal to 0.'
+          raise ArgumentError, "invalid value for \"geo_distance\", must be greater than or equal to 0."
         end
 
         @geo_distance = geo_distance
@@ -218,11 +226,11 @@ module Algolia
       # @param [Object] geo_precision Value to be assigned
       def geo_precision=(geo_precision)
         if geo_precision.nil?
-          raise ArgumentError, 'geo_precision cannot be nil'
+          raise ArgumentError, "geo_precision cannot be nil"
         end
 
         if geo_precision < 1
-          raise ArgumentError, 'invalid value for "geo_precision", must be greater than or equal to 1.'
+          raise ArgumentError, "invalid value for \"geo_precision\", must be greater than or equal to 1."
         end
 
         @geo_precision = geo_precision
@@ -232,11 +240,11 @@ module Algolia
       # @param [Object] nb_exact_words Value to be assigned
       def nb_exact_words=(nb_exact_words)
         if nb_exact_words.nil?
-          raise ArgumentError, 'nb_exact_words cannot be nil'
+          raise ArgumentError, "nb_exact_words cannot be nil"
         end
 
         if nb_exact_words < 0
-          raise ArgumentError, 'invalid value for "nb_exact_words", must be greater than or equal to 0.'
+          raise ArgumentError, "invalid value for \"nb_exact_words\", must be greater than or equal to 0."
         end
 
         @nb_exact_words = nb_exact_words
@@ -246,11 +254,11 @@ module Algolia
       # @param [Object] nb_typos Value to be assigned
       def nb_typos=(nb_typos)
         if nb_typos.nil?
-          raise ArgumentError, 'nb_typos cannot be nil'
+          raise ArgumentError, "nb_typos cannot be nil"
         end
 
         if nb_typos < 0
-          raise ArgumentError, 'invalid value for "nb_typos", must be greater than or equal to 0.'
+          raise ArgumentError, "invalid value for \"nb_typos\", must be greater than or equal to 0."
         end
 
         @nb_typos = nb_typos
@@ -260,11 +268,11 @@ module Algolia
       # @param [Object] proximity_distance Value to be assigned
       def proximity_distance=(proximity_distance)
         if proximity_distance.nil?
-          raise ArgumentError, 'proximity_distance cannot be nil'
+          raise ArgumentError, "proximity_distance cannot be nil"
         end
 
         if proximity_distance < 0
-          raise ArgumentError, 'invalid value for "proximity_distance", must be greater than or equal to 0.'
+          raise ArgumentError, "invalid value for \"proximity_distance\", must be greater than or equal to 0."
         end
 
         @proximity_distance = proximity_distance
@@ -274,11 +282,11 @@ module Algolia
       # @param [Object] words Value to be assigned
       def words=(words)
         if words.nil?
-          raise ArgumentError, 'words cannot be nil'
+          raise ArgumentError, "words cannot be nil"
         end
 
         if words < 1
-          raise ArgumentError, 'invalid value for "words", must be greater than or equal to 1.'
+          raise ArgumentError, "invalid value for \"words\", must be greater than or equal to 1."
         end
 
         @words = words
@@ -287,8 +295,7 @@ module Algolia
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
-        return true if equal?(other)
-
+        return true if self.equal?(other)
         self.class == other.class &&
           filters == other.filters &&
           first_matched_word == other.first_matched_word &&
@@ -314,8 +321,21 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [filters, first_matched_word, geo_distance, geo_precision, matched_geo_location, personalization, nb_exact_words, nb_typos, promoted, proximity_distance, user_score, words,
-         promoted_by_re_ranking].hash
+        [
+          filters,
+          first_matched_word,
+          geo_distance,
+          geo_precision,
+          matched_geo_location,
+          personalization,
+          nb_exact_words,
+          nb_typos,
+          promoted,
+          proximity_distance,
+          user_score,
+          words,
+          promoted_by_re_ranking
+        ].hash
       end
 
       # Builds the object from hash
@@ -323,7 +343,6 @@ module Algolia
       # @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|
@@ -333,12 +352,15 @@ module Algolia
             # 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) }
+              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
 
@@ -364,6 +386,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -378,10 +401,12 @@ module Algolia
               hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
             end
           end
-        else # model
+          # 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)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
+            .build_from_hash(value)
         end
       end
 
@@ -414,6 +439,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -428,12 +454,14 @@ module Algolia
           {}.tap do |hash|
             value.each { |k, v| hash[k] = _to_hash(v) }
           end
-        elsif value.respond_to? :to_hash
+        elsif value.respond_to?(:to_hash)
           value.to_hash
         else
           value
         end
       end
+
     end
+
   end
 end

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

@@ -1,18 +1,18 @@
 # 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'
+require "date"
+require "time"
 
 module Algolia
   module Search
     # Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
     module ReRankingApplyFilter
       class << self
-        # List of class defined in oneOf (OpenAPI v3)
+      # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
-            :'Array<ReRankingApplyFilter>',
-            :String
+            :"Array<ReRankingApplyFilter>",
+            :"String"
           ]
         end
 
@@ -28,11 +28,14 @@ module Algolia
           # - TODO: scalar values are de facto behaving as if they were nullable.
           # - TODO: logging when debugging is set.
           openapi_one_of.each do |klass|
-            next if klass == :AnyType # "nullable: true"
-
-            typed_data = find_and_cast_into_type(klass, data)
-            return typed_data if typed_data
-          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+            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
@@ -42,44 +45,48 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # NOTE: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
           case klass.to_s
-          when 'Boolean'
+          when "Boolean"
             return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
-          when 'Float'
+          when "Float"
             return data if data.instance_of?(Float)
-          when 'Integer'
+          when "Integer"
             return data if data.instance_of?(Integer)
-          when 'Time'
+          when "Time"
             return Time.parse(data)
-          when 'Date'
+          when "Date"
             return Date.parse(data)
-          when 'String'
+          when "String"
             return data if data.instance_of?(String)
-          when 'Object' # "type: object"
+            # "type: object"
+          when "Object"
             return data if data.instance_of?(Hash)
-          when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+            # "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
-          when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+            # "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
-          else # model
+            # model
+          else
             const = Algolia::Search.const_get(klass)
             if const
-              if const.respond_to?(:openapi_one_of) # nested oneOf model
+              # nested oneOf model
+              if const.respond_to?(:openapi_one_of)
                 model = const.build(data)
               else
                 # raise if data contains keys that are not known to the model
                 raise unless (data.keys - const.acceptable_attributes).empty?
-
                 model = const.build_from_hash(data)
               end
 
@@ -87,11 +94,13 @@ module Algolia
             end
           end
 
-          raise # if no match by now, raise
+          # 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/search/redirect.rb

@@ -1,11 +1,11 @@
 # 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'
+require "date"
+require "time"
 
 module Algolia
   module Search
-    # [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
 
@@ -24,31 +24,36 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :index => :'Array<RedirectRuleIndexMetadata>'
+          :index => :"Array<RedirectRuleIndexMetadata>"
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new(
+          []
+        )
       end
 
       # Initializes the object
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
-        unless attributes.is_a?(Hash)
+        if (!attributes.is_a?(Hash))
           raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Redirect` 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::Redirect`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        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::Redirect`. 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?(:index)
           if (value = attributes[:index]).is_a?(Array)
@@ -60,8 +65,7 @@ module Algolia
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
-        return true if equal?(other)
-
+        return true if self.equal?(other)
         self.class == other.class &&
           index == other.index
       end
@@ -83,7 +87,6 @@ module Algolia
       # @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|
@@ -93,12 +96,15 @@ module Algolia
             # 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) }
+              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
 
@@ -124,6 +130,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -138,10 +145,12 @@ module Algolia
               hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
             end
           end
-        else # model
+          # 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)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
+            .build_from_hash(value)
         end
       end
 
@@ -174,6 +183,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -188,12 +198,14 @@ module Algolia
           {}.tap do |hash|
             value.each { |k, v| hash[k] = _to_hash(v) }
           end
-        elsif value.respond_to? :to_hash
+        elsif value.respond_to?(:to_hash)
           value.to_hash
         else
           value
         end
       end
+
     end
+
   end
 end