smplkit 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2df7b56969ecc78af54eb3cdf4d97c4d8355ae239a39bfcf03c2eeff4f73de4
-  data.tar.gz: 510d3be0930a5186f02b39bf108021fa00c18790a13131ecbe895d5a52837446
+  metadata.gz: 73faaf3780bcc84e53b73bf84d8b1d7b058a3a02ac1fbe9f083b3095bdb81c42
+  data.tar.gz: 8db8c9850d56f84bdf9766bc9add5be8e93d28904c04497315fe8017bf4912b3
 SHA512:
-  metadata.gz: 6c551d8c463d348391ef053a16ec442c04849181fe35950592eed8a2aef44451e773f4e2fc540fc460084dd3712c478cd882439e905c358e52d9a330f25a81c3
-  data.tar.gz: 7b9700aea42bdd53134dc9879f7156a1a2e1f3e4c93b269adf9c7de2dca187ebfa7669c3a9c1fb05f0524459a9607b0e5491f61a2154e328d67ca554ff89f7b5
+  metadata.gz: b6c058673647b18322b4a16ff0ea0305cafca542c20ac0c8e7d744239b078d83763ce591569f4ebd1ea35961f3a424d6680f0fc4baba643bf19a31653f9e5c8f
+  data.tar.gz: 68f29a422328643a0e18278e218761aa5ce66b76b2bd017f26a986e9cb824c3ea88d3e40d9645259324949611266427dd524a3bef69132c30e6c2fc0633b73b1

data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/environments_api.rb

@@ -88,9 +88,10 @@ module SmplkitGeneratedClient::App
     end
 
     # Delete Environment
-    # Delete an environment by id.
+    # Delete an environment by id. When `cascade=true` is set, also remove every per-environment reference held by flags, configs, and loggers in the corresponding services before deleting the environment row. The default `cascade=false` deletes only the environment row, leaving downstream references in place.
     # @param id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :cascade When `true`, remove every flag rule, env-level flag default, config override, and logger override scoped to this environment before deleting the environment row. (default to false)
     # @return [nil]
     def delete_environment(id, opts = {})
       delete_environment_with_http_info(id, opts)
@@ -98,9 +99,10 @@ module SmplkitGeneratedClient::App
     end
 
     # Delete Environment
