algolia 3.0.0.alpha.16 → 3.0.0.alpha.18

data/lib/algolia/models/recommend/trending_facets.rb

@@ -0,0 +1,243 @@
+# 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 Recommend
+    class TrendingFacets
+      # Facet attribute for which to retrieve trending facet values.
+      attr_accessor :facet_name
+
+      attr_accessor :model
+
+      attr_accessor :fallback_parameters
+
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :facet_name => :facetName,
+          :model => :model,
+          :fallback_parameters => :fallbackParameters
+        }
+      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
+        {
+          :facet_name => :Object,
+          :model => :TrendingFacetsModel,
+          :fallback_parameters => :FallbackParams
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([
+                  :facet_name
+                ])
+      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::TrendingFacets` 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::TrendingFacets`. 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?(:facet_name)
+          self.facet_name = attributes[:facet_name]
+        else
+          self.facet_name = nil
+        end
+
+        if attributes.key?(:model)
+          self.model = attributes[:model]
+        else
+          self.model = nil
+        end
+
+        if attributes.key?(:fallback_parameters)
+          self.fallback_parameters = attributes[:fallback_parameters]
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          facet_name == other.facet_name &&
+          model == other.model &&
+          fallback_parameters == other.fallback_parameters
+      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
+        [facet_name, model, fallback_parameters].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::Recommend.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/trending_facets_query.rb

@@ -6,20 +6,24 @@ require 'time'
 module Algolia
   module Recommend
     class TrendingFacetsQuery
-      # Index name.
+      # Index name (case-sensitive).
       attr_accessor :index_name
 
-      # Recommendations with a confidence score lower than `threshold` won't appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+      # Minimum score a recommendation must have to be included in the response.
       attr_accessor :threshold
 
-      # Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+      # Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
       attr_accessor :max_recommendations
 
-      # Facet name for trending models.
+      attr_accessor :query_parameters
+
+      # Facet attribute for which to retrieve trending facet values.
       attr_accessor :facet_name
 
       attr_accessor :model
 
+      attr_accessor :fallback_parameters
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -48,8 +52,10 @@ module Algolia
           :index_name => :indexName,
           :threshold => :threshold,
           :max_recommendations => :maxRecommendations,
+          :query_parameters => :queryParameters,
           :facet_name => :facetName,
-          :model => :model
+          :model => :model,
+          :fallback_parameters => :fallbackParameters
         }
       end
 
@@ -62,10 +68,12 @@ module Algolia
       def self.types_mapping
         {
           :index_name => :String,
-          :threshold => :Integer,
+          :threshold => :Float,
           :max_recommendations => :Integer,
-          :facet_name => :String,
-          :model => :TrendingFacetsModel
+          :query_parameters => :SearchParams,
+          :facet_name => :Object,
+          :model => :TrendingFacetsModel,
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -78,7 +86,7 @@ module Algolia
       def self.openapi_all_of
         [
           :BaseRecommendRequest,
-          :BaseTrendingFacetsQuery
+          :TrendingFacets
         ]
       end
 
@@ -107,12 +115,18 @@ module Algolia
 
         if attributes.key?(:threshold)
           self.threshold = attributes[:threshold]
+        else
+          self.threshold = nil
         end
 
         if attributes.key?(:max_recommendations)
           self.max_recommendations = attributes[:max_recommendations]
         end
 
+        if attributes.key?(:query_parameters)
+          self.query_parameters = attributes[:query_parameters]
+        end
+
         if attributes.key?(:facet_name)
           self.facet_name = attributes[:facet_name]
         else
@@ -121,6 +135,12 @@ module Algolia
 
         if attributes.key?(:model)
           self.model = attributes[:model]
+        else
+          self.model = nil
+        end
+
+        if attributes.key?(:fallback_parameters)
+          self.fallback_parameters = attributes[:fallback_parameters]
         end
       end
 
@@ -142,6 +162,24 @@ module Algolia
         @threshold = threshold
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] max_recommendations Value to be assigned
+      def max_recommendations=(max_recommendations)
+        if max_recommendations.nil?
+          raise ArgumentError, 'max_recommendations cannot be nil'
+        end
+
+        if max_recommendations > 1000
+          raise ArgumentError, 'invalid value for "max_recommendations", must be smaller than or equal to 1000.'
+        end
+
+        if max_recommendations < 1
+          raise ArgumentError, 'invalid value for "max_recommendations", must be greater than or equal to 1.'
+        end
+
+        @max_recommendations = max_recommendations
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -151,8 +189,10 @@ module Algolia
           index_name == other.index_name &&
           threshold == other.threshold &&
           max_recommendations == other.max_recommendations &&
+          query_parameters == other.query_parameters &&
           facet_name == other.facet_name &&
-          model == other.model
+          model == other.model &&
+          fallback_parameters == other.fallback_parameters
       end
 
       # @see the `==` method
@@ -164,7 +204,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, threshold, max_recommendations, facet_name, model].hash
+        [index_name, threshold, max_recommendations, query_parameters, facet_name, model, fallback_parameters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{base_trending_items_query.rb → trending_items.rb}

@@ -5,17 +5,15 @@ require 'time'
 
 module Algolia
   module Recommend
-    class BaseTrendingItemsQuery
-      # Facet name for trending models.
+    class TrendingItems
+      # Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
       attr_accessor :facet_name
 
-      # Facet value for trending models.
+      # Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
       attr_accessor :facet_value
 
       attr_accessor :model
 
-      attr_accessor :query_parameters
-
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -46,7 +44,6 @@ module Algolia
           :facet_name => :facetName,
           :facet_value => :facetValue,
           :model => :model,
-          :query_parameters => :queryParameters,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -62,7 +59,6 @@ module Algolia
           :facet_name => :String,
           :facet_value => :String,
           :model => :TrendingItemsModel,
-          :query_parameters => :SearchParamsObject,
           :fallback_parameters => :SearchParamsObject
         }
       end
