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

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

@@ -0,0 +1,319 @@
+# 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 BoughtTogetherQuery
+      # Index name (case-sensitive).
+      attr_accessor :index_name
+
+      # Minimum score a recommendation must have to be included in the response.
+      attr_accessor :threshold
+
+      # 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
+
+      attr_accessor :query_parameters
+
+      attr_accessor :model
+
+      # Unique record identifier.
+      attr_accessor :object_id
+
+      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
+        {
+          :index_name => :indexName,
+          :threshold => :threshold,
+          :max_recommendations => :maxRecommendations,
+          :query_parameters => :queryParameters,
+          :model => :model,
+          :object_id => :objectID
+        }
+      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
+        {
+          :index_name => :String,
+          :threshold => :Float,
+          :max_recommendations => :Integer,
+          :query_parameters => :SearchParams,
+          :model => :FbtModel,
+          :object_id => :String
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :BaseRecommendRequest,
+          :FrequentlyBoughtTogether
+        ]
+      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::BoughtTogetherQuery` 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::BoughtTogetherQuery`. 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_name)
+          self.index_name = attributes[:index_name]
+        else
+          self.index_name = nil
+        end
+
+        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?(:model)
+          self.model = attributes[:model]
+        else
+          self.model = nil
+        end
+
+        if attributes.key?(:object_id)
+          self.object_id = attributes[:object_id]
+        else
+          self.object_id = nil
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] threshold Value to be assigned
+      def threshold=(threshold)
+        if threshold.nil?
+          raise ArgumentError, 'threshold cannot be nil'
+        end
+
+        if threshold > 100
+          raise ArgumentError, 'invalid value for "threshold", must be smaller than or equal to 100.'
+        end
+
+        if threshold < 0
+          raise ArgumentError, 'invalid value for "threshold", must be greater than or equal to 0.'
+        end
+
+        @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)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          index_name == other.index_name &&
+          threshold == other.threshold &&
+          max_recommendations == other.max_recommendations &&
+          query_parameters == other.query_parameters &&
+          model == other.model &&
+          object_id == other.object_id
+      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
+        [index_name, threshold, max_recommendations, query_parameters, model, object_id].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/condition.rb

@@ -5,51 +5,19 @@ require 'time'
 
 module Algolia
   module Recommend
+    # Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
     class Condition
-      # Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
-      attr_accessor :pattern
-
-      attr_accessor :anchoring
-
-      # Whether the pattern should match plurals, synonyms, and typos.
-      attr_accessor :alternatives
+      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+      attr_accessor :filters
 
       # An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
       attr_accessor :context
 
-      # Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
-      attr_accessor :filters
-
-      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
         {
-          :pattern => :pattern,
-          :anchoring => :anchoring,
-          :alternatives => :alternatives,
-          :context => :context,
-          :filters => :filters
+          :filters => :filters,
+          :context => :context
         }
       end
 
@@ -61,11 +29,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :pattern => :String,
-          :anchoring => :Anchoring,
-          :alternatives => :Boolean,
-          :context => :String,
-          :filters => :String
+          :filters => :String,
+          :context => :String
         }
       end
 
@@ -91,25 +56,13 @@ module Algolia
           h[k.to_sym] = v
         end
 
-        if attributes.key?(:pattern)
-          self.pattern = attributes[:pattern]
-        end
-
-        if attributes.key?(:anchoring)
-          self.anchoring = attributes[:anchoring]
-        end
-
-        if attributes.key?(:alternatives)
-          self.alternatives = attributes[:alternatives]
+        if attributes.key?(:filters)
+          self.filters = attributes[:filters]
         end
 
         if attributes.key?(:context)
           self.context = attributes[:context]
         end
-
-        if attributes.key?(:filters)
-          self.filters = attributes[:filters]
-        end
       end
 
       # Custom attribute writer method with validation
@@ -133,11 +86,8 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          pattern == other.pattern &&
-          anchoring == other.anchoring &&
-          alternatives == other.alternatives &&
-          context == other.context &&
-          filters == other.filters
+          filters == other.filters &&
+          context == other.context
       end
 
       # @see the `==` method
@@ -149,7 +99,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [pattern, anchoring, alternatives, context, filters].hash
+        [filters, context].hash
       end
 
       # Builds the object from hash

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

