algolia 3.0.0.alpha.14 → 3.0.0.alpha.15

data/lib/algolia/models/analytics/get_average_click_position_response.rb

@@ -6,13 +6,13 @@ require 'time'
 module Algolia
   module Analytics
     class GetAverageClickPositionResponse
-      # Average count of all click events.
+      # Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :average
 
-      # Number of click events.
+      # Number of clicks associated with this search.
       attr_accessor :click_count
 
-      # Average click positions.
+      # Daily average click positions.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,13 +34,15 @@ module Algolia
         {
           :average => :Float,
           :click_count => :Integer,
-          :dates => :'Array<AverageClickEvent>'
+          :dates => :'Array<DailyAverageClicks>'
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new([
+                  :average
+                ])
       end
 
       # Initializes the object
@@ -81,6 +83,30 @@ module Algolia
         end
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] average Value to be assigned
+      def average=(average)
+        if !average.nil? && average < 1
+          raise ArgumentError, 'invalid value for "average", must be greater than or equal to 1.'
+        end
+
+        @average = average
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] click_count Value to be assigned
+      def click_count=(click_count)
+        if click_count.nil?
+          raise ArgumentError, 'click_count cannot be nil'
+        end
+
+        if click_count < 0
+          raise ArgumentError, 'invalid value for "click_count", must be greater than or equal to 0.'
+        end
+
+        @click_count = click_count
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

data/lib/algolia/models/analytics/get_click_positions_response.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetClickPositionsResponse
-      # Click positions.
+      # List of positions in the search results and clicks associated with this search.
       attr_accessor :positions
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :positions => :'Array<ClickPosition>'
+          :positions => :'Array<ClickPositionsInner>'
         }
       end
 
@@ -66,12 +66,12 @@ module Algolia
           raise ArgumentError, 'positions cannot be nil'
         end
 
-        if positions.length > 2
-          raise ArgumentError, 'invalid value for "positions", number of items must be less than or equal to 2.'
+        if positions.length > 12
+          raise ArgumentError, 'invalid value for "positions", number of items must be less than or equal to 12.'
         end
 
-        if positions.length < 2
-          raise ArgumentError, 'invalid value for "positions", number of items must be greater than or equal to 2.'
+        if positions.length < 12
+          raise ArgumentError, 'invalid value for "positions", number of items must be greater than or equal to 12.'
         end
 
         @positions = positions

data/lib/algolia/models/analytics/get_click_through_rate_response.rb

@@ -6,16 +6,16 @@ require 'time'
 module Algolia
   module Analytics
     class GetClickThroughRateResponse
-      # [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+      # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :rate
 
-      # Number of click events.
+      # Number of clicks associated with this search.
       attr_accessor :click_count
 
-      # Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
       attr_accessor :tracked_search_count
 
-      # Click-through rate events.
+      # Daily click-through rates.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,14 +39,14 @@ module Algolia
           :rate => :Float,
           :click_count => :Integer,
           :tracked_search_count => :Integer,
-          :dates => :'Array<ClickThroughRateEvent>'
+          :dates => :'Array<DailyClickThroughRates>'
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new([
-                  :tracked_search_count
+                  :rate
                 ])
       end
 
@@ -97,21 +97,31 @@ module Algolia
       # Custom attribute writer method with validation
       # @param [Object] rate Value to be assigned
       def rate=(rate)
-        if rate.nil?
-          raise ArgumentError, 'rate cannot be nil'
-        end
-
-        if rate > 1
+        if !rate.nil? && rate > 1
           raise ArgumentError, 'invalid value for "rate", must be smaller than or equal to 1.'
         end
 
-        if rate < 0
+        if !rate.nil? && rate < 0
           raise ArgumentError, 'invalid value for "rate", must be greater than or equal to 0.'
         end
 
         @rate = rate
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] click_count Value to be assigned
+      def click_count=(click_count)
+        if click_count.nil?
+          raise ArgumentError, 'click_count cannot be nil'
+        end
+
+        if click_count < 0
+          raise ArgumentError, 'invalid value for "click_count", must be greater than or equal to 0.'
+        end
+
+        @click_count = click_count
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

