algolia 3.0.0.alpha.12 → 3.0.0.alpha.13

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
+    # Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
     module RemoveStopWords
       class << self
         # List of class defined in oneOf (OpenAPI v3)

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

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Search
-    # Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+    # Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
     class RenderingContent
       attr_accessor :facet_ordering
 

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

@@ -7,21 +7,21 @@ module Algolia
   module Search
     # Rule object.
     class Rule
-      # Unique identifier for a rule object.
+      # Unique identifier of a rule object.
       attr_accessor :object_id
 
-      # [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
+      # Conditions that trigger a rule.  Some consequences require specific conditions or don't require any condition. For more information, see [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions).
       attr_accessor :conditions
 
       attr_accessor :consequence
 
-      # Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
+      # Description of the rule's purpose to help you distinguish between different rules.
       attr_accessor :description
 
-      # Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
+      # Whether the rule is active.
       attr_accessor :enabled
 
-      # If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
+      # Time periods when the rule is active.
       attr_accessor :validity
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -106,6 +106,24 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] conditions Value to be assigned
+      def conditions=(conditions)
+        if conditions.nil?
+          raise ArgumentError, 'conditions cannot be nil'
+        end
+
+        if conditions.length > 25
+          raise ArgumentError, 'invalid value for "conditions", number of items must be less than or equal to 25.'
+        end
+
+        if conditions.length < 0
+          raise ArgumentError, 'invalid value for "conditions", number of items must be greater than or equal to 0.'
+        end
+
+        @conditions = conditions
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Search
     class SaveObjectResponse
-      # Date of creation (ISO-8601 format).
+      # Timestamp when the record was added, in ISO 8601 format.
       attr_accessor :created_at
 
-      # 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 and this `taskID`.
+      # 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
 
-      # Unique object identifier.
+      # Unique record identifier.
       attr_accessor :object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Search
     class SaveSynonymResponse
-      # 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 and this `taskID`.
+      # 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 the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.

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

@@ -5,18 +5,18 @@ require 'time'
 
 module Algolia
   module Search
-    # `searchDictionaryEntries` parameters.
+    # Search parameter.
     class SearchDictionaryEntriesParams
-      # Text to search for in an index.
+      # Search query.
       attr_accessor :query
 
-      # Page to retrieve (the first page is `0`, not `1`).
+      # Page of search results to retrieve.
       attr_accessor :page
 
       # Number of hits per page.
       attr_accessor :hits_per_page
 
-      # [Supported language ISO code](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
+      # ISO code of a [supported language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).
       attr_accessor :language
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -85,6 +85,20 @@ module Algolia
         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)

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

@@ -0,0 +1,251 @@
+# 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 SearchDictionaryEntriesResponse
+      # Dictionary entries matching the search criteria.
+      attr_accessor :hits
+
+      # Requested page of the API response.
+      attr_accessor :page
+
+      # Number of results (hits).
+      attr_accessor :nb_hits
+
+      # Number of pages of results.
+      attr_accessor :nb_pages
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :hits => :hits,
+          :page => :page,
+          :nb_hits => :nbHits,
+          :nb_pages => :nbPages
+        }
+      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
+        {
+          :hits => :'Array<DictionaryEntry>',
+          :page => :Integer,
+          :nb_hits => :Integer,
+          :nb_pages => :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 = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::SearchDictionaryEntriesResponse` 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::SearchDictionaryEntriesResponse`. 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?(:hits)
+          if (value = attributes[:hits]).is_a?(Array)
+            self.hits = value
+          end
+        else
+          self.hits = nil
+        end
+
+        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
+      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
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          hits == other.hits &&
+          page == other.page &&
+          nb_hits == other.nb_hits &&
+          nb_pages == other.nb_pages
+      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
+        [hits, page, nb_hits, nb_pages].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::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_for_facet_values_request.rb

@@ -12,7 +12,7 @@ module Algolia
       # Text to search inside the facet's values.
       attr_accessor :facet_query
 
-      # Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
       attr_accessor :max_facet_hits
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,6 +6,7 @@ require 'time'
 module Algolia
   module Search
     class SearchForFacetValuesResponse
+      # Matching facet values.
       attr_accessor :facet_hits
 
       # See the `facetsCount` field of the `exhaustive` object in the response.