reacon-sdk 0.1.0.beta.4

data/lib/reacon-sdk/models/mail_experiment_revision_record.rb

@@ -0,0 +1,463 @@
+=begin
+#Reacon API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Reacon
+  class MailExperimentRevisionRecord < ApiModelBase
+    attr_accessor :attribution_window_ms
+
+    attr_accessor :cadence_version
+
+    attr_accessor :created_at
+
+    attr_accessor :definition_hash
+
+    attr_accessor :experiment_key
+
+    attr_accessor :guardrail_metrics
+
+    attr_accessor :hypothesis
+
+    attr_accessor :minimum_runtime_ms
+
+    attr_accessor :minimum_sample_size
+
+    attr_accessor :primary_metric
+
+    attr_accessor :revision
+
+    attr_accessor :tenant_id
+
+    attr_accessor :variants
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attribution_window_ms' => :'attributionWindowMs',
+        :'cadence_version' => :'cadenceVersion',
+        :'created_at' => :'createdAt',
+        :'definition_hash' => :'definitionHash',
+        :'experiment_key' => :'experimentKey',
+        :'guardrail_metrics' => :'guardrailMetrics',
+        :'hypothesis' => :'hypothesis',
+        :'minimum_runtime_ms' => :'minimumRuntimeMs',
+        :'minimum_sample_size' => :'minimumSampleSize',
+        :'primary_metric' => :'primaryMetric',
+        :'revision' => :'revision',
+        :'tenant_id' => :'tenantId',
+        :'variants' => :'variants'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'attribution_window_ms' => :'Float',
+        :'cadence_version' => :'Float',
+        :'created_at' => :'Time',
+        :'definition_hash' => :'String',
+        :'experiment_key' => :'String',
+        :'guardrail_metrics' => :'Array<String>',
+        :'hypothesis' => :'String',
+        :'minimum_runtime_ms' => :'Float',
+        :'minimum_sample_size' => :'Float',
+        :'primary_metric' => :'String',
+        :'revision' => :'Float',
+        :'tenant_id' => :'String',
+        :'variants' => :'Array<MailExperimentVariant>'
+      }
+    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))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Reacon::MailExperimentRevisionRecord` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Reacon::MailExperimentRevisionRecord`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'attribution_window_ms')
+        self.attribution_window_ms = attributes[:'attribution_window_ms']
+      else
+        self.attribution_window_ms = nil
+      end
+
+      if attributes.key?(:'cadence_version')
+        self.cadence_version = attributes[:'cadence_version']
+      else
+        self.cadence_version = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'definition_hash')
+        self.definition_hash = attributes[:'definition_hash']
+      else
+        self.definition_hash = nil
+      end
+
+      if attributes.key?(:'experiment_key')
+        self.experiment_key = attributes[:'experiment_key']
+      else
+        self.experiment_key = nil
+      end
+
+      if attributes.key?(:'guardrail_metrics')
+        if (value = attributes[:'guardrail_metrics']).is_a?(Array)
+          self.guardrail_metrics = value
+        end
+      else
+        self.guardrail_metrics = nil
+      end
+
+      if attributes.key?(:'hypothesis')
+        self.hypothesis = attributes[:'hypothesis']
+      end
+
+      if attributes.key?(:'minimum_runtime_ms')
+        self.minimum_runtime_ms = attributes[:'minimum_runtime_ms']
+      else
+        self.minimum_runtime_ms = nil
+      end
+
+      if attributes.key?(:'minimum_sample_size')
+        self.minimum_sample_size = attributes[:'minimum_sample_size']
+      else
+        self.minimum_sample_size = nil
+      end
+
+      if attributes.key?(:'primary_metric')
+        self.primary_metric = attributes[:'primary_metric']
+      else
+        self.primary_metric = nil
+      end
+
+      if attributes.key?(:'revision')
+        self.revision = attributes[:'revision']
+      else
+        self.revision = nil
+      end
+
+      if attributes.key?(:'tenant_id')
+        self.tenant_id = attributes[:'tenant_id']
+      else
+        self.tenant_id = nil
+      end
+
+      if attributes.key?(:'variants')
+        if (value = attributes[:'variants']).is_a?(Array)
+          self.variants = value
+        end
+      else
+        self.variants = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @attribution_window_ms.nil?
+        invalid_properties.push('invalid value for "attribution_window_ms", attribution_window_ms cannot be nil.')
+      end
+
+      if @cadence_version.nil?
+        invalid_properties.push('invalid value for "cadence_version", cadence_version cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @definition_hash.nil?
+        invalid_properties.push('invalid value for "definition_hash", definition_hash cannot be nil.')
+      end
+
+      if @experiment_key.nil?
+        invalid_properties.push('invalid value for "experiment_key", experiment_key cannot be nil.')
+      end
+
+      if @guardrail_metrics.nil?
+        invalid_properties.push('invalid value for "guardrail_metrics", guardrail_metrics cannot be nil.')
+      end
+
+      if @minimum_runtime_ms.nil?
+        invalid_properties.push('invalid value for "minimum_runtime_ms", minimum_runtime_ms cannot be nil.')
+      end
+
+      if @minimum_sample_size.nil?
+        invalid_properties.push('invalid value for "minimum_sample_size", minimum_sample_size cannot be nil.')
+      end
+
+      if @primary_metric.nil?
+        invalid_properties.push('invalid value for "primary_metric", primary_metric cannot be nil.')
+      end
+
+      if @revision.nil?
+        invalid_properties.push('invalid value for "revision", revision cannot be nil.')
+      end
+
+      if @tenant_id.nil?
+        invalid_properties.push('invalid value for "tenant_id", tenant_id cannot be nil.')
+      end
+
+      if @variants.nil?
+        invalid_properties.push('invalid value for "variants", variants cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @attribution_window_ms.nil?
+      return false if @cadence_version.nil?
+      return false if @created_at.nil?
+      return false if @definition_hash.nil?
+      return false if @experiment_key.nil?
+      return false if @guardrail_metrics.nil?
+      return false if @minimum_runtime_ms.nil?
+      return false if @minimum_sample_size.nil?
+      return false if @primary_metric.nil?
+      return false if @revision.nil?
+      return false if @tenant_id.nil?
+      return false if @variants.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attribution_window_ms Value to be assigned
+    def attribution_window_ms=(attribution_window_ms)
+      if attribution_window_ms.nil?
+        fail ArgumentError, 'attribution_window_ms cannot be nil'
+      end
+
+      @attribution_window_ms = attribution_window_ms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cadence_version Value to be assigned
+    def cadence_version=(cadence_version)
+      if cadence_version.nil?
+        fail ArgumentError, 'cadence_version cannot be nil'
+      end
+
+      @cadence_version = cadence_version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] definition_hash Value to be assigned
+    def definition_hash=(definition_hash)
+      if definition_hash.nil?
+        fail ArgumentError, 'definition_hash cannot be nil'
+      end
+
+      @definition_hash = definition_hash
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] experiment_key Value to be assigned
+    def experiment_key=(experiment_key)
+      if experiment_key.nil?
+        fail ArgumentError, 'experiment_key cannot be nil'
+      end
+
+      @experiment_key = experiment_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] guardrail_metrics Value to be assigned
+    def guardrail_metrics=(guardrail_metrics)
+      if guardrail_metrics.nil?
+        fail ArgumentError, 'guardrail_metrics cannot be nil'
+      end
+
+      @guardrail_metrics = guardrail_metrics
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] minimum_runtime_ms Value to be assigned
+    def minimum_runtime_ms=(minimum_runtime_ms)
+      if minimum_runtime_ms.nil?
+        fail ArgumentError, 'minimum_runtime_ms cannot be nil'
+      end
+
+      @minimum_runtime_ms = minimum_runtime_ms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] minimum_sample_size Value to be assigned
+    def minimum_sample_size=(minimum_sample_size)
+      if minimum_sample_size.nil?
+        fail ArgumentError, 'minimum_sample_size cannot be nil'
+      end
+
+      @minimum_sample_size = minimum_sample_size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] primary_metric Value to be assigned
+    def primary_metric=(primary_metric)
+      if primary_metric.nil?
+        fail ArgumentError, 'primary_metric cannot be nil'
+      end
+
+      @primary_metric = primary_metric
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] revision Value to be assigned
+    def revision=(revision)
+      if revision.nil?
+        fail ArgumentError, 'revision cannot be nil'
+      end
+
+      @revision = revision
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tenant_id Value to be assigned
+    def tenant_id=(tenant_id)
+      if tenant_id.nil?
+        fail ArgumentError, 'tenant_id cannot be nil'
+      end
+
+      @tenant_id = tenant_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] variants Value to be assigned
+    def variants=(variants)
+      if variants.nil?
+        fail ArgumentError, 'variants cannot be nil'
+      end
+
+      @variants = variants
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          attribution_window_ms == o.attribution_window_ms &&
+          cadence_version == o.cadence_version &&
+          created_at == o.created_at &&
+          definition_hash == o.definition_hash &&
+          experiment_key == o.experiment_key &&
+          guardrail_metrics == o.guardrail_metrics &&
+          hypothesis == o.hypothesis &&
+          minimum_runtime_ms == o.minimum_runtime_ms &&
+          minimum_sample_size == o.minimum_sample_size &&
+          primary_metric == o.primary_metric &&
+          revision == o.revision &&
+          tenant_id == o.tenant_id &&
+          variants == o.variants
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [attribution_window_ms, cadence_version, created_at, definition_hash, experiment_key, guardrail_metrics, hypothesis, minimum_runtime_ms, minimum_sample_size, primary_metric, revision, tenant_id, variants].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 = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = 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}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    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 = self.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
+
+  end
+
+end

data/lib/reacon-sdk/models/mail_experiment_variant.rb

@@ -0,0 +1,103 @@
+=begin
+#Reacon API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Reacon
+  module MailExperimentVariant
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'MailCadenceMessageExperimentVariant',
+          :'MailCadenceWorkflowExperimentVariant'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Reacon.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end