data/lib/algolia/models/analytics/get_conversion_rate_response.rb

@@ -0,0 +1,267 @@
+# 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 Analytics
+    class GetConversionRateResponse
+      # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
+      attr_accessor :rate
+
+      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+      attr_accessor :tracked_search_count
+
+      # Number of conversions from this search.
+      attr_accessor :conversion_count
+
+      # Daily conversion rates.
+      attr_accessor :dates
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :rate => :rate,
+          :tracked_search_count => :trackedSearchCount,
+          :conversion_count => :conversionCount,
+          :dates => :dates
+        }
+      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
+        {
+          :rate => :Float,
+          :tracked_search_count => :Integer,
+          :conversion_count => :Integer,
+          :dates => :'Array<DailyConversionRates>'
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([
+                  :rate
+                ])
+      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::GetConversionRateResponse` 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::GetConversionRateResponse`. 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?(:rate)
+          self.rate = attributes[:rate]
+        else
+          self.rate = nil
+        end
+
+        if attributes.key?(:tracked_search_count)
+          self.tracked_search_count = attributes[:tracked_search_count]
+        else
+          self.tracked_search_count = nil
+        end
+
+        if attributes.key?(:conversion_count)
+          self.conversion_count = attributes[:conversion_count]
+        else
+          self.conversion_count = nil
+        end
+
+        if attributes.key?(:dates)
+          if (value = attributes[:dates]).is_a?(Array)
+            self.dates = value
+          end
+        else
+          self.dates = nil
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] rate Value to be assigned
+      def rate=(rate)
+        if !rate.nil? && rate > 1
+          raise ArgumentError, 'invalid value for "rate", must be smaller than or equal to 1.'
+        end
+
+        if !rate.nil? && rate < 0
+          raise ArgumentError, 'invalid value for "rate", must be greater than or equal to 0.'
+        end
+
+        @rate = rate
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] conversion_count Value to be assigned
+      def conversion_count=(conversion_count)
+        if conversion_count.nil?
+          raise ArgumentError, 'conversion_count cannot be nil'
+        end
+
+        if conversion_count < 0
+          raise ArgumentError, 'invalid value for "conversion_count", must be greater than or equal to 0.'
+        end
+
+        @conversion_count = conversion_count
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          rate == other.rate &&
+          tracked_search_count == other.tracked_search_count &&
+          conversion_count == other.conversion_count &&
+          dates == other.dates
+      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
+        [rate, tracked_search_count, conversion_count, dates].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::Analytics.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/analytics/get_no_click_rate_response.rb

@@ -6,16 +6,16 @@ require 'time'
 module Algolia
   module Analytics
     class GetNoClickRateResponse
-      # [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+      # No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
       attr_accessor :rate
 
-      # Number of click events.
+      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
       attr_accessor :count
 
-      # Number of click events.
+      # Number of times this search was returned as a result without any click.
       attr_accessor :no_click_count
 
-      # Overall count of searches without clicks plus a daily breakdown.
+      # Daily no click rates.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,7 +39,7 @@ module Algolia
           :rate => :Float,
           :count => :Integer,
           :no_click_count => :Integer,
-          :dates => :'Array<NoClickRateEvent>'
+          :dates => :'Array<DailyNoClickRates>'
         }
       end
 
@@ -110,6 +110,20 @@ module Algolia
         @rate = rate
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] no_click_count Value to be assigned
+      def no_click_count=(no_click_count)
+        if no_click_count.nil?
+          raise ArgumentError, 'no_click_count cannot be nil'
+        end
+
+        if no_click_count < 1
+          raise ArgumentError, 'invalid value for "no_click_count", must be greater than or equal to 1.'
+        end
+
+        @no_click_count = no_click_count
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