@@ -76,14 +72,14 @@ module Algolia
       # @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::BaseTrendingItemsQuery` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::TrendingItems` 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::BaseTrendingItemsQuery`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+                  "`#{k}` is not a valid attribute in `Algolia::TrendingItems`. 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
@@ -91,18 +87,20 @@ module Algolia
 
         if attributes.key?(:facet_name)
           self.facet_name = attributes[:facet_name]
+        else
+          self.facet_name = nil
         end
 
         if attributes.key?(:facet_value)
           self.facet_value = attributes[:facet_value]
+        else
+          self.facet_value = nil
         end
 
         if attributes.key?(:model)
           self.model = attributes[:model]
-        end
-
-        if attributes.key?(:query_parameters)
-          self.query_parameters = attributes[:query_parameters]
+        else
+          self.model = nil
         end
 
         if attributes.key?(:fallback_parameters)
@@ -119,7 +117,6 @@ module Algolia
           facet_name == other.facet_name &&
           facet_value == other.facet_value &&
           model == other.model &&
-          query_parameters == other.query_parameters &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -132,7 +129,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [facet_name, facet_value, model, query_parameters, fallback_parameters].hash
+        [facet_name, facet_value, model, fallback_parameters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/trending_items_query.rb

@@ -6,25 +6,25 @@ require 'time'
 module Algolia
   module Recommend
     class TrendingItemsQuery
-      # Index name.
+      # Index name (case-sensitive).
       attr_accessor :index_name
 
-      # Recommendations with a confidence score lower than `threshold` won't appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+      # Minimum score a recommendation must have to be included in the response.
       attr_accessor :threshold
 
-      # Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+      # Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
       attr_accessor :max_recommendations
 
-      # Facet name for trending models.
+      attr_accessor :query_parameters
+
+      # Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
       attr_accessor :facet_name
 
-      # Facet value for trending models.
+      # Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
       attr_accessor :facet_value
 
       attr_accessor :model
 
-      attr_accessor :query_parameters
-
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -55,10 +55,10 @@ module Algolia
           :index_name => :indexName,
           :threshold => :threshold,
           :max_recommendations => :maxRecommendations,
+          :query_parameters => :queryParameters,
           :facet_name => :facetName,
           :facet_value => :facetValue,
           :model => :model,
-          :query_parameters => :queryParameters,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -72,12 +72,12 @@ module Algolia
       def self.types_mapping
         {
           :index_name => :String,
-          :threshold => :Integer,
+          :threshold => :Float,
           :max_recommendations => :Integer,
+          :query_parameters => :SearchParams,
           :facet_name => :String,
           :facet_value => :String,
           :model => :TrendingItemsModel,
-          :query_parameters => :SearchParamsObject,
           :fallback_parameters => :SearchParamsObject
         }
       end
@@ -91,7 +91,7 @@ module Algolia
       def self.openapi_all_of
         [
           :BaseRecommendRequest,
-          :BaseTrendingItemsQuery
+          :TrendingItems
         ]
       end
 
@@ -120,26 +120,34 @@ module Algolia
 
         if attributes.key?(:threshold)
           self.threshold = attributes[:threshold]
+        else
+          self.threshold = nil
         end
 
         if attributes.key?(:max_recommendations)
           self.max_recommendations = attributes[:max_recommendations]
         end
 
+        if attributes.key?(:query_parameters)
+          self.query_parameters = attributes[:query_parameters]
+        end
+
         if attributes.key?(:facet_name)
           self.facet_name = attributes[:facet_name]
+        else
+          self.facet_name = nil
         end
 
         if attributes.key?(:facet_value)
           self.facet_value = attributes[:facet_value]
+        else
+          self.facet_value = nil
         end
 
         if attributes.key?(:model)
           self.model = attributes[:model]
-        end
-
-        if attributes.key?(:query_parameters)
-          self.query_parameters = attributes[:query_parameters]
+        else
+          self.model = nil
         end
 
         if attributes.key?(:fallback_parameters)
@@ -165,6 +173,24 @@ module Algolia
         @threshold = threshold
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] max_recommendations Value to be assigned
+      def max_recommendations=(max_recommendations)
+        if max_recommendations.nil?
+          raise ArgumentError, 'max_recommendations cannot be nil'
+        end
+
+        if max_recommendations > 1000
+          raise ArgumentError, 'invalid value for "max_recommendations", must be smaller than or equal to 1000.'
+        end
+
+        if max_recommendations < 1
+          raise ArgumentError, 'invalid value for "max_recommendations", must be greater than or equal to 1.'
+        end
+
+        @max_recommendations = max_recommendations
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -174,10 +200,10 @@ module Algolia
           index_name == other.index_name &&
           threshold == other.threshold &&
           max_recommendations == other.max_recommendations &&
+          query_parameters == other.query_parameters &&
           facet_name == other.facet_name &&
           facet_value == other.facet_value &&
           model == other.model &&
-          query_parameters == other.query_parameters &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -190,7 +216,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, threshold, max_recommendations, facet_name, facet_value, model, query_parameters, fallback_parameters].hash
+        [index_name, threshold, max_recommendations, query_parameters, facet_name, facet_value, model, fallback_parameters].hash
       end
 
       # Builds the object from hash

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

@@ -9,7 +9,7 @@ module Algolia
       # API key.
       attr_accessor :key
 
-      # Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+      # Date and time when the object was created, in RFC 3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -9,7 +9,7 @@ module Algolia
       # API key.
       attr_accessor :value
 
-      # Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
+      # Timestamp when the object was created, in milliseconds since the Unix epoch.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.