shipeasy-sdk 2.1.0 → 2.3.0

data/lib/shipeasy_admin/models/list_experiments_response_data_inner.rb

@@ -0,0 +1,688 @@
+=begin
+#Shipeasy Admin API
+
+#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  class ListExperimentsResponseDataInner < ApiModelBase
+    # Stable opaque experiment id (`exp_…`).
+    attr_accessor :id
+
+    # Stable experiment key. Single segment or `folder.name` (a-z, 0-9, `_`/`-`; max 128 chars). Used by SDKs as `Shipeasy.getExperiment(user, '<name>')`. Immutable after create.
+    attr_accessor :name
+
+    attr_accessor :description
+
+    attr_accessor :hypothesis
+
+    attr_accessor :tag
+
+    attr_accessor :owner_email
+
+    attr_accessor :audience
+
+    # User-attribute name used as the bucketing key — e.g. `user_id` (default), `session_id`, `device_id`, or a custom attribute like `company_id` to keep a whole org on one variant. Defaults to `user_id` when omitted.
+    attr_accessor :bucket_by
+
+    attr_accessor :folder
+
+    attr_accessor :status
+
+    # Universe name this experiment draws from.
+    attr_accessor :universe
+
+    attr_accessor :targeting_gate
+
+    # Allocation in basis points (0–10000).
+    attr_accessor :allocation_pct
+
+    # Optional gate name. Only callers that pass the gate are enrolled in the experiment.
+    attr_accessor :salt
+
+    attr_accessor :params
+
+    attr_accessor :groups
+
+    # Minimum detectable effect (relative, 0–1) for power planning. `null` to omit.
+    attr_accessor :significance_threshold
+
+    attr_accessor :min_runtime_days
+
+    attr_accessor :min_sample_size
+
+    attr_accessor :sequential_testing
+
+    # ISO-8601 timestamp the experiment last transitioned to `running`, or `null`.
+    attr_accessor :started_at
+
+    attr_accessor :stopped_at
+
+    # Optional gate name. Only callers that pass the gate are enrolled in the experiment.
+    attr_accessor :updated_at
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'hypothesis' => :'hypothesis',
+        :'tag' => :'tag',
+        :'owner_email' => :'ownerEmail',
+        :'audience' => :'audience',
+        :'bucket_by' => :'bucketBy',
+        :'folder' => :'folder',
+        :'status' => :'status',
+        :'universe' => :'universe',
+        :'targeting_gate' => :'targetingGate',
+        :'allocation_pct' => :'allocationPct',
+        :'salt' => :'salt',
+        :'params' => :'params',
+        :'groups' => :'groups',
+        :'significance_threshold' => :'significanceThreshold',
+        :'min_runtime_days' => :'minRuntimeDays',
+        :'min_sample_size' => :'minSampleSize',
+        :'sequential_testing' => :'sequentialTesting',
+        :'started_at' => :'startedAt',
+        :'stopped_at' => :'stoppedAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'hypothesis' => :'String',
+        :'tag' => :'String',
+        :'owner_email' => :'String',
+        :'audience' => :'String',
+        :'bucket_by' => :'String',
+        :'folder' => :'String',
+        :'status' => :'String',
+        :'universe' => :'String',
+        :'targeting_gate' => :'String',
+        :'allocation_pct' => :'Integer',
+        :'salt' => :'String',
+        :'params' => :'Hash<String, String>',
+        :'groups' => :'Array<ListExperimentsResponseDataInnerGroupsInner>',
+        :'significance_threshold' => :'Float',
+        :'min_runtime_days' => :'Integer',
+        :'min_sample_size' => :'Integer',
+        :'sequential_testing' => :'Boolean',
+        :'started_at' => :'String',
+        :'stopped_at' => :'String',
+        :'updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'hypothesis',
+        :'tag',
+        :'owner_email',
+        :'audience',
+        :'bucket_by',
+        :'folder',
+        :'targeting_gate',
+        :'salt',
+        :'significance_threshold',
+        :'started_at',
+        :'stopped_at',
+        :'updated_at'
+      ])
+    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 `Shipeasy::Admin::Generated::ListExperimentsResponseDataInner` 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 `Shipeasy::Admin::Generated::ListExperimentsResponseDataInner`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'hypothesis')
+        self.hypothesis = attributes[:'hypothesis']
+      else
+        self.hypothesis = nil
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      else
+        self.tag = nil
+      end
+
+      if attributes.key?(:'owner_email')
+        self.owner_email = attributes[:'owner_email']
+      else
+        self.owner_email = nil
+      end
+
+      if attributes.key?(:'audience')
+        self.audience = attributes[:'audience']
+      else
+        self.audience = nil
+      end
+
+      if attributes.key?(:'bucket_by')
+        self.bucket_by = attributes[:'bucket_by']
+      else
+        self.bucket_by = nil
+      end
+
+      if attributes.key?(:'folder')
+        self.folder = attributes[:'folder']
+      else
+        self.folder = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'universe')
+        self.universe = attributes[:'universe']
+      else
+        self.universe = nil
+      end
+
+      if attributes.key?(:'targeting_gate')
+        self.targeting_gate = attributes[:'targeting_gate']
+      else
+        self.targeting_gate = nil
+      end
+
+      if attributes.key?(:'allocation_pct')
+        self.allocation_pct = attributes[:'allocation_pct']
+      else
+        self.allocation_pct = nil
+      end
+
+      if attributes.key?(:'salt')
+        self.salt = attributes[:'salt']
+      else
+        self.salt = nil
+      end
+
+      if attributes.key?(:'params')
+        if (value = attributes[:'params']).is_a?(Hash)
+          self.params = value
+        end
+      else
+        self.params = nil
+      end
+
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      else
+        self.groups = nil
+      end
+
+      if attributes.key?(:'significance_threshold')
+        self.significance_threshold = attributes[:'significance_threshold']
+      else
+        self.significance_threshold = nil
+      end
+
+      if attributes.key?(:'min_runtime_days')
+        self.min_runtime_days = attributes[:'min_runtime_days']
+      else
+        self.min_runtime_days = nil
+      end
+
+      if attributes.key?(:'min_sample_size')
+        self.min_sample_size = attributes[:'min_sample_size']
+      else
+        self.min_sample_size = nil
+      end
+
+      if attributes.key?(:'sequential_testing')
+        self.sequential_testing = attributes[:'sequential_testing']
+      else
+        self.sequential_testing = nil
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      else
+        self.started_at = nil
+      end
+
+      if attributes.key?(:'stopped_at')
+        self.stopped_at = attributes[:'stopped_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 128
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
+      end
+
+      pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
+      if @name !~ pattern
+        invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @bucket_by.to_s.length > 128
+        invalid_properties.push('invalid value for "bucket_by", the character length must be smaller than or equal to 128.')
+      end
+
+      if @bucket_by.to_s.length < 1
+        invalid_properties.push('invalid value for "bucket_by", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+      if @bucket_by !~ pattern
+        invalid_properties.push("invalid value for \"bucket_by\", must conform to the pattern #{pattern}.")
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @universe.nil?
+        invalid_properties.push('invalid value for "universe", universe cannot be nil.')
+      end
+
+      if @allocation_pct.nil?
+        invalid_properties.push('invalid value for "allocation_pct", allocation_pct cannot be nil.')
+      end
+
+      if @allocation_pct > 9007199254740991
+        invalid_properties.push('invalid value for "allocation_pct", must be smaller than or equal to 9007199254740991.')
+      end
+
+      if @allocation_pct < -9007199254740991
+        invalid_properties.push('invalid value for "allocation_pct", must be greater than or equal to -9007199254740991.')
+      end
+
+      if @params.nil?
+        invalid_properties.push('invalid value for "params", params cannot be nil.')
+      end
+
+      if @groups.nil?
+        invalid_properties.push('invalid value for "groups", groups cannot be nil.')
+      end
+
+      if @min_runtime_days.nil?
+        invalid_properties.push('invalid value for "min_runtime_days", min_runtime_days cannot be nil.')
+      end
+
+      if @min_runtime_days > 9007199254740991
+        invalid_properties.push('invalid value for "min_runtime_days", must be smaller than or equal to 9007199254740991.')
+      end
+
+      if @min_runtime_days < -9007199254740991
+        invalid_properties.push('invalid value for "min_runtime_days", must be greater than or equal to -9007199254740991.')
+      end
+
+      if @min_sample_size.nil?
+        invalid_properties.push('invalid value for "min_sample_size", min_sample_size cannot be nil.')
+      end
+
+      if @min_sample_size > 9007199254740991
+        invalid_properties.push('invalid value for "min_sample_size", must be smaller than or equal to 9007199254740991.')
+      end
+
+      if @min_sample_size < -9007199254740991
+        invalid_properties.push('invalid value for "min_sample_size", must be greater than or equal to -9007199254740991.')
+      end
+
+      if @sequential_testing.nil?
+        invalid_properties.push('invalid value for "sequential_testing", sequential_testing 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 @id.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 128
+      return false if @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
+      return false if @bucket_by.to_s.length > 128
+      return false if @bucket_by.to_s.length < 1
+      return false if @bucket_by !~ Regexp.new(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["draft", "running", "stopped", "archived"])
+      return false unless status_validator.valid?(@status)
+      return false if @universe.nil?
+      return false if @allocation_pct.nil?
+      return false if @allocation_pct > 9007199254740991
+      return false if @allocation_pct < -9007199254740991
+      return false if @params.nil?
+      return false if @groups.nil?
+      return false if @min_runtime_days.nil?
+      return false if @min_runtime_days > 9007199254740991
+      return false if @min_runtime_days < -9007199254740991
+      return false if @min_sample_size.nil?
+      return false if @min_sample_size > 9007199254740991
+      return false if @min_sample_size < -9007199254740991
+      return false if @sequential_testing.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 128
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.'
+      end
+
+      pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
+      if name !~ pattern
+        fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bucket_by Value to be assigned
+    def bucket_by=(bucket_by)
+      if !bucket_by.nil? && bucket_by.to_s.length > 128
+        fail ArgumentError, 'invalid value for "bucket_by", the character length must be smaller than or equal to 128.'
+      end
+
+      if !bucket_by.nil? && bucket_by.to_s.length < 1
+        fail ArgumentError, 'invalid value for "bucket_by", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z_][a-zA-Z0-9_]*$/)
+      if !bucket_by.nil? && bucket_by !~ pattern
+        fail ArgumentError, "invalid value for \"bucket_by\", must conform to the pattern #{pattern}."
+      end
+
+      @bucket_by = bucket_by
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "running", "stopped", "archived"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] universe Value to be assigned
+    def universe=(universe)
+      if universe.nil?
+        fail ArgumentError, 'universe cannot be nil'
+      end
+
+      @universe = universe
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] allocation_pct Value to be assigned
+    def allocation_pct=(allocation_pct)
+      if allocation_pct.nil?
+        fail ArgumentError, 'allocation_pct cannot be nil'
+      end
+
+      if allocation_pct > 9007199254740991
+        fail ArgumentError, 'invalid value for "allocation_pct", must be smaller than or equal to 9007199254740991.'
+      end
+
+      if allocation_pct < -9007199254740991
+        fail ArgumentError, 'invalid value for "allocation_pct", must be greater than or equal to -9007199254740991.'
+      end
+
+      @allocation_pct = allocation_pct
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] groups Value to be assigned
+    def groups=(groups)
+      if groups.nil?
+        fail ArgumentError, 'groups cannot be nil'
+      end
+
+      @groups = groups
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_runtime_days Value to be assigned
+    def min_runtime_days=(min_runtime_days)
+      if min_runtime_days.nil?
+        fail ArgumentError, 'min_runtime_days cannot be nil'
+      end
+
+      if min_runtime_days > 9007199254740991
+        fail ArgumentError, 'invalid value for "min_runtime_days", must be smaller than or equal to 9007199254740991.'
+      end
+
+      if min_runtime_days < -9007199254740991
+        fail ArgumentError, 'invalid value for "min_runtime_days", must be greater than or equal to -9007199254740991.'
+      end
+
+      @min_runtime_days = min_runtime_days
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_sample_size Value to be assigned
+    def min_sample_size=(min_sample_size)
+      if min_sample_size.nil?
+        fail ArgumentError, 'min_sample_size cannot be nil'
+      end
+
+      if min_sample_size > 9007199254740991
+        fail ArgumentError, 'invalid value for "min_sample_size", must be smaller than or equal to 9007199254740991.'
+      end
+
+      if min_sample_size < -9007199254740991
+        fail ArgumentError, 'invalid value for "min_sample_size", must be greater than or equal to -9007199254740991.'
+      end
+
+      @min_sample_size = min_sample_size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sequential_testing Value to be assigned
+    def sequential_testing=(sequential_testing)
+      if sequential_testing.nil?
+        fail ArgumentError, 'sequential_testing cannot be nil'
+      end
+
+      @sequential_testing = sequential_testing
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          description == o.description &&
+          hypothesis == o.hypothesis &&
+          tag == o.tag &&
+          owner_email == o.owner_email &&
+          audience == o.audience &&
+          bucket_by == o.bucket_by &&
+          folder == o.folder &&
+          status == o.status &&
+          universe == o.universe &&
+          targeting_gate == o.targeting_gate &&
+          allocation_pct == o.allocation_pct &&
+          salt == o.salt &&
+          params == o.params &&
+          groups == o.groups &&
+          significance_threshold == o.significance_threshold &&
+          min_runtime_days == o.min_runtime_days &&
+          min_sample_size == o.min_sample_size &&
+          sequential_testing == o.sequential_testing &&
+          started_at == o.started_at &&
+          stopped_at == o.stopped_at &&
+          updated_at == o.updated_at
+    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
+      [id, name, description, hypothesis, tag, owner_email, audience, bucket_by, folder, status, universe, targeting_gate, allocation_pct, salt, params, groups, significance_threshold, min_runtime_days, min_sample_size, sequential_testing, started_at, stopped_at, updated_at].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