algolia 3.0.0.beta.8 → 3.0.0.beta.9

data/lib/algolia/models/search/batch_request.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
@@ -49,32 +49,40 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :action => :Action,
-          :body => :Object
+          :action => :"Action",
+          :body => :"Object"
         }
       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::BatchRequest` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::BatchRequest` 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::BatchRequest`. 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::BatchRequest`. 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?(:action)
           self.action = attributes[:action]
@@ -92,8 +100,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 &&
           action == other.action &&
           body == other.body
@@ -116,7 +123,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|
@@ -126,12 +132,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
 
@@ -157,6 +166,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -171,10 +181,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
 
@@ -207,6 +219,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -221,12 +234,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/batch_response.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
@@ -28,32 +28,40 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :task_id => :Integer,
-          :object_ids => :'Array<String>'
+          :task_id => :"Integer",
+          :object_ids => :"Array<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::BatchResponse` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::BatchResponse` 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::BatchResponse`. 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::BatchResponse`. 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?(:task_id)
           self.task_id = attributes[:task_id]
@@ -73,8 +81,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 &&
           task_id == other.task_id &&
           object_ids == other.object_ids
@@ -97,7 +104,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|
@@ -107,12 +113,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
 
@@ -138,6 +147,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -152,10 +162,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
 
@@ -188,6 +200,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -202,12 +215,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/batch_write_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
@@ -24,31 +24,39 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :requests => :'Array<BatchRequest>'
+          :requests => :"Array<BatchRequest>"
         }
       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::BatchWriteParams` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::BatchWriteParams` 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::BatchWriteParams`. 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::BatchWriteParams`. 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)
@@ -62,8 +70,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
       end
@@ -85,7 +92,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|
@@ -95,12 +101,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
 
@@ -126,6 +135,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -140,10 +150,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
 
@@ -176,6 +188,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -190,12 +203,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/{ingestion/schedule_date_utils_input.rb → search/browse_pagination.rb}

@@ -1,22 +1,30 @@
 # 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 Ingestion
-    # Input for scheduled tasks whose source is of type `bigquery` and for which extracted data spans a fixed number of days.
-    class ScheduleDateUtilsInput
-      # Number of days in the past until the current day for which to extract Big Query data.
-      attr_accessor :timeframe
+  module Search
+    class BrowsePagination
+      # Page of search results to retrieve.
+      attr_accessor :page
 
-      attr_accessor :mapping
+      # 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
         {
-          :timeframe => :timeframe,
-          :mapping => :mapping
+          :page => :page,
+          :nb_hits => :nbHits,
+          :nb_pages => :nbPages,
+          :hits_per_page => :hitsPerPage
         }
       end
 
@@ -28,70 +36,101 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :timeframe => :Integer,
-          :mapping => :MappingInput
+          :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([])
+        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::ScheduleDateUtilsInput` initialize method"
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::BrowsePagination` 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::ScheduleDateUtilsInput`. 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::BrowsePagination`. 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]
         end
 
-        if attributes.key?(:timeframe)
-          self.timeframe = attributes[:timeframe]
-        else
-          self.timeframe = nil
+        if attributes.key?(:nb_hits)
+          self.nb_hits = attributes[:nb_hits]
+        end
+
+        if attributes.key?(:nb_pages)
+          self.nb_pages = attributes[:nb_pages]
+        end
+
+        if attributes.key?(:hits_per_page)
+          self.hits_per_page = attributes[:hits_per_page]
+        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 attributes.key?(:mapping)
-          self.mapping = attributes[:mapping]
+        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] timeframe Value to be assigned
-      def timeframe=(timeframe)
-        if timeframe.nil?
-          raise ArgumentError, 'timeframe cannot be nil'
+      # @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 timeframe > 30
-          raise ArgumentError, 'invalid value for "timeframe", must be smaller than or equal to 30.'
+        if hits_per_page > 1000
+          raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
         end
 
-        if timeframe < 1
-          raise ArgumentError, 'invalid value for "timeframe", must be greater than or equal to 1.'
+        if hits_per_page < 1
+          raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
         end
 
-        @timeframe = timeframe
+        @hits_per_page = hits_per_page
       end
 
       # 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 &&
-          timeframe == other.timeframe &&
-          mapping == other.mapping
+          page == other.page &&
+          nb_hits == other.nb_hits &&
+          nb_pages == other.nb_pages &&
+          hits_per_page == other.hits_per_page
       end
 
       # @see the `==` method
@@ -103,7 +142,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [timeframe, mapping].hash
+        [page, nb_hits, nb_pages, hits_per_page].hash
       end
 
       # Builds the object from hash
@@ -111,7 +150,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|
@@ -121,12 +159,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
 
@@ -152,6 +193,7 @@ module Algolia
           else
             false
           end
+
         when :Object
           # generic object (usually a Hash), return directly
           value
@@ -166,10 +208,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::Ingestion.const_get(type)
-          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+          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
 
@@ -202,6 +246,7 @@ module Algolia
 
           hash[param] = _to_hash(value)
         end
+
         hash
       end
 
@@ -216,12 +261,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