data/lib/algolia/models/analytics/get_no_results_rate_response.rb

@@ -6,16 +6,16 @@ require 'time'
 module Algolia
   module Analytics
     class GetNoResultsRateResponse
-      # [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+      # No results rate, calculated as number of searches with zero results divided by the total number of searches.
       attr_accessor :rate
 
-      # Number of occurrences.
+      # Number of searches.
       attr_accessor :count
 
-      # Number of occurrences.
+      # Number of searches without any results.
       attr_accessor :no_result_count
 
-      # Overall count of searches without results plus a daily breakdown.
+      # Daily no results rates.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,7 +39,7 @@ module Algolia
           :rate => :Float,
           :count => :Integer,
           :no_result_count => :Integer,
-          :dates => :'Array<NoResultsRateEvent>'
+          :dates => :'Array<DailyNoResultsRates>'
         }
       end
 

data/lib/algolia/models/analytics/{get_conversation_rate_response.rb → get_purchase_rate_response.rb}

@@ -5,17 +5,17 @@ require 'time'
 
 module Algolia
   module Analytics
-    class GetConversationRateResponse
-      # [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+    class GetPurchaseRateResponse
+      # Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
       attr_accessor :rate
 
-      # Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
       attr_accessor :tracked_search_count
 
-      # Number of converted clicks.
-      attr_accessor :conversion_count
+      # Number of purchase events from this search.
+      attr_accessor :purchase_count
 
-      # Conversion events.
+      # Daily purchase rates.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -23,7 +23,7 @@ module Algolia
         {
           :rate => :rate,
           :tracked_search_count => :trackedSearchCount,
-          :conversion_count => :conversionCount,
+          :purchase_count => :purchaseCount,
           :dates => :dates
         }
       end
@@ -38,15 +38,15 @@ module Algolia
         {
           :rate => :Float,
           :tracked_search_count => :Integer,
-          :conversion_count => :Integer,
-          :dates => :'Array<ConversionRateEvent>'
+          :purchase_count => :Integer,
+          :dates => :'Array<DailyPurchaseRates>'
         }
       end
 
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new([
-                  :tracked_search_count
+                  :rate
                 ])
       end
 
@@ -54,14 +54,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::GetConversationRateResponse` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::GetPurchaseRateResponse` 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::GetConversationRateResponse`. 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::GetPurchaseRateResponse`. 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
@@ -79,10 +79,10 @@ module Algolia
           self.tracked_search_count = nil
         end
 
-        if attributes.key?(:conversion_count)
-          self.conversion_count = attributes[:conversion_count]
+        if attributes.key?(:purchase_count)
+          self.purchase_count = attributes[:purchase_count]
         else
-          self.conversion_count = nil
+          self.purchase_count = nil
         end
 
         if attributes.key?(:dates)
@@ -97,15 +97,11 @@ module Algolia
       # Custom attribute writer method with validation
       # @param [Object] rate Value to be assigned
       def rate=(rate)
-        if rate.nil?
-          raise ArgumentError, 'rate cannot be nil'
-        end
-
-        if rate > 1
+        if !rate.nil? && rate > 1
           raise ArgumentError, 'invalid value for "rate", must be smaller than or equal to 1.'
         end
 
-        if rate < 0
+        if !rate.nil? && rate < 0
           raise ArgumentError, 'invalid value for "rate", must be greater than or equal to 0.'
         end
 
@@ -120,7 +116,7 @@ module Algolia
         self.class == other.class &&
           rate == other.rate &&
           tracked_search_count == other.tracked_search_count &&
-          conversion_count == other.conversion_count &&
+          purchase_count == other.purchase_count &&
           dates == other.dates
       end
 
@@ -133,7 +129,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [rate, tracked_search_count, conversion_count, dates].hash
+        [rate, tracked_search_count, purchase_count, dates].hash
       end
 
       # Builds the object from hash