algolia 3.45.0 → 3.46.1

data/lib/algolia/models/abtesting-v3/feature_settings.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+# 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 AbtestingV3
+    # Feature-specific settings captured for a variant.
+    class FeatureSettings
+      # Name of the feature the settings belong to.
+      attr_accessor :name
+
+      # Feature settings payload. The shape depends on the feature.
+      attr_accessor :settings
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :name => :name,
+          :settings => :settings
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :name => :"String",
+          :settings => :"Object"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :settings
+          ]
+        )
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::FeatureSettings` initialize method"
+          )
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) { |(k, v), h|
+          if (!self.class.attribute_map.key?(k.to_sym))
+            raise(
+              ArgumentError,
+              "`#{k}` is not a valid attribute in `Algolia::FeatureSettings`. 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
+        }
+
+        if attributes.key?(:name)
+          self.name = attributes[:name]
+        else
+          self.name = nil
+        end
+
+        if attributes.key?(:settings)
+          self.settings = attributes[:settings]
+        else
+          self.settings = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if self.equal?(other)
+        self.class == other.class &&
+          name == other.name &&
+          settings == other.settings
+      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
+        [name, settings].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
+          # model
+        else
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::AbtestingV3.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.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/abtesting-v3/metric_evidence.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+# 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 AbtestingV3
+    # Evidence status for this variant metric's comparison with the control. Only present when the API has an evidence status for the comparison. Omitted when evidence isn't applicable or no status exists.
+    class MetricEvidence
+      attr_accessor :status
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :status => :status
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :status => :"EvidenceStatus"
+        }
+      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 = {})
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::MetricEvidence` initialize method"
+          )
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) { |(k, v), h|
+          if (!self.class.attribute_map.key?(k.to_sym))
+            raise(
+              ArgumentError,
+              "`#{k}` is not a valid attribute in `Algolia::MetricEvidence`. 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
+        }
+
+        if attributes.key?(:status)
+          self.status = attributes[:status]
+        else
+          self.status = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if self.equal?(other)
+        self.class == other.class &&
+          status == other.status
+      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
+        [status].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
+          # model
+        else
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::AbtestingV3.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.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/abtesting-v3/metric_metadata.rb

@@ -9,7 +9,7 @@ module Algolia
   module AbtestingV3
     # Metric specific metadata.
     class MetricMetadata
-      # Only present in case the metric is 'revenue'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
+      # Only present for `revenue` metrics. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
       attr_accessor :winsorized_value
 
       # Mean value for this metric.

data/lib/algolia/models/abtesting-v3/metric_name.rb

@@ -13,6 +13,7 @@ module Algolia
       USER_COUNT = "user_count".freeze
       TRACKED_USER_COUNT = "tracked_user_count".freeze
       NO_RESULT_COUNT = "no_result_count".freeze
+      TRACKED_NO_RESULT_COUNT = "tracked_no_result_count".freeze
       ADD_TO_CART_COUNT = "add_to_cart_count".freeze
       PURCHASE_COUNT = "purchase_count".freeze
       CLICKED_SEARCH_COUNT = "clicked_search_count".freeze
@@ -23,6 +24,8 @@ module Algolia
       PURCHASE_RATE = "purchase_rate".freeze
       AVERAGE_CLICK_POSITION = "average_click_position".freeze
       REVENUE = "revenue".freeze
+      REVENUE_PER_SEARCH = "revenue_per_search".freeze
+      AVERAGE_ORDER_VALUE = "average_order_value".freeze
 
       def self.all_vars
         @all_vars ||= [
@@ -31,6 +34,7 @@ module Algolia
           USER_COUNT,
           TRACKED_USER_COUNT,
           NO_RESULT_COUNT,
+          TRACKED_NO_RESULT_COUNT,
           ADD_TO_CART_COUNT,
           PURCHASE_COUNT,
           CLICKED_SEARCH_COUNT,
@@ -40,7 +44,9 @@ module Algolia
           ADD_TO_CART_RATE,
           PURCHASE_RATE,
           AVERAGE_CLICK_POSITION,
-          REVENUE
+          REVENUE,
+          REVENUE_PER_SEARCH,
+          AVERAGE_ORDER_VALUE
         ].freeze
       end
 

