algolia 3.0.0.alpha.10 → 3.0.0.alpha.12

data/lib/algolia/models/ingestion/mapping_kit_action.rb

@@ -0,0 +1,235 @@
+# 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 Ingestion
+    # Describes how a destination object should be resolved by means of applying a set of directives.
+    class MappingKitAction
+      # ID to uniquely identify this action.
+      attr_accessor :id
+
+      # Whether this action has any effect.
+      attr_accessor :enabled
+
+      # Condition which must be satisfied to apply the action. If this evaluates to false, the action is not applied, and the process attempts to apply the next action, if any.
+      attr_accessor :trigger
+
+      attr_accessor :field_directives
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :id => :id,
+          :enabled => :enabled,
+          :trigger => :trigger,
+          :field_directives => :fieldDirectives
+        }
+      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
+        {
+          :id => :String,
+          :enabled => :Boolean,
+          :trigger => :String,
+          :field_directives => :'Array<MappingFieldDirective>'
+        }
+      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::MappingKitAction` 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::MappingKitAction`. 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?(:id)
+          self.id = attributes[:id]
+        end
+
+        if attributes.key?(:enabled)
+          self.enabled = attributes[:enabled]
+        else
+          self.enabled = nil
+        end
+
+        if attributes.key?(:trigger)
+          self.trigger = attributes[:trigger]
+        else
+          self.trigger = nil
+        end
+
+        if attributes.key?(:field_directives)
+          if (value = attributes[:field_directives]).is_a?(Array)
+            self.field_directives = value
+          end
+        else
+          self.field_directives = nil
+        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 &&
+          id == other.id &&
+          enabled == other.enabled &&
+          trigger == other.trigger &&
+          field_directives == other.field_directives
+      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
+        [id, enabled, trigger, field_directives].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::Ingestion.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/ingestion/on_demand_date_utils_input.rb

@@ -13,11 +13,14 @@ module Algolia
       # The end date of the extraction (RFC3339 format).
       attr_accessor :end_date
 
+      attr_accessor :mapping
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :start_date => :startDate,
-          :end_date => :endDate
+          :end_date => :endDate,
+          :mapping => :mapping
         }
       end
 
@@ -30,7 +33,8 @@ module Algolia
       def self.types_mapping
         {
           :start_date => :String,
-          :end_date => :String
+          :end_date => :String,
+          :mapping => :MappingInput
         }
       end
 
@@ -67,6 +71,10 @@ module Algolia
         else
           self.end_date = nil
         end
+
+        if attributes.key?(:mapping)
+          self.mapping = attributes[:mapping]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -76,7 +84,8 @@ module Algolia
 
         self.class == other.class &&
           start_date == other.start_date &&
-          end_date == other.end_date
+          end_date == other.end_date &&
+          mapping == other.mapping
       end
 
       # @see the `==` method
@@ -88,7 +97,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [start_date, end_date].hash
+        [start_date, end_date, mapping].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/schedule_date_utils_input.rb

@@ -10,10 +10,13 @@ module Algolia
       # The timeframe of the extraction, in number of days from today.
       attr_accessor :timeframe
 
+      attr_accessor :mapping
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :timeframe => :timeframe
+          :timeframe => :timeframe,
+          :mapping => :mapping
         }
       end
 
@@ -25,7 +28,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :timeframe => :Integer
+          :timeframe => :Integer,
+          :mapping => :MappingInput
         }
       end
 
@@ -56,6 +60,10 @@ module Algolia
         else
           self.timeframe = nil
         end
+
+        if attributes.key?(:mapping)
+          self.mapping = attributes[:mapping]
+        end
       end
 
       # Custom attribute writer method with validation
@@ -82,7 +90,8 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          timeframe == other.timeframe
+          timeframe == other.timeframe &&
+          mapping == other.mapping
       end
 
       # @see the `==` method
@@ -94,7 +103,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [timeframe].hash
+        [timeframe, mapping].hash
       end
 
       # Builds the object from hash

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

@@ -84,6 +84,9 @@ module Algolia
       # Lets you store custom data in your indices.
       attr_accessor :user_data
 
+      # Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+      attr_accessor :query_id
+
       attr_accessor :additional_properties
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -115,7 +118,8 @@ module Algolia
           :rendering_content => :renderingContent,
           :server_time_ms => :serverTimeMS,
           :server_used => :serverUsed,