@@ -5,30 +5,22 @@ require 'time'
 
 module Algolia
   module Recommend
-    # Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
+    # Effect of the rule.
     class Consequence
-      attr_accessor :params
+      # Exclude items from recommendations.
+      attr_accessor :hide
 
-      # Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
+      # Place items at specific positions in the list of recommendations.
       attr_accessor :promote
 
-      # Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won't be shown.
-      attr_accessor :filter_promotes
-
-      # Records you want to hide from the search results.
-      attr_accessor :hide
-
-      # A JSON object with custom data that will be appended to the `userData` array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.
-      attr_accessor :user_data
+      attr_accessor :params
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :params => :params,
-          :promote => :promote,
-          :filter_promotes => :filterPromotes,
           :hide => :hide,
-          :user_data => :userData
+          :promote => :promote,
+          :params => :params
         }
       end
 
@@ -40,19 +32,15 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :params => :ConsequenceParams,
-          :promote => :'Array<Promote>',
-          :filter_promotes => :Boolean,
-          :hide => :'Array<ConsequenceHide>',
-          :user_data => :Object
+          :hide => :'Array<HideConsequenceObject>',
+          :promote => :'Array<PromoteConsequenceObject>',
+          :params => :ParamsConsequence
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([
-                  :user_data
-                ])
+        Set.new([])
       end
 
       # Initializes the object
@@ -72,8 +60,10 @@ module Algolia
           h[k.to_sym] = v
         end
 
-        if attributes.key?(:params)
-          self.params = attributes[:params]
+        if attributes.key?(:hide)
+          if (value = attributes[:hide]).is_a?(Array)
+            self.hide = value
+          end
         end
 
         if attributes.key?(:promote)
@@ -82,19 +72,23 @@ module Algolia
           end
         end
 
-        if attributes.key?(:filter_promotes)
-          self.filter_promotes = attributes[:filter_promotes]
+        if attributes.key?(:params)
+          self.params = attributes[:params]
         end
+      end
 
-        if attributes.key?(:hide)
-          if (value = attributes[:hide]).is_a?(Array)
-            self.hide = value
-          end
+      # Custom attribute writer method with validation
+      # @param [Object] hide Value to be assigned
+      def hide=(hide)
+        if hide.nil?
+          raise ArgumentError, 'hide cannot be nil'
         end
 
-        if attributes.key?(:user_data)
-          self.user_data = attributes[:user_data]
+        if hide.length < 1
+          raise ArgumentError, 'invalid value for "hide", number of items must be greater than or equal to 1.'
         end
+
+        @hide = hide
       end
 
       # Custom attribute writer method with validation
@@ -104,38 +98,22 @@ module Algolia
           raise ArgumentError, 'promote cannot be nil'
         end
 
-        if promote.length > 300
-          raise ArgumentError, 'invalid value for "promote", number of items must be less than or equal to 300.'
+        if promote.length < 1
+          raise ArgumentError, 'invalid value for "promote", number of items must be greater than or equal to 1.'
         end
 
         @promote = promote
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] hide Value to be assigned
-      def hide=(hide)
-        if hide.nil?
-          raise ArgumentError, 'hide cannot be nil'
-        end
-
-        if hide.length > 50
-          raise ArgumentError, 'invalid value for "hide", number of items must be less than or equal to 50.'
-        end
-
-        @hide = hide
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
         return true if equal?(other)
 
         self.class == other.class &&
-          params == other.params &&
-          promote == other.promote &&
-          filter_promotes == other.filter_promotes &&
           hide == other.hide &&
-          user_data == other.user_data
+          promote == other.promote &&
+          params == other.params
       end
 
       # @see the `==` method
@@ -147,7 +125,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [params, promote, filter_promotes, hide, user_data].hash
+        [hide, promote, params].hash
       end
 
       # Builds the object from hash

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

@@ -10,7 +10,7 @@ module Algolia
       # Unique identifier of a task.  A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
       attr_accessor :task_id
 
-      # Timestamp of deletion in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+      # Date and time when the object was deleted, in RFC 3339 format.
       attr_accessor :deleted_at
 
       # Attribute mapping from ruby-style variable name to JSON key.