data/lib/algolia/models/abtesting-v3/metric_result.rb

@@ -8,11 +8,13 @@ require "time"
 module Algolia
   module AbtestingV3
     class MetricResult
+      # Metric name. Revenue per search results use `revenue_per_search`.
       attr_accessor :name
 
       # Date and time when the metric was last updated, in RFC 3339 format.
       attr_accessor :updated_at
 
+      # Metric value. For `revenue_per_search`, this is the winsorized mean revenue per search in the specified currency.
       attr_accessor :value
 
       # The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
@@ -21,10 +23,10 @@ module Algolia
       # The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
       attr_accessor :value_ci_low
 
-      # PValue for the first variant (control) will always be 0. For the other variants, pValue is calculated for the current variant based on the control.
+      # P-value for this variant compared to the control. Omitted when no p-value is available for this metric.
       attr_accessor :p_value
 
-      # Dimension defined during test creation.
+      # Dimension defined during test creation. For revenue metrics, including `revenue_per_search`, this is the currency.
       attr_accessor :dimension
 
       attr_accessor :metadata
@@ -35,6 +37,8 @@ module Algolia
       # Whether the pValue is significant or not based on the critical value and the error correction algorithm used.
       attr_accessor :significant
 
+      attr_accessor :bayesian
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -47,7 +51,8 @@ module Algolia
           :dimension => :dimension,
           :metadata => :metadata,
           :critical_value => :criticalValue,
-          :significant => :significant
+          :significant => :significant,
+          :bayesian => :bayesian
         }
       end
 
@@ -63,7 +68,8 @@ module Algolia
           :dimension => :"String",
           :metadata => :"MetricMetadata",
           :critical_value => :"Float",
-          :significant => :"Boolean"
+          :significant => :"Boolean",
+          :bayesian => :"BayesianMetricResult"
         }
       end
 
@@ -125,8 +131,6 @@ module Algolia
 
         if attributes.key?(:p_value)
           self.p_value = attributes[:p_value]
-        else
-          self.p_value = nil
         end
 
         if attributes.key?(:dimension)
@@ -144,6 +148,10 @@ module Algolia
         if attributes.key?(:significant)
           self.significant = attributes[:significant]
         end
+
+        if attributes.key?(:bayesian)
+          self.bayesian = attributes[:bayesian]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -160,7 +168,8 @@ module Algolia
           dimension == other.dimension &&
           metadata == other.metadata &&
           critical_value == other.critical_value &&
-          significant == other.significant
+          significant == other.significant &&
+          bayesian == other.bayesian
       end
 
       # @see the `==` method
@@ -182,7 +191,8 @@ module Algolia
           dimension,
           metadata,
           critical_value,
-          significant
+          significant,
+          bayesian
         ].hash
       end
 

data/lib/algolia/models/abtesting-v3/minimum_detectable_effect.rb

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module AbtestingV3
-    # Configuration for the smallest difference between test variants you want to detect.
+    # Configuration for the smallest difference between test variants you want to detect, used to estimate the required sample size.
     class MinimumDetectableEffect
       # Smallest difference in an observable metric between variants. For example, to detect a 10% difference between variants, set this value to 0.1.
       attr_accessor :size

data/lib/algolia/models/abtesting-v3/primary_metric.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# 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 AbtestingV3
+    class PrimaryMetric
+      ADD_TO_CART_RATE = "add_to_cart_rate".freeze
+      CLICK_THROUGH_RATE = "click_through_rate".freeze
+      CONVERSION_RATE = "conversion_rate".freeze
+      PURCHASE_RATE = "purchase_rate".freeze
+      REVENUE_PER_SEARCH = "revenue_per_search".freeze
+
+      def self.all_vars
+        @all_vars ||= [ADD_TO_CART_RATE, CLICK_THROUGH_RATE, CONVERSION_RATE, PURCHASE_RATE, REVENUE_PER_SEARCH].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 PrimaryMetric.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #PrimaryMetric"
+      end
+    end
+  end
+end