algolia 3.0.0.alpha.15 → 3.0.0.alpha.17

data/lib/algolia/models/monitoring/{get_inventory403_response.rb → get_servers403_response.rb}

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Monitoring
-    class GetInventory403Response
+    class GetServers403Response
       attr_accessor :reason
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -36,14 +36,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::GetInventory403Response` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::GetServers403Response` 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::GetInventory403Response`. 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::GetServers403Response`. 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

data/lib/algolia/models/monitoring/incidents_inner.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Monitoring
     class IncidentsInner
-      # Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+      # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
       attr_accessor :v

data/lib/algolia/models/monitoring/probes_metric.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Monitoring
     class ProbesMetric
-      # Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+      # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
       # Value of the metric.

data/lib/algolia/models/monitoring/server.rb

@@ -11,10 +11,10 @@ module Algolia
 
       attr_accessor :region
 
-      # Included to support legacy applications. Do not rely on this attribute being present in the response. Use `is_replica` instead.
+      # Included to support legacy applications. Use `is_replica` instead.
       attr_accessor :is_slave
 
-      # Indicates whether this server is a replica of another server.
+      # Whether this server is a replica of another server.
       attr_accessor :is_replica
 
       # Name of the cluster to which this server belongs.

data/lib/algolia/models/monitoring/time_inner.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Monitoring
     class TimeInner
-      # Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+      # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
       # Time in ms.

data/lib/algolia/models/query-suggestions/app_id.rb