-    # Delete an environment by id.
+    # Delete an environment by id. When `cascade=true` is set, also remove every per-environment reference held by flags, configs, and loggers in the corresponding services before deleting the environment row. The default `cascade=false` deletes only the environment row, leaving downstream references in place.
     # @param id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :cascade When `true`, remove every flag rule, env-level flag default, config override, and logger override scoped to this environment before deleting the environment row. (default to false)
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_environment_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -115,6 +117,7 @@ module SmplkitGeneratedClient::App
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'cascade'] = opts[:'cascade'] if !opts[:'cascade'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -213,6 +216,69 @@ module SmplkitGeneratedClient::App
       return data, status_code, headers
     end
 
+    # Report Environment Usage
+    # Report how many flag rules, env-level flag defaults, config overrides, and logger overrides reference this environment. Used by the console's delete dialog so the user can see what would survive a non-cascading delete.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EnvironmentUsageResponse]
+    def get_environment_usage(id, opts = {})
+      data, _status_code, _headers = get_environment_usage_with_http_info(id, opts)
+      data
+    end
+
+    # Report Environment Usage
+    # Report how many flag rules, env-level flag defaults, config overrides, and logger overrides reference this environment. Used by the console&#39;s delete dialog so the user can see what would survive a non-cascading delete.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EnvironmentUsageResponse, Integer, Hash)>] EnvironmentUsageResponse data, response status code and response headers
+    def get_environment_usage_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentsApi.get_environment_usage ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EnvironmentsApi.get_environment_usage"
+      end
+      # resource path
+      local_var_path = '/api/v1/environments/{id}/usage'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EnvironmentUsageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentsApi.get_environment_usage",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnvironmentsApi#get_environment_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Environments
     # List all environments for the authenticated account.
     # @param [Hash] opts the optional parameters

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_usage.rb

@@ -0,0 +1,283 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::App
+  # Counts of references to an environment held by other resources.  Returned by `GET /environments/{id}/usage` so the console can warn the user about per-environment configuration that would survive a bare environment-row deletion. Each count is the number of distinct referencing resources, not the number of rule entries within them.
+  class EnvironmentUsage < ApiModelBase
+    # Number of feature-flag targeting rules scoped to this environment. Each flag may contribute multiple rules.
+    attr_accessor :flag_rules
+
+    # Number of feature flags that declare an environment-level default value for this environment.
+    attr_accessor :flag_env_defaults
+
+    # Number of config-item overrides keyed to this environment, summed across all configs.
+    attr_accessor :config_overrides
+
+    # Number of loggers with an environment-level level override for this environment.
+    attr_accessor :logger_overrides
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'flag_rules' => :'flag_rules',
+        :'flag_env_defaults' => :'flag_env_defaults',
+        :'config_overrides' => :'config_overrides',
+        :'logger_overrides' => :'logger_overrides'
+      }
+    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
+      {
+        :'flag_rules' => :'Integer',
+        :'flag_env_defaults' => :'Integer',
+        :'config_overrides' => :'Integer',
+        :'logger_overrides' => :'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 `SmplkitGeneratedClient::App::EnvironmentUsage` 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 `SmplkitGeneratedClient::App::EnvironmentUsage`. 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?(:'flag_rules')
+        self.flag_rules = attributes[:'flag_rules']
+      else
+        self.flag_rules = nil
+      end
+
+      if attributes.key?(:'flag_env_defaults')
+        self.flag_env_defaults = attributes[:'flag_env_defaults']
+      else
+        self.flag_env_defaults = nil
+      end
+
+      if attributes.key?(:'config_overrides')
+        self.config_overrides = attributes[:'config_overrides']
+      else
+        self.config_overrides = nil
+      end
+
+      if attributes.key?(:'logger_overrides')
+        self.logger_overrides = attributes[:'logger_overrides']
+      else
+        self.logger_overrides = 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 @flag_rules.nil?
+        invalid_properties.push('invalid value for "flag_rules", flag_rules cannot be nil.')
+      end
+
+      if @flag_rules < 0
+        invalid_properties.push('invalid value for "flag_rules", must be greater than or equal to 0.')
+      end
+
+      if @flag_env_defaults.nil?
+        invalid_properties.push('invalid value for "flag_env_defaults", flag_env_defaults cannot be nil.')
+      end
+
+      if @flag_env_defaults < 0
+        invalid_properties.push('invalid value for "flag_env_defaults", must be greater than or equal to 0.')
+      end
+
+      if @config_overrides.nil?
+        invalid_properties.push('invalid value for "config_overrides", config_overrides cannot be nil.')
+      end
+
+      if @config_overrides < 0
+        invalid_properties.push('invalid value for "config_overrides", must be greater than or equal to 0.')
+      end
+
+      if @logger_overrides.nil?
+        invalid_properties.push('invalid value for "logger_overrides", logger_overrides cannot be nil.')
+      end
+
+      if @logger_overrides < 0
+        invalid_properties.push('invalid value for "logger_overrides", must be greater than or equal to 0.')
+      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 @flag_rules.nil?
+      return false if @flag_rules < 0
+      return false if @flag_env_defaults.nil?
+      return false if @flag_env_defaults < 0
+      return false if @config_overrides.nil?
+      return false if @config_overrides < 0
+      return false if @logger_overrides.nil?
+      return false if @logger_overrides < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flag_rules Value to be assigned
+    def flag_rules=(flag_rules)
+      if flag_rules.nil?
+        fail ArgumentError, 'flag_rules cannot be nil'
+      end
+
+      if flag_rules < 0
+        fail ArgumentError, 'invalid value for "flag_rules", must be greater than or equal to 0.'
+      end
+
+      @flag_rules = flag_rules
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flag_env_defaults Value to be assigned
+    def flag_env_defaults=(flag_env_defaults)
+      if flag_env_defaults.nil?
+        fail ArgumentError, 'flag_env_defaults cannot be nil'
+      end
+
+      if flag_env_defaults < 0
+        fail ArgumentError, 'invalid value for "flag_env_defaults", must be greater than or equal to 0.'
+      end
+
+      @flag_env_defaults = flag_env_defaults
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] config_overrides Value to be assigned
+    def config_overrides=(config_overrides)
+      if config_overrides.nil?
+        fail ArgumentError, 'config_overrides cannot be nil'
+      end
+
+      if config_overrides < 0
+        fail ArgumentError, 'invalid value for "config_overrides", must be greater than or equal to 0.'
+      end
+
+      @config_overrides = config_overrides
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] logger_overrides Value to be assigned
+    def logger_overrides=(logger_overrides)
+      if logger_overrides.nil?
+        fail ArgumentError, 'logger_overrides cannot be nil'
+      end
+
+      if logger_overrides < 0
+        fail ArgumentError, 'invalid value for "logger_overrides", must be greater than or equal to 0.'
+      end
+
+      @logger_overrides = logger_overrides
+    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 &&
+          flag_rules == o.flag_rules &&
+          flag_env_defaults == o.flag_env_defaults &&
+          config_overrides == o.config_overrides &&
+          logger_overrides == o.logger_overrides
+    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
+      [flag_rules, flag_env_defaults, config_overrides, logger_overrides].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/smplkit/_generated/app/lib/smplkit_app_client/models/environment_usage_resource.rb

@@ -0,0 +1,225 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for an environment-usage report.
+  class EnvironmentUsageResource < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :attributes
+
+    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',
+        :'attributes' => :'attributes'
+      }
+    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',
+        :'attributes' => :'EnvironmentUsage'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id',
+      ])
+    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 `SmplkitGeneratedClient::App::EnvironmentUsageResource` 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 `SmplkitGeneratedClient::App::EnvironmentUsageResource`. 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']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      else
+        self.attributes = 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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["environment_usage"])
+      return false unless type_validator.valid?(@type)
+      return false if @attributes.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["environment_usage"])
+      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 with validation
+    # @param [Object] attributes Value to be assigned
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'attributes cannot be nil'
+      end
+
+      @attributes = attributes
+    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 &&
+          attributes == o.attributes
+    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, attributes].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/smplkit/_generated/app/lib/smplkit_app_client/models/environment_usage_response.rb