-          :user_data => :userData
+          :user_data => :userData,
+          :query_id => :queryID
         }
       end
 
@@ -153,7 +157,8 @@ module Algolia
           :rendering_content => :RenderingContent,
           :server_time_ms => :Integer,
           :server_used => :String,
-          :user_data => :Object
+          :user_data => :Object,
+          :query_id => :String
         }
       end
 
@@ -293,6 +298,10 @@ module Algolia
           self.user_data = attributes[:user_data]
         end
 
+        if attributes.key?(:query_id)
+          self.query_id = attributes[:query_id]
+        end
+
         # add extra attribute to additional_properties
         self.additional_properties ||= {}
         self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
@@ -377,7 +386,8 @@ module Algolia
           rendering_content == other.rendering_content &&
           server_time_ms == other.server_time_ms &&
           server_used == other.server_used &&
-          user_data == other.user_data
+          user_data == other.user_data &&
+          query_id == other.query_id
       end
 
       # @see the `==` method
@@ -390,7 +400,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [ab_test_id, ab_test_variant_id, around_lat_lng, automatic_radius, exhaustive, exhaustive_facets_count, exhaustive_nb_hits, exhaustive_typo, facets, facets_stats,
-         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data].hash
+         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id].hash
       end
 
       # Builds the object from hash

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

@@ -84,6 +84,9 @@ module Algolia
       # Lets you store custom data in your indices.
       attr_accessor :user_data
 
+      # Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+      attr_accessor :query_id
+
       attr_accessor :hits
 
       # Text to search for in an index.
@@ -122,6 +125,7 @@ module Algolia
           :server_time_ms => :serverTimeMS,
           :server_used => :serverUsed,
           :user_data => :userData,
+          :query_id => :queryID,
           :hits => :hits,
           :query => :query,
           :params => :params
@@ -163,6 +167,7 @@ module Algolia
           :server_time_ms => :Integer,
           :server_used => :String,
           :user_data => :Object,
+          :query_id => :String,
           :hits => :'Array<RecommendationsHit>',
           :query => :String,
           :params => :String
@@ -321,6 +326,10 @@ module Algolia
           self.user_data = attributes[:user_data]
         end
 
+        if attributes.key?(:query_id)
+          self.query_id = attributes[:query_id]
+        end
+
         if attributes.key?(:hits)
           if (value = attributes[:hits]).is_a?(Array)
             self.hits = value
@@ -418,6 +427,7 @@ module Algolia
           server_time_ms == other.server_time_ms &&
           server_used == other.server_used &&
           user_data == other.user_data &&
+          query_id == other.query_id &&
           hits == other.hits &&
           query == other.query &&
           params == other.params
@@ -433,7 +443,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [ab_test_id, ab_test_variant_id, around_lat_lng, automatic_radius, exhaustive, exhaustive_facets_count, exhaustive_nb_hits, exhaustive_typo, facets, facets_stats,
-         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, hits, query, params].hash
+         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id, hits, query, params].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,34 @@
+# 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 ApiKeyOperation
+      ADD = "add".freeze
+      DELETE = "delete".freeze
+      UPDATE = "update".freeze
+
+      def self.all_vars
+        @all_vars ||= [ADD, DELETE, UPDATE].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if ApiKeyOperation.all_vars.include?(value)
+
+        raise "Invalid ENUM value #{value} for class #ApiKeyOperation"
+      end
+    end
+  end
+end

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

@@ -84,6 +84,9 @@ module Algolia
       # Lets you store custom data in your indices.
       attr_accessor :user_data
 
+      # Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+      attr_accessor :query_id
+
       attr_accessor :additional_properties
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -115,7 +118,8 @@ module Algolia
           :rendering_content => :renderingContent,
           :server_time_ms => :serverTimeMS,
           :server_used => :serverUsed,
-          :user_data => :userData
+          :user_data => :userData,
+          :query_id => :queryID
         }
       end
 
@@ -153,7 +157,8 @@ module Algolia
           :rendering_content => :RenderingContent,
           :server_time_ms => :Integer,
           :server_used => :String,
-          :user_data => :Object
+          :user_data => :Object,
+          :query_id => :String
         }
       end
 
@@ -293,6 +298,10 @@ module Algolia
           self.user_data = attributes[:user_data]
         end
 
