shipeasy-sdk 2.3.0 → 2.3.1

data/lib/shipeasy_admin/models/error_series_request.rb

@@ -0,0 +1,251 @@
+=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: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # Time window for the occurrence series. Bounds are epoch **seconds** (Analytics Engine stores the occurrence timestamp in seconds). `to` must be strictly greater than `from`.
+  class ErrorSeriesRequest < ApiModelBase
+    # Window start, epoch seconds (inclusive).
+    attr_accessor :from
+
+    # Window end, epoch seconds (exclusive). Must be greater than `from`.
+    attr_accessor :to
+
+    # Bucket width in seconds (60s–86400s/1d). Defaults to `3600` (hourly). Each returned point is floor-aligned to this width.
+    attr_accessor :bucket
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'from' => :'from',
+        :'to' => :'to',
+        :'bucket' => :'bucket'
+      }
+    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
+      {
+        :'from' => :'Integer',
+        :'to' => :'Integer',
+        :'bucket' => :'Integer'
+      }
+    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 `Shipeasy::Admin::Generated::ErrorSeriesRequest` 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::ErrorSeriesRequest`. 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?(:'from')
+        self.from = attributes[:'from']
+      else
+        self.from = nil
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'bucket')
+        self.bucket = attributes[:'bucket']
+      else
+        self.bucket = 3600
+      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 @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      if @from < 0
+        invalid_properties.push('invalid value for "from", must be greater than or equal to 0.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @to < 0
+        invalid_properties.push('invalid value for "to", must be greater than or equal to 0.')
+      end
+
+      if !@bucket.nil? && @bucket > 86400
+        invalid_properties.push('invalid value for "bucket", must be smaller than or equal to 86400.')
+      end
+
+      if !@bucket.nil? && @bucket < 60
+        invalid_properties.push('invalid value for "bucket", must be greater than or equal to 60.')
+      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 @from.nil?
+      return false if @from < 0
+      return false if @to.nil?
+      return false if @to < 0
+      return false if !@bucket.nil? && @bucket > 86400
+      return false if !@bucket.nil? && @bucket < 60
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from Value to be assigned
+    def from=(from)
+      if from.nil?
+        fail ArgumentError, 'from cannot be nil'
+      end
+
+      if from < 0
+        fail ArgumentError, 'invalid value for "from", must be greater than or equal to 0.'
+      end
+
+      @from = from
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      if to < 0
+        fail ArgumentError, 'invalid value for "to", must be greater than or equal to 0.'
+      end
+
+      @to = to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bucket Value to be assigned
+    def bucket=(bucket)
+      if bucket.nil?
+        fail ArgumentError, 'bucket cannot be nil'
+      end
+
+      if bucket > 86400
+        fail ArgumentError, 'invalid value for "bucket", must be smaller than or equal to 86400.'
+      end
+
+      if bucket < 60
+        fail ArgumentError, 'invalid value for "bucket", must be greater than or equal to 60.'
+      end
+
+      @bucket = bucket
+    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 &&
+          from == o.from &&
+          to == o.to &&
+          bucket == o.bucket
+    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
+      [from, to, bucket].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/shipeasy_admin/models/error_series_response.rb

@@ -0,0 +1,195 @@
+=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: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # Bucketed occurrence counts for one tracked error (by its fingerprint), plus the Analytics Engine SQL that produced them.
+  class ErrorSeriesResponse < ApiModelBase
+    # The Analytics Engine SQL executed to produce `rows` (echoed for transparency / debugging).
+    attr_accessor :sql
+
+    # Bucketed occurrence series, ordered by `t` ascending.
+    attr_accessor :rows
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sql' => :'sql',
+        :'rows' => :'rows'
+      }
+    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
+      {
+        :'sql' => :'String',
+        :'rows' => :'Array<ErrorSeriesResponseRowsInner>'
+      }
+    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 `Shipeasy::Admin::Generated::ErrorSeriesResponse` 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::ErrorSeriesResponse`. 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?(:'sql')
+        self.sql = attributes[:'sql']
+      else
+        self.sql = nil
+      end
+
+      if attributes.key?(:'rows')
+        if (value = attributes[:'rows']).is_a?(Array)
+          self.rows = value
+        end
+      else
+        self.rows = 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 @sql.nil?
+        invalid_properties.push('invalid value for "sql", sql cannot be nil.')
+      end
+
+      if @rows.nil?
+        invalid_properties.push('invalid value for "rows", rows 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 @sql.nil?
+      return false if @rows.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sql Value to be assigned
+    def sql=(sql)
+      if sql.nil?
+        fail ArgumentError, 'sql cannot be nil'
+      end
+
+      @sql = sql
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rows Value to be assigned
+    def rows=(rows)
+      if rows.nil?
+        fail ArgumentError, 'rows cannot be nil'
+      end
+
+      @rows = rows
+    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 &&
+          sql == o.sql &&
+          rows == o.rows
+    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
+      [sql, rows].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/shipeasy_admin/models/error_series_response_rows_inner.rb

@@ -0,0 +1,192 @@
+=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: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  class ErrorSeriesResponseRowsInner < ApiModelBase
+    # Bucket start, epoch seconds, floor-aligned to `bucket`.
+    attr_accessor :t
+
+    # Occurrence count in the bucket (sample-interval weighted).
+    attr_accessor :v
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'t' => :'t',
+        :'v' => :'v'
+      }
+    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
+      {
+        :'t' => :'Integer',
+        :'v' => :'Float'
+      }
+    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 `Shipeasy::Admin::Generated::ErrorSeriesResponseRowsInner` 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::ErrorSeriesResponseRowsInner`. 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?(:'t')
+        self.t = attributes[:'t']
+      else
+        self.t = nil
+      end
+
+      if attributes.key?(:'v')
+        self.v = attributes[:'v']
+      else
+        self.v = 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 @t.nil?
+        invalid_properties.push('invalid value for "t", t cannot be nil.')
+      end
+
+      if @v.nil?
+        invalid_properties.push('invalid value for "v", v 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 @t.nil?
+      return false if @v.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] t Value to be assigned
+    def t=(t)
+      if t.nil?
+        fail ArgumentError, 't cannot be nil'
+      end
+
+      @t = t
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] v Value to be assigned
+    def v=(v)
+      if v.nil?
+        fail ArgumentError, 'v cannot be nil'
+      end
+
+      @v = v
+    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 &&
+          t == o.t &&
+          v == o.v
+    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
+      [t, v].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/shipeasy_admin/models/{create_experiment_request_goal_metric.rb → experiment_inline_metric.rb}

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -14,20 +14,21 @@ require 'date'
 require 'time'
 
 module Shipeasy::Admin::Generated
-  # Single goal metric defined inline — either a DSL `query` or an `event` (+`aggregation`/`value`) the server compiles. Attaching one is required before the experiment can be started. The underlying event is auto-created if missing.
-  class CreateExperimentRequestGoalMetric < ApiModelBase
+  # Inline metric — a DSL `query`, or an `event` (+ `aggregation`/`value`) the server compiles into one.
+  class ExperimentInlineMetric < ApiModelBase
+    # Stable metric key. Single segment or `folder.name`; lowercase letters, digits, `_`/`-`; max 128 chars.
     attr_accessor :name
 
-    # Metric DSL string, e.g. `count_users(checkout_completed)`. Provide this OR `event`.
+    # Metric DSL string. Provide this OR `event`.
     attr_accessor :query
 
-    # Event name to build the metric from server-side (friendlier alternative to `query`). Auto-created if missing.
+    # Event name to build the metric from server-side. Auto-created if missing.
     attr_accessor :event
 
     # Reducer for the `event` form. Defaults to `count_users`.
     attr_accessor :aggregation
 
-    # Numeric event property for `sum`/`avg` aggregations (with `event`).
+    # Numeric event property for `sum`/`avg` (with `event`).
     attr_accessor :value
 
     class EnumAttributeValidator
@@ -94,14 +95,14 @@ module Shipeasy::Admin::Generated
     # @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::CreateExperimentRequestGoalMetric` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::ExperimentInlineMetric` 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::CreateExperimentRequestGoalMetric`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::ExperimentInlineMetric`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }