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

data/lib/algolia/models/search/search_hits.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
@@ -34,22 +34,27 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :hits => :'Array<Hit>',
-          :query => :String,
-          :params => :String
+          :hits => :"Array<Hit>",
+          :query => :"String",
+          :params => :"String"
         }
       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::SearchHits` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::SearchHits` initialize method"
+          )
         end
 
         if attributes.key?(:hits)
@@ -80,8 +85,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 &&
           hits == other.hits &&
           query == other.query &&
@@ -105,7 +109,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|
@@ -115,7 +118,9 @@ 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]])
@@ -149,6 +154,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -163,10 +169,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
 
@@ -204,6 +212,7 @@ module Algolia
         self.additional_properties&.each_pair do |k, v|
           hash[k.to_sym] = _to_hash(v)
         end
+
         hash
       end
 
@@ -218,12 +227,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/search_method_params.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
@@ -48,32 +48,40 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :requests => :'Array<SearchQuery>',
-          :strategy => :SearchStrategy
+          :requests => :"Array<SearchQuery>",
+          :strategy => :"SearchStrategy"
         }
       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::SearchMethodParams` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::SearchMethodParams` 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::SearchMethodParams`. 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::SearchMethodParams`. 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?(:requests)
           if (value = attributes[:requests]).is_a?(Array)
@@ -91,8 +99,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 &&
           requests == other.requests &&
           strategy == other.strategy
@@ -115,7 +122,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|
@@ -125,12 +131,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
 
@@ -156,6 +165,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -170,10 +180,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
 
@@ -206,6 +218,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -220,12 +233,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/search_pagination.rb

@@ -0,0 +1,282 @@
+# 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
+    class SearchPagination
+      # Page of search results to retrieve.
+      attr_accessor :page
+
+      # Number of results (hits).
+      attr_accessor :nb_hits
+
+      # Number of pages of results.
+      attr_accessor :nb_pages
+
+      # Number of hits per page.
+      attr_accessor :hits_per_page
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :page => :page,
+          :nb_hits => :nbHits,
+          :nb_pages => :nbPages,
+          :hits_per_page => :hitsPerPage
+        }
+      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
+        {
+          :page => :"Integer",
+          :nb_hits => :"Integer",
+          :nb_pages => :"Integer",
+          :hits_per_page => :"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::SearchPagination` 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::SearchPagination`. 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?(:page)
+          self.page = attributes[:page]
+        else
+          self.page = nil
+        end
+
+        if attributes.key?(:nb_hits)
+          self.nb_hits = attributes[:nb_hits]
+        else
+          self.nb_hits = nil
+        end
+
+        if attributes.key?(:nb_pages)
+          self.nb_pages = attributes[:nb_pages]
+        else
+          self.nb_pages = nil
+        end
+
+        if attributes.key?(:hits_per_page)
+          self.hits_per_page = attributes[:hits_per_page]
+        else
+          self.hits_per_page = nil
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] page Value to be assigned
+      def page=(page)
+        if page.nil?
+          raise ArgumentError, "page cannot be nil"
+        end
+
+        if page < 0
+          raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
+        end
+
+        @page = page
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] hits_per_page Value to be assigned
+      def hits_per_page=(hits_per_page)
+        if hits_per_page.nil?
+          raise ArgumentError, "hits_per_page cannot be nil"
+        end
+
+        if hits_per_page > 1000
+          raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
+        end
+
+        if hits_per_page < 1
+          raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
+        end
+
+        @hits_per_page = hits_per_page
+      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 &&
+          page == other.page &&
+          nb_hits == other.nb_hits &&
+          nb_pages == other.nb_pages &&
+          hits_per_page == other.hits_per_page
+      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
+        [page, nb_hits, nb_pages, hits_per_page].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_params.rb

@@ -1,17 +1,17 @@
 # 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
     module SearchParams
       class << self
-        # List of class defined in oneOf (OpenAPI v3)
+      # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
-            :SearchParamsObject,
-            :SearchParamsString
+            :"SearchParamsObject",
+            :"SearchParamsString"
           ]
         end
 
@@ -27,11 +27,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
@@ -41,44 +44,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
 
@@ -86,11 +93,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