@@ -0,0 +1,197 @@
+# 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 QuerySuggestions
+    class AppID
+      # Algolia application ID to which this Query Suggestions configuration belongs.
+      attr_accessor :app_id
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :app_id => :appID
+        }
+      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
+        {
+          :app_id => :String
+        }
+      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::AppID` 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::AppID`. 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?(:app_id)
+          self.app_id = attributes[:app_id]
+        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 &&
+          app_id == other.app_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
+        [app_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::QuerySuggestions.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/query-suggestions/get_config_status200_response.rb

@@ -6,16 +6,16 @@ require 'time'
 module Algolia
   module QuerySuggestions
     class GetConfigStatus200Response
-      # Query Suggestions index name.
+      # Name of the Query Suggestions index.
       attr_accessor :index_name
 
-      # Indicates whether the creation or update of the Query Suggestions is in progress.
+      # Whether the creation or update of the Query Suggestions index is in progress.
       attr_accessor :is_running
 
-      # Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last built.
+      # Date and time when the Query Suggestions index was last built, in RFC 3339 format.
       attr_accessor :last_built_at
 
-      # Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format when the Query Suggestions index was last updated successfully.
+      # Date and time when the Query Suggestions index was last updated successfully.
       attr_accessor :last_successful_built_at
 
       # Duration of the last successful build in seconds.

data/lib/algolia/models/query-suggestions/get_log_file200_response.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module QuerySuggestions
     class GetLogFile200Response
-      # Timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
+      # Date and time of the log entry, in RFC 3339 format.
       attr_accessor :timestamp
 
       attr_accessor :level
@@ -14,7 +14,7 @@ module Algolia
       # Details about this log entry.
       attr_accessor :message
 
-      # Level indicating the position of a suggestion in a hierarchy of records.   For example, a `contextLevel` of 1 indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
+      # Level indicating the position of a suggestion in a hierarchy of records.  For example, a `contextLevel` of 1 indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
       attr_accessor :context_level
 
       class EnumAttributeValidator

data/lib/algolia/models/query-suggestions/languages.rb

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module QuerySuggestions
-    # Set the language for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
+    # Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
     module Languages
       class << self
         # List of class defined in oneOf (OpenAPI v3)

data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb

@@ -12,13 +12,12 @@ module Algolia
 
       attr_accessor :languages
 
-      # Patterns to exclude from query suggestions.
       attr_accessor :exclude
 
-      # Turn on personalized query suggestions.
+      # Whether to turn on personalized query suggestions.
       attr_accessor :enable_personalization
 
-      # Allow suggestions with special characters.
+      # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb

@@ -5,17 +5,12 @@ require 'time'
 
 module Algolia
   module QuerySuggestions
+    # API response for retrieving Query Suggestions configurations.
     class QuerySuggestionsConfigurationResponse
-      # API key used to read from your source index.
-      attr_accessor :source_indices_api_key
+      # Algolia application ID to which this Query Suggestions configuration belongs.
+      attr_accessor :app_id
 
-      # API key used to write and configure your Query Suggestions index.
-      attr_accessor :suggestions_indices_api_key
-
-      # API key used to read from external Algolia indices.
-      attr_accessor :external_indices_api_key
-
-      # Query Suggestions index name.
+      # Name of the Query Suggestions index.
       attr_accessor :index_name
 
       # Algolia indices from which to get the popular searches for query suggestions.
@@ -23,21 +18,18 @@ module Algolia
 
       attr_accessor :languages
 
-      # Patterns to exclude from query suggestions.
       attr_accessor :exclude
 
-      # Turn on personalized query suggestions.
+      # Whether to turn on personalized query suggestions.
       attr_accessor :enable_personalization
 
-      # Allow suggestions with special characters.
+      # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :source_indices_api_key => :sourceIndicesAPIKey,
-          :suggestions_indices_api_key => :suggestionsIndicesAPIKey,
-          :external_indices_api_key => :externalIndicesAPIKey,
+          :app_id => :appID,
           :index_name => :indexName,
           :source_indices => :sourceIndices,
           :languages => :languages,
@@ -55,9 +47,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :source_indices_api_key => :String,
-          :suggestions_indices_api_key => :String,
-          :external_indices_api_key => :String,
+          :app_id => :String,
           :index_name => :String,
           :source_indices => :'Array<SourceIndex>',
           :languages => :Languages,
@@ -77,7 +67,7 @@ module Algolia
       # List of class defined in allOf (OpenAPI v3)
       def self.openapi_all_of
         [
-          :BaseQuerySuggestionsConfigurationResponse,
+          :AppID,
           :QuerySuggestionsConfigurationWithIndex
         ]
       end
@@ -99,16 +89,10 @@ module Algolia
           h[k.to_sym] = v
         end
 
-        if attributes.key?(:source_indices_api_key)
-          self.source_indices_api_key = attributes[:source_indices_api_key]
-        end
-
-        if attributes.key?(:suggestions_indices_api_key)
-          self.suggestions_indices_api_key = attributes[:suggestions_indices_api_key]
-        end
-
-        if attributes.key?(:external_indices_api_key)
-          self.external_indices_api_key = attributes[:external_indices_api_key]
+        if attributes.key?(:app_id)
+          self.app_id = attributes[:app_id]
+        else
+          self.app_id = nil
         end
 
         if attributes.key?(:index_name)
@@ -127,20 +111,28 @@ module Algolia
 
         if attributes.key?(:languages)
           self.languages = attributes[:languages]
+        else
+          self.languages = nil
         end
 
         if attributes.key?(:exclude)
           if (value = attributes[:exclude]).is_a?(Array)
             self.exclude = value
           end
+        else
+          self.exclude = nil
         end
 
         if attributes.key?(:enable_personalization)
           self.enable_personalization = attributes[:enable_personalization]
+        else
+          self.enable_personalization = nil
         end
 
         if attributes.key?(:allow_special_characters)
           self.allow_special_characters = attributes[:allow_special_characters]
+        else
+          self.allow_special_characters = nil
         end
       end
 
@@ -164,9 +156,7 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          source_indices_api_key == other.source_indices_api_key &&
-          suggestions_indices_api_key == other.suggestions_indices_api_key &&
-          external_indices_api_key == other.external_indices_api_key &&
+          app_id == other.app_id &&
           index_name == other.index_name &&
           source_indices == other.source_indices &&
           languages == other.languages &&
@@ -184,8 +174,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [source_indices_api_key, suggestions_indices_api_key, external_indices_api_key, index_name, source_indices, languages, exclude, enable_personalization,
-         allow_special_characters].hash
+        [app_id, index_name, source_indices, languages, exclude, enable_personalization, allow_special_characters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb

@@ -7,32 +7,31 @@ module Algolia
   module QuerySuggestions
     # Query Suggestions configuration.
     class QuerySuggestionsConfigurationWithIndex
-      # Query Suggestions index name.
-      attr_accessor :index_name
-
       # Algolia indices from which to get the popular searches for query suggestions.
       attr_accessor :source_indices
 
       attr_accessor :languages
 
-      # Patterns to exclude from query suggestions.
       attr_accessor :exclude
 
-      # Turn on personalized query suggestions.
+      # Whether to turn on personalized query suggestions.
       attr_accessor :enable_personalization
 
-      # Allow suggestions with special characters.
+      # Whether to include suggestions with special characters.
       attr_accessor :allow_special_characters
 
+      # Name of the Query Suggestions index.
+      attr_accessor :index_name
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :index_name => :indexName,
           :source_indices => :sourceIndices,
           :languages => :languages,
           :exclude => :exclude,
           :enable_personalization => :enablePersonalization,
-          :allow_special_characters => :allowSpecialCharacters
+          :allow_special_characters => :allowSpecialCharacters,
+          :index_name => :indexName
         }
       end
 
@@ -44,12 +43,12 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :index_name => :String,
           :source_indices => :'Array<SourceIndex>',
           :languages => :Languages,
           :exclude => :'Array<String>',
           :enable_personalization => :Boolean,
-          :allow_special_characters => :Boolean
+          :allow_special_characters => :Boolean,
+          :index_name => :String
         }
       end
 
@@ -63,7 +62,6 @@ module Algolia
       # List of class defined in allOf (OpenAPI v3)
       def self.openapi_all_of
         [
-          :BaseQuerySuggestionsConfigurationWithIndex,
           :QuerySuggestionsConfiguration
         ]
       end
@@ -85,12 +83,6 @@ module Algolia
           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?(:source_indices)
           if (value = attributes[:source_indices]).is_a?(Array)
             self.source_indices = value
@@ -116,6 +108,12 @@ module Algolia
         if attributes.key?(:allow_special_characters)
           self.allow_special_characters = attributes[:allow_special_characters]
         end
+
+        if attributes.key?(:index_name)
+          self.index_name = attributes[:index_name]
+        else
+          self.index_name = nil
+        end
       end
 
       # Custom attribute writer method with validation
@@ -138,12 +136,12 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          index_name == other.index_name &&
           source_indices == other.source_indices &&
           languages == other.languages &&
           exclude == other.exclude &&
           enable_personalization == other.enable_personalization &&
-          allow_special_characters == other.allow_special_characters
+          allow_special_characters == other.allow_special_characters &&
+          index_name == other.index_name
       end
 
       # @see the `==` method
@@ -155,7 +153,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, source_indices, languages, exclude, enable_personalization, allow_special_characters].hash
+        [source_indices, languages, exclude, enable_personalization, allow_special_characters, index_name].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/query-suggestions/source_index.rb

@@ -10,16 +10,14 @@ module Algolia
       # Name of the Algolia index to use as source for query suggestions.
       attr_accessor :index_name
 
-      # If true, Query Suggestions uses all replicas of the primary index to find popular searches. If false, only the primary index is used.
+      # If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used.
       attr_accessor :replicas
 
-      # [Analytics tags](https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/) for filtering the popular searches.
       attr_accessor :analytics_tags
 
-      # Facets to use as top categories with your suggestions.  If provided, Query Suggestions adds the top facet values to each suggestion.
       attr_accessor :facets
 
-      # Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` hits to be included in the Query Suggestions index.
+      # Minimum number of hits required to be included as a suggestion.  A search query must at least generate `minHits` search results to be included in the Query Suggestions index.
       attr_accessor :min_hits
 
       # Minimum letters required to be included as a suggestion.  A search query must be at least `minLetters` long to be included in the Query Suggestions index.
@@ -27,7 +25,6 @@ module Algolia
 
       attr_accessor :generate
 
-      # Algolia indices with popular searches to use as query suggestions.  Records of these indices must have these attributes:    - `query`: search query which will be added as a suggestion   - `count`: measure of popularity of that search query  For example, you can export popular searches from an external analytics tool, such as Google Analytics or Adobe Analytics, and feed this data into an external Algolia index. You can use this external index to generate query suggestions until your Algolia analytics has collected enough data.
       attr_accessor :external
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -68,6 +65,7 @@ module Algolia
         Set.new([
                   :analytics_tags,
                   :facets,
+                  :generate,
                   :external
                 ])
       end