algolia 3.0.0.alpha.14 → 3.0.0.alpha.16

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

@@ -0,0 +1,215 @@
+# 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 GetRevenue
+      # Revenue associated with this search, broken-down by currencies.
+      attr_accessor :currencies
+
+      # Daily revenue.
+      attr_accessor :dates
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :currencies => :currencies,
+          :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
+        {
+          :currencies => :'Hash<String, CurrenciesValue>',
+          :dates => :'Array<DailyRevenue>'
+        }
+      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::GetRevenue` 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::GetRevenue`. 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?(:currencies)
+          if (value = attributes[:currencies]).is_a?(Hash)
+            self.currencies = value
+          end
+        else
+          self.currencies = nil
+        end
+
+        if attributes.key?(:dates)
+          if (value = attributes[:dates]).is_a?(Array)
+            self.dates = value
+          end
+        else
+          self.dates = 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 &&
+          currencies == other.currencies &&
+          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
+        [currencies, 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_searches_count_response.rb

@@ -9,7 +9,7 @@ module Algolia
       # Number of occurrences.
       attr_accessor :count
 
-      # Search events with their associated dates and hit counts.
+      # Daily number of searches.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -29,7 +29,7 @@ module Algolia
       def self.types_mapping
         {
           :count => :Integer,
-          :dates => :'Array<SearchEvent>'
+          :dates => :'Array<DailySearches>'
         }
       end
 

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetSearchesNoClicksResponse
-      # Searches with no clicks.
+      # Searches without any clicks.
       attr_accessor :searches
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :searches => :'Array<SearchNoClickEvent>'
+          :searches => :'Array<DailySearchesNoClicks>'
         }
       end
 

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetSearchesNoResultsResponse
-      # Searches with no results.
+      # Searches without results.
       attr_accessor :searches
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :searches => :'Array<SearchNoResultEvent>'
+          :searches => :'Array<DailySearchesNoResults>'
         }
       end
 

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetStatusResponse
-      # Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+      # Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. If null, no update was performed yet.
       attr_accessor :updated_at
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -30,7 +30,9 @@ module Algolia
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new([
+                  :updated_at
+                ])
       end
 
       # Initializes the object

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetTopCountriesResponse
-      # Countries
+      # Countries and number of searches.
       attr_accessor :countries
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetTopFilterAttributesResponse
-      # Filterable attributes.
+      # Most frequent filters.
       attr_accessor :attributes
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -9,7 +9,6 @@ module Algolia
       # Attribute name.
       attr_accessor :attribute
 
-      # Operator.
       attr_accessor :operator
 
       # Attribute value.
@@ -18,6 +17,28 @@ module Algolia
       # Number of occurrences.
       attr_accessor :count
 