@@ -0,0 +1,165 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for environment-usage counts.
+  class EnvironmentUsageResponse < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'EnvironmentUsageResource'
+      }
+    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 `SmplkitGeneratedClient::App::EnvironmentUsageResponse` 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 `SmplkitGeneratedClient::App::EnvironmentUsageResponse`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          data == o.data
+    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
+      [data].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/smplkit/_generated/app/lib/smplkit_app_client.rb

@@ -57,6 +57,9 @@ require 'smplkit_app_client/models/environment_list_response'
 require 'smplkit_app_client/models/environment_request'
 require 'smplkit_app_client/models/environment_resource'
 require 'smplkit_app_client/models/environment_response'
+require 'smplkit_app_client/models/environment_usage'
+require 'smplkit_app_client/models/environment_usage_resource'
+require 'smplkit_app_client/models/environment_usage_response'
 require 'smplkit_app_client/models/error'
 require 'smplkit_app_client/models/error_response'
 require 'smplkit_app_client/models/invitation'

data/lib/smplkit/_generated/app/spec/api/environments_api_spec.rb

@@ -46,9 +46,10 @@ describe 'EnvironmentsApi' do
 
   # unit tests for delete_environment
   # Delete Environment
-  # Delete an environment by id.
+  # Delete an environment by id. When `cascade=true` is set, also remove every per-environment reference held by flags, configs, and loggers in the corresponding services before deleting the environment row. The default `cascade=false` deletes only the environment row, leaving downstream references in place.
   # @param id 
   # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :cascade When `true`, remove every flag rule, env-level flag default, config override, and logger override scoped to this environment before deleting the environment row.
   # @return [nil]
   describe 'delete_environment test' do
     it 'should work' do
@@ -68,6 +69,18 @@ describe 'EnvironmentsApi' do
     end
   end
 
+  # unit tests for get_environment_usage
+  # Report Environment Usage
+  # Report how many flag rules, env-level flag defaults, config overrides, and logger overrides reference this environment. Used by the console's delete dialog so the user can see what would survive a non-cascading delete.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [EnvironmentUsageResponse]
+  describe 'get_environment_usage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for list_environments
   # List Environments
   # List all environments for the authenticated account.

data/lib/smplkit/_generated/app/spec/models/environment_usage_resource_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::EnvironmentUsageResource
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::EnvironmentUsageResource do
+  #let(:instance) { SmplkitGeneratedClient::App::EnvironmentUsageResource.new }
+
+  describe 'test an instance of EnvironmentUsageResource' do
+    it 'should create an instance of EnvironmentUsageResource' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::EnvironmentUsageResource)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["environment_usage"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "attributes"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/app/spec/models/environment_usage_response_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::EnvironmentUsageResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::EnvironmentUsageResponse do
+  #let(:instance) { SmplkitGeneratedClient::App::EnvironmentUsageResponse.new }
+
+  describe 'test an instance of EnvironmentUsageResponse' do
+    it 'should create an instance of EnvironmentUsageResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::EnvironmentUsageResponse)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/app/spec/models/environment_usage_spec.rb

@@ -0,0 +1,54 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::EnvironmentUsage
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::EnvironmentUsage do
+  #let(:instance) { SmplkitGeneratedClient::App::EnvironmentUsage.new }
+
+  describe 'test an instance of EnvironmentUsage' do
+    it 'should create an instance of EnvironmentUsage' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::EnvironmentUsage)
+    end
+  end
+
+  describe 'test attribute "flag_rules"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "flag_env_defaults"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "config_overrides"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "logger_overrides"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -210,6 +210,9 @@ files:
 - lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_request.rb
 - lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_resource.rb
 - lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_response.rb
+- lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_usage.rb
+- lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_usage_resource.rb
+- lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_usage_response.rb
 - lib/smplkit/_generated/app/lib/smplkit_app_client/models/error.rb
 - lib/smplkit/_generated/app/lib/smplkit_app_client/models/error_response.rb
 - lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb
@@ -327,6 +330,9 @@ files:
 - lib/smplkit/_generated/app/spec/models/environment_resource_spec.rb
 - lib/smplkit/_generated/app/spec/models/environment_response_spec.rb
 - lib/smplkit/_generated/app/spec/models/environment_spec.rb
+- lib/smplkit/_generated/app/spec/models/environment_usage_resource_spec.rb
+- lib/smplkit/_generated/app/spec/models/environment_usage_response_spec.rb
+- lib/smplkit/_generated/app/spec/models/environment_usage_spec.rb
 - lib/smplkit/_generated/app/spec/models/error_response_spec.rb
 - lib/smplkit/_generated/app/spec/models/error_spec.rb
 - lib/smplkit/_generated/app/spec/models/invitation_accept_request_spec.rb