shipeasy-sdk 2.1.0 → 2.3.0

data/lib/shipeasy_admin/models/get_metric_response.rb

@@ -0,0 +1,378 @@
+=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
+  # A metric definition.
+  class GetMetricResponse < ApiModelBase
+    # Stable opaque metric id.
+    attr_accessor :id
+
+    # Metric key.
+    attr_accessor :name
+
+    # Folder grouping the metric, or `null`.
+    attr_accessor :folder
+
+    # Source event name (camelCase in response).
+    attr_accessor :event_name
+
+    # Legacy aggregation enum derived from the IR (`count_users`, `sum`, `ratio`, …).
+    attr_accessor :aggregation
+
+    # Numeric value label for sum/avg metrics, or `null`.
+    attr_accessor :value_path
+
+    # Rendered DSL text form of the query, or `null` if it could not be rendered.
+    attr_accessor :query
+
+    attr_accessor :query_ir
+
+    # Desired direction of movement. `higher_better` (default), `lower_better`, or `neutral` (guardrail).
+    attr_accessor :direction
+
+    # Winsorise percentile applied to the metric.
+    attr_accessor :winsorize_pct
+
+    # Configured MDE, or `null`.
+    attr_accessor :min_detectable_effect
+
+    # ISO-8601 creation timestamp.
+    attr_accessor :created_at
+
+    # ISO-8601 last-update timestamp.
+    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',
+        :'folder' => :'folder',
+        :'event_name' => :'eventName',
+        :'aggregation' => :'aggregation',
+        :'value_path' => :'valuePath',
+        :'query' => :'query',
+        :'query_ir' => :'queryIr',
+        :'direction' => :'direction',
+        :'winsorize_pct' => :'winsorizePct',
+        :'min_detectable_effect' => :'minDetectableEffect',
+        :'created_at' => :'createdAt',
+        :'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',
+        :'folder' => :'String',
+        :'event_name' => :'String',
+        :'aggregation' => :'String',
+        :'value_path' => :'String',
+        :'query' => :'String',
+        :'query_ir' => :'ListMetricsResponseInnerQueryIr',
+        :'direction' => :'String',
+        :'winsorize_pct' => :'Float',
+        :'min_detectable_effect' => :'Float',
+        :'created_at' => :'String',
+        :'updated_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'folder',
+        :'value_path',
+        :'query',
+        :'min_detectable_effect',
+      ])
+    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::GetMetricResponse` 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::GetMetricResponse`. 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?(:'folder')
+        self.folder = attributes[:'folder']
+      else
+        self.folder = nil
+      end
+
+      if attributes.key?(:'event_name')
+        self.event_name = attributes[:'event_name']
+      else
+        self.event_name = nil
+      end
+
+      if attributes.key?(:'aggregation')
+        self.aggregation = attributes[:'aggregation']
+      else
+        self.aggregation = nil
+      end
+
+      if attributes.key?(:'value_path')
+        self.value_path = attributes[:'value_path']
+      else
+        self.value_path = nil
+      end
+
+      if attributes.key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.key?(:'query_ir')
+        self.query_ir = attributes[:'query_ir']
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.key?(:'winsorize_pct')
+        self.winsorize_pct = attributes[:'winsorize_pct']
+      end
+
+      if attributes.key?(:'min_detectable_effect')
+        self.min_detectable_effect = attributes[:'min_detectable_effect']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 @event_name.nil?
+        invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
+      end
+
+      if @aggregation.nil?
+        invalid_properties.push('invalid value for "aggregation", aggregation 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 @event_name.nil?
+      return false if @aggregation.nil?
+      direction_validator = EnumAttributeValidator.new('String', ["higher_better", "lower_better", "neutral"])
+      return false unless direction_validator.valid?(@direction)
+      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
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_name Value to be assigned
+    def event_name=(event_name)
+      if event_name.nil?
+        fail ArgumentError, 'event_name cannot be nil'
+      end
+
+      @event_name = event_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] aggregation Value to be assigned
+    def aggregation=(aggregation)
+      if aggregation.nil?
+        fail ArgumentError, 'aggregation cannot be nil'
+      end
+
+      @aggregation = aggregation
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] direction Object to be assigned
+    def direction=(direction)
+      validator = EnumAttributeValidator.new('String', ["higher_better", "lower_better", "neutral"])
+      unless validator.valid?(direction)
+        fail ArgumentError, "invalid value for \"direction\", must be one of #{validator.allowable_values}."
+      end
+      @direction = direction
+    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 &&
+          folder == o.folder &&
+          event_name == o.event_name &&
+          aggregation == o.aggregation &&
+          value_path == o.value_path &&
+          query == o.query &&
+          query_ir == o.query_ir &&
+          direction == o.direction &&
+          winsorize_pct == o.winsorize_pct &&
+          min_detectable_effect == o.min_detectable_effect &&
+          created_at == o.created_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, folder, event_name, aggregation, value_path, query, query_ir, direction, winsorize_pct, min_detectable_effect, created_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