+      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
         {
@@ -37,7 +58,7 @@ module Algolia
       def self.types_mapping
         {
           :attribute => :String,
-          :operator => :String,
+          :operator => :Operator,
           :value => :String,
           :count => :Integer
         }

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class GetTopFiltersNoResultsResponse
-      # Filters with no results.
+      # Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
       attr_accessor :values
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -30,7 +30,9 @@ module Algolia
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([])
+        Set.new([
+                  :values
+                ])
       end
 
       # Initializes the object

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

@@ -9,12 +9,33 @@ module Algolia
       # Attribute name.
       attr_accessor :attribute
 
-      # Operator.
       attr_accessor :operator
 
       # Attribute value.
       attr_accessor :value
 
+      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
         {
@@ -33,7 +54,7 @@ module Algolia
       def self.types_mapping
         {
           :attribute => :String,
-          :operator => :String,
+          :operator => :Operator,
           :value => :String
         }
       end

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

@@ -11,7 +11,8 @@ module Algolia
         def openapi_one_of
           [
             :TopHitsResponse,
-            :TopHitsResponseWithAnalytics
+            :TopHitsResponseWithAnalytics,
+            :TopHitsResponseWithRevenueAnalytics
           ]
         end
 

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

@@ -11,7 +11,8 @@ module Algolia
         def openapi_one_of
           [
             :TopSearchesResponse,
-            :TopSearchesResponseWithAnalytics
+            :TopSearchesResponseWithAnalytics,
+            :TopSearchesResponseWithRevenueAnalytics
           ]
         end
 

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

@@ -6,10 +6,10 @@ require 'time'
 module Algolia
   module Analytics
     class GetUsersCountResponse
-      # Number of occurrences.
+      # Number of unique users.
       attr_accessor :count
 
-      # User count.
+      # Daily number of unique users.
       attr_accessor :dates
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -29,7 +29,7 @@ module Algolia
       def self.types_mapping
         {
           :count => :Integer,
-          :dates => :'Array<UserWithDate>'
+          :dates => :'Array<DailyUsers>'
         }
       end
 

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

@@ -0,0 +1,38 @@
+# 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 Operator
+      APPLY = ":".freeze
+      LESS_THAN = "<".freeze
+      LESS_EQUALS = "<=".freeze
+      EQUALS = "=".freeze
+      NOT_EQUALS = "!=".freeze
+      GREATER_THAN = ">".freeze
+      GREATER_EQUALS = ">=".freeze
+
+      def self.all_vars
+        @all_vars ||= [APPLY, LESS_THAN, LESS_EQUALS, EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_EQUALS].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 Operator.all_vars.include?(value)
+
+        raise "Invalid ENUM value #{value} for class #Operator"
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class TopCountry
-      # Country.
+      # Country code.
       attr_accessor :country
 
       # Number of occurrences.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class TopHit
-      # Hit.
+      # Object ID of a record that's returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.

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

@@ -6,25 +6,25 @@ require 'time'
 module Algolia
   module Analytics
     class TopHitWithAnalytics
-      # Hit.
+      # Object ID of a record that's returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
       attr_accessor :count
 
-      # [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 :click_through_rate
 
-      # [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+      # 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 :conversion_rate
 
-      # Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
-      attr_accessor :tracked_search_count
+      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+      attr_accessor :tracked_hit_count
 
-      # Number of click events.
+      # Number of clicks associated with this search.
       attr_accessor :click_count
 
-      # Number of converted clicks.
+      # Number of conversions from this search.
       attr_accessor :conversion_count
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,7 +34,7 @@ module Algolia
           :count => :count,
           :click_through_rate => :clickThroughRate,
           :conversion_rate => :conversionRate,
-          :tracked_search_count => :trackedSearchCount,
+          :tracked_hit_count => :trackedHitCount,
           :click_count => :clickCount,
           :conversion_count => :conversionCount
         }
@@ -52,7 +52,7 @@ module Algolia
           :count => :Integer,
           :click_through_rate => :Float,
           :conversion_rate => :Float,
-          :tracked_search_count => :Integer,
+          :tracked_hit_count => :Integer,
           :click_count => :Integer,
           :conversion_count => :Integer
         }
@@ -61,7 +61,8 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new([
-                  :tracked_search_count
+                  :click_through_rate,
+                  :conversion_rate
                 ])
       end
 
@@ -106,10 +107,10 @@ module Algolia
           self.conversion_rate = nil
         end
 
-        if attributes.key?(:tracked_search_count)
-          self.tracked_search_count = attributes[:tracked_search_count]
+        if attributes.key?(:tracked_hit_count)
+          self.tracked_hit_count = attributes[:tracked_hit_count]
         else
-          self.tracked_search_count = nil
+          self.tracked_hit_count = nil
         end
 
         if attributes.key?(:click_count)
@@ -128,21 +129,59 @@ module Algolia
       # Custom attribute writer method with validation
       # @param [Object] click_through_rate Value to be assigned
       def click_through_rate=(click_through_rate)
-        if click_through_rate.nil?
-          raise ArgumentError, 'click_through_rate cannot be nil'
-        end
-
-        if click_through_rate > 1
+        if !click_through_rate.nil? && click_through_rate > 1
           raise ArgumentError, 'invalid value for "click_through_rate", must be smaller than or equal to 1.'
         end
 
-        if click_through_rate < 0
+        if !click_through_rate.nil? && click_through_rate < 0
           raise ArgumentError, 'invalid value for "click_through_rate", must be greater than or equal to 0.'
         end
 
         @click_through_rate = click_through_rate
       end
 
+      # Custom attribute writer method with validation
+      # @param [Object] conversion_rate Value to be assigned
+      def conversion_rate=(conversion_rate)
+        if !conversion_rate.nil? && conversion_rate > 1
+          raise ArgumentError, 'invalid value for "conversion_rate", must be smaller than or equal to 1.'
+        end
+
+        if !conversion_rate.nil? && conversion_rate < 0
+          raise ArgumentError, 'invalid value for "conversion_rate", must be greater than or equal to 0.'
+        end
+
+        @conversion_rate = conversion_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
+
+      # 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)
@@ -153,7 +192,7 @@ module Algolia
           count == other.count &&
           click_through_rate == other.click_through_rate &&
           conversion_rate == other.conversion_rate &&
-          tracked_search_count == other.tracked_search_count &&
+          tracked_hit_count == other.tracked_hit_count &&
           click_count == other.click_count &&
           conversion_count == other.conversion_count
       end
@@ -167,7 +206,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [hit, count, click_through_rate, conversion_rate, tracked_search_count, click_count, conversion_count].hash
+        [hit, count, click_through_rate, conversion_rate, tracked_hit_count, click_count, conversion_count].hash
       end
 
       # Builds the object from hash