algolia 3.45.0 → 3.46.1

data/lib/algolia/models/abtesting-v3/ab_test_settings_response.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
+    # Captured settings of an A/B test.
+    class ABTestSettingsResponse
+      # Captured settings for each variant of the A/B test.
+      attr_accessor :abtest_settings
+
+      # Whether another active A/B test is using the control index.
+      attr_accessor :control_index_in_use
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :abtest_settings => :abtestSettings,
+          :control_index_in_use => :controlIndexInUse
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :abtest_settings => :"Array<VariantSettings>",
+          :control_index_in_use => :"Boolean"
+        }
+      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::ABTestSettingsResponse` 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::ABTestSettingsResponse`. 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?(:abtest_settings)
+          if (value = attributes[:abtest_settings]).is_a?(Array)
+            self.abtest_settings = value
+          end
+        else
+          self.abtest_settings = nil
+        end
+
+        if attributes.key?(:control_index_in_use)
+          self.control_index_in_use = attributes[:control_index_in_use]
+        else
+          self.control_index_in_use = 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 &&
+          abtest_settings == other.abtest_settings &&
+          control_index_in_use == other.control_index_in_use
+      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
+        [abtest_settings, control_index_in_use].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/add_ab_tests_request.rb

@@ -11,6 +11,9 @@ module Algolia
       # A/B test name.
       attr_accessor :name
 
+      # Expected outcome of the A/B test.
+      attr_accessor :hypothesis
+
       # A/B test variants.
       attr_accessor :variants
 
@@ -26,6 +29,7 @@ module Algolia
       def self.attribute_map
         {
           :name => :name,
+          :hypothesis => :hypothesis,
           :variants => :variants,
           :metrics => :metrics,
           :configuration => :configuration,
@@ -37,6 +41,7 @@ module Algolia
       def self.types_mapping
         {
           :name => :"String",
+          :hypothesis => :"String",
           :variants => :"Array<AddABTestsVariant>",
           :metrics => :"Array<CreateMetric>",
           :configuration => :"ABTestConfiguration",
@@ -80,6 +85,10 @@ module Algolia
           self.name = nil
         end
 
+        if attributes.key?(:hypothesis)
+          self.hypothesis = attributes[:hypothesis]
+        end
+
         if attributes.key?(:variants)
           if (value = attributes[:variants]).is_a?(Array)
             self.variants = value
@@ -113,6 +122,7 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           name == other.name &&
+          hypothesis == other.hypothesis &&
           variants == other.variants &&
           metrics == other.metrics &&
           configuration == other.configuration &&
@@ -128,7 +138,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [name, variants, metrics, configuration, end_at].hash
+        [name, hypothesis, variants, metrics, configuration, end_at].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,34 @@
+# 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 AnalysisMethod
+      BAYESIAN = "bayesian".freeze
+      FREQUENTIST = "frequentist".freeze
+
+      def self.all_vars
+        @all_vars ||= [BAYESIAN, FREQUENTIST].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 AnalysisMethod.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #AnalysisMethod"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,237 @@
+# 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
+    # Bayesian inference results for this variant metric. Omitted when Bayesian results aren't requested or no Bayesian result is available for this metric. Individual inference fields can be omitted when their values aren't available.
+    class BayesianMetricResult
+      # Probability that this variant is better than the control.
+      attr_accessor :probability_to_be_better
+
+      # Lower bound of the 95% credible interval for the relative effect (variant/control minus 1).
+      attr_accessor :relative_effect_ci_low
+
+      # Upper bound of the 95% credible interval for the relative effect (variant/control minus 1).
+      attr_accessor :relative_effect_ci_high
+
+      attr_accessor :evidence
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :probability_to_be_better => :probabilityToBeBetter,
+          :relative_effect_ci_low => :relativeEffectCILow,
+          :relative_effect_ci_high => :relativeEffectCIHigh,
+          :evidence => :evidence
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :probability_to_be_better => :"Float",
+          :relative_effect_ci_low => :"Float",
+          :relative_effect_ci_high => :"Float",
+          :evidence => :"MetricEvidence"
+        }
+      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::BayesianMetricResult` 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::BayesianMetricResult`. 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?(:probability_to_be_better)
+          self.probability_to_be_better = attributes[:probability_to_be_better]
+        end
+
+        if attributes.key?(:relative_effect_ci_low)
+          self.relative_effect_ci_low = attributes[:relative_effect_ci_low]
+        end
+
+        if attributes.key?(:relative_effect_ci_high)
+          self.relative_effect_ci_high = attributes[:relative_effect_ci_high]
+        end
+
+        if attributes.key?(:evidence)
+          self.evidence = attributes[:evidence]
+        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 &&
+          probability_to_be_better == other.probability_to_be_better &&
+          relative_effect_ci_low == other.relative_effect_ci_low &&
+          relative_effect_ci_high == other.relative_effect_ci_high &&
+          evidence == other.evidence
+      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
+        [probability_to_be_better, relative_effect_ci_low, relative_effect_ci_high, evidence].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/evidence_status.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 EvidenceStatus
+      ENOUGH = "enough".freeze
+      NOT_ENOUGH = "not_enough".freeze
+      COLLECTING = "collecting".freeze
+      NO_DATA = "no_data".freeze
+      UNAVAILABLE = "unavailable".freeze
+
+      def self.all_vars
+        @all_vars ||= [ENOUGH, NOT_ENOUGH, COLLECTING, NO_DATA, UNAVAILABLE].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 EvidenceStatus.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #EvidenceStatus"
+      end
+    end
+  end
+end