shipeasy-sdk 2.3.0 → 2.3.1

data/lib/shipeasy_admin/models/create_key_response.rb

@@ -0,0 +1,286 @@
+=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
+  # The minted key. The plaintext `key` is returned **once**, here — it is stored hashed and can never be retrieved again.
+  class CreateKeyResponse < ApiModelBase
+    # Stable opaque key id (UUID). Use it to revoke the key.
+    attr_accessor :id
+
+    # The kind of key that was minted.
+    attr_accessor :type
+
+    # Environment the key is bound to (`prod` for `admin`/`ops`).
+    attr_accessor :env
+
+    # The plaintext API token (e.g. `sdk_server_…`). Returned once — store it now; it cannot be recovered.
+    attr_accessor :key
+
+    # ISO-8601 expiry, or `null` if the key never expires.
+    attr_accessor :expires_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',
+        :'type' => :'type',
+        :'env' => :'env',
+        :'key' => :'key',
+        :'expires_at' => :'expires_at'
+      }
+    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',
+        :'type' => :'String',
+        :'env' => :'String',
+        :'key' => :'String',
+        :'expires_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expires_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::CreateKeyResponse` 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::CreateKeyResponse`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'env')
+        self.env = attributes[:'env']
+      else
+        self.env = nil
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      else
+        self.key = nil
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      else
+        self.expires_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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @env.nil?
+        invalid_properties.push('invalid value for "env", env cannot be nil.')
+      end
+
+      if @key.nil?
+        invalid_properties.push('invalid value for "key", key 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["server", "client", "admin", "ops"])
+      return false unless type_validator.valid?(@type)
+      return false if @env.nil?
+      env_validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
+      return false unless env_validator.valid?(@env)
+      return false if @key.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 checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["server", "client", "admin", "ops"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] env Object to be assigned
+    def env=(env)
+      validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
+      unless validator.valid?(env)
+        fail ArgumentError, "invalid value for \"env\", must be one of #{validator.allowable_values}."
+      end
+      @env = env
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if key.nil?
+        fail ArgumentError, 'key cannot be nil'
+      end
+
+      @key = key
+    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 &&
+          type == o.type &&
+          env == o.env &&
+          key == o.key &&
+          expires_at == o.expires_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, type, env, key, expires_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

data/lib/shipeasy_admin/models/create_killswitch_request.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
@@ -16,13 +16,13 @@ require 'time'
 module Shipeasy::Admin::Generated
   # Body for `POST /api/admin/killswitches`. Only `name` is required.
   class CreateKillswitchRequest < ApiModelBase
-    # Stable killswitch key in `folder.name` form (two lowercase segments separated by a dot — e.g. `payments.checkout`). Immutable after create.
+    # Stable config/killswitch key in `folder.name` form (two lowercase segments separated by a dot, e.g. `pricing.tiers`). Immutable after create.
     attr_accessor :name
 
     # Optional free-form description shown in the dashboard. Max 512 chars.
     attr_accessor :description
 
-    # Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder `checkout` named `new-cart` is referenced as `checkout/new-cart` from the SDK.
+    # Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
     attr_accessor :folder
 
     # Default value applied to every env at creation. Defaults to `false`. Use `true` to ship the killswitch pre-tripped.
@@ -124,6 +124,11 @@ module Shipeasy::Admin::Generated
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
       end
 
+      pattern = Regexp.new(/^(?:_default|[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 !@description.nil? && @description.to_s.length > 512
         invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 512.')
       end
@@ -146,6 +151,7 @@ module Shipeasy::Admin::Generated
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @name.nil?
       return false if @name.to_s.length > 128
+      return false if @name !~ Regexp.new(/^(?:_default|[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/)
       return false if !@description.nil? && @description.to_s.length > 512
       return false if !@folder.nil? && @folder.to_s.length > 256
       return false if !@folder.nil? && @folder !~ Regexp.new(/^[a-zA-Z0-9_-]+$/)
@@ -163,6 +169,11 @@ module Shipeasy::Admin::Generated
         fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.'
       end
 
+      pattern = Regexp.new(/^(?:_default|[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
 

data/lib/shipeasy_admin/models/create_killswitch_response.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

data/lib/shipeasy_admin/models/create_metric_request.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
@@ -19,7 +19,7 @@ module Shipeasy::Admin::Generated
     # Stable metric key. Single segment or `folder.name`; lowercase letters, digits, `_`/`-`; max 128 chars.
     attr_accessor :name
 
-    # Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder `checkout` named `new-cart` is referenced as `checkout/new-cart` from the SDK.
+    # Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
     attr_accessor :folder
 
     # Source event the query reads from.
@@ -155,8 +155,6 @@ module Shipeasy::Admin::Generated
 
       if attributes.key?(:'min_detectable_effect')
         self.min_detectable_effect = attributes[:'min_detectable_effect']
-      else
-        self.min_detectable_effect = nil
       end
 
       if attributes.key?(:'direction')
@@ -209,22 +207,14 @@ module Shipeasy::Admin::Generated
         invalid_properties.push('invalid value for "query", the character length must be greater than or equal to 1.')
       end
 
-      if @winsorize_pct.nil?
-        invalid_properties.push('invalid value for "winsorize_pct", winsorize_pct cannot be nil.')
-      end
-
-      if @winsorize_pct > 99
+      if !@winsorize_pct.nil? && @winsorize_pct > 99
         invalid_properties.push('invalid value for "winsorize_pct", must be smaller than or equal to 99.')
       end
 
-      if @winsorize_pct < 1
+      if !@winsorize_pct.nil? && @winsorize_pct < 1
         invalid_properties.push('invalid value for "winsorize_pct", must be greater than or equal to 1.')
       end
 
-      if @direction.nil?
-        invalid_properties.push('invalid value for "direction", direction cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -241,10 +231,8 @@ module Shipeasy::Admin::Generated
       return false if @event_name.to_s.length < 1
       return false if !@query.nil? && @query.to_s.length > 4096
       return false if !@query.nil? && @query.to_s.length < 1
-      return false if @winsorize_pct.nil?
-      return false if @winsorize_pct > 99
-      return false if @winsorize_pct < 1
-      return false if @direction.nil?
+      return false if !@winsorize_pct.nil? && @winsorize_pct > 99
+      return false if !@winsorize_pct.nil? && @winsorize_pct < 1
       direction_validator = EnumAttributeValidator.new('String', ["higher_better", "lower_better", "neutral"])
       return false unless direction_validator.valid?(@direction)
       true

data/lib/shipeasy_admin/models/create_metric_response.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