+        if attributes.key?(:query_id)
+          self.query_id = attributes[:query_id]
+        end
+
         # add extra attribute to additional_properties
         self.additional_properties ||= {}
         self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
@@ -377,7 +386,8 @@ module Algolia
           rendering_content == other.rendering_content &&
           server_time_ms == other.server_time_ms &&
           server_used == other.server_used &&
-          user_data == other.user_data
+          user_data == other.user_data &&
+          query_id == other.query_id
       end
 
       # @see the `==` method
@@ -390,7 +400,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [ab_test_id, ab_test_variant_id, around_lat_lng, automatic_radius, exhaustive, exhaustive_facets_count, exhaustive_nb_hits, exhaustive_typo, facets, facets_stats,
-         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data].hash
+         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id].hash
       end
 
       # Builds the object from hash

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

@@ -84,6 +84,9 @@ module Algolia
       # Lets you store custom data in your indices.
       attr_accessor :user_data
 
+      # Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+      attr_accessor :query_id
+
       attr_accessor :hits
 
       # Text to search for in an index.
@@ -125,6 +128,7 @@ module Algolia
           :server_time_ms => :serverTimeMS,
           :server_used => :serverUsed,
           :user_data => :userData,
+          :query_id => :queryID,
           :hits => :hits,
           :query => :query,
           :params => :params,
@@ -167,6 +171,7 @@ module Algolia
           :server_time_ms => :Integer,
           :server_used => :String,
           :user_data => :Object,
+          :query_id => :String,
           :hits => :'Array<Hit>',
           :query => :String,
           :params => :String,
@@ -327,6 +332,10 @@ module Algolia
           self.user_data = attributes[:user_data]
         end
 
+        if attributes.key?(:query_id)
+          self.query_id = attributes[:query_id]
+        end
+
         if attributes.key?(:hits)
           if (value = attributes[:hits]).is_a?(Array)
             self.hits = value
@@ -432,6 +441,7 @@ module Algolia
           server_time_ms == other.server_time_ms &&
           server_used == other.server_used &&
           user_data == other.user_data &&
+          query_id == other.query_id &&
           hits == other.hits &&
           query == other.query &&
           params == other.params &&
@@ -448,7 +458,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [ab_test_id, ab_test_variant_id, around_lat_lng, automatic_radius, exhaustive, exhaustive_facets_count, exhaustive_nb_hits, exhaustive_typo, facets, facets_stats,
-         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, hits, query, params, cursor].hash
+         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id, hits, query, params, cursor].hash
       end
 
       # Builds the object from hash

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

@@ -84,6 +84,9 @@ module Algolia
       # Lets you store custom data in your indices.
       attr_accessor :user_data
 
+      # Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+      attr_accessor :query_id
+
       attr_accessor :hits
 
       # Text to search for in an index.
@@ -124,6 +127,7 @@ module Algolia
           :server_time_ms => :serverTimeMS,
           :server_used => :serverUsed,
           :user_data => :userData,
+          :query_id => :queryID,
           :hits => :hits,
           :query => :query,
           :params => :params
@@ -165,6 +169,7 @@ module Algolia
           :server_time_ms => :Integer,
           :server_used => :String,
           :user_data => :Object,
+          :query_id => :String,
           :hits => :'Array<Hit>',
           :query => :String,
           :params => :String
@@ -313,6 +318,10 @@ module Algolia
           self.user_data = attributes[:user_data]
         end
 
+        if attributes.key?(:query_id)
+          self.query_id = attributes[:query_id]
+        end
+
         if attributes.key?(:hits)
           if (value = attributes[:hits]).is_a?(Array)
             self.hits = value
@@ -418,6 +427,7 @@ module Algolia
           server_time_ms == other.server_time_ms &&
           server_used == other.server_used &&
           user_data == other.user_data &&
+          query_id == other.query_id &&
           hits == other.hits &&
           query == other.query &&
           params == other.params
@@ -433,7 +443,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [ab_test_id, ab_test_variant_id, around_lat_lng, automatic_radius, exhaustive, exhaustive_facets_count, exhaustive_nb_hits, exhaustive_typo, facets, facets_stats,
-         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, hits, query, params].hash
+         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id, hits, query, params].hash
       end
 
       # Builds the object from hash