smplkit 2.0.12 → 2.0.14

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API collection response envelope for flags.
   class FlagListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_request.rb

@@ -0,0 +1,165 @@
+=begin
+#smplkit Flags API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+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::Flags
+  # JSON:API request envelope for creating or updating a flag.
+  class FlagRequest < 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' => :'FlagResource'
+      }
+    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::Flags::FlagRequest` 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::Flags::FlagRequest`. 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/flags/lib/smplkit_flags_client/models/flag_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API resource envelope for a flag.  `id` is the flag key. For create requests, `id` is required and is chosen by the caller. For update requests, `id` may be omitted (the server reads the key from the URL) or supplied to rename the flag.
   class FlagResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API single-resource response envelope for a flag.
   class FlagResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_rule.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # A targeting rule that overrides the default within an environment.
   class FlagRule < ApiModelBase
+    # Human-readable description of the rule.
     attr_accessor :description
 
+    # JSON Logic expression evaluated against the evaluation context. The rule fires when the expression is truthy.
     attr_accessor :logic
 
     attr_accessor :value

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source.rb

@@ -14,29 +14,62 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # A record of an SDK observing a feature flag from a particular service and environment.  The flags service auto-registers a source the first time an SDK reports a flag from a given service/environment pair and refreshes `last_seen` on every subsequent report. Each source captures the value type and default value the SDK declared in source code at that location, which makes it possible to detect when service code has drifted from the flag's authoritative configuration.
   class FlagSource < ApiModelBase
+    # Service that declared the flag.
     attr_accessor :service
 
+    # Environment in which the service declared the flag.
     attr_accessor :environment
 
+    # Value type the SDK reported when registering the flag from this service/environment. May differ from the flag's authoritative `type` if the service is running stale code.
+    attr_accessor :declared_type
+
+    attr_accessor :declared_default
+
+    # When this source was first observed.
     attr_accessor :first_observed
 
+    # Most recent time the SDK re-registered this source.
     attr_accessor :last_seen
 
-    attr_accessor :data
-
+    # When the source record was created.
     attr_accessor :created_at
 
+    # When the source record was last modified.
     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
       {
         :'service' => :'service',
         :'environment' => :'environment',
+        :'declared_type' => :'declared_type',
+        :'declared_default' => :'declared_default',
         :'first_observed' => :'first_observed',
         :'last_seen' => :'last_seen',
-        :'data' => :'data',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
       }
@@ -57,9 +90,10 @@ module SmplkitGeneratedClient::Flags
       {
         :'service' => :'String',
         :'environment' => :'String',
+        :'declared_type' => :'String',
+        :'declared_default' => :'Object',
         :'first_observed' => :'Time',
         :'last_seen' => :'Time',
-        :'data' => :'Hash<String, Object>',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
       }
@@ -68,9 +102,12 @@ module SmplkitGeneratedClient::Flags
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'service',
+        :'environment',
+        :'declared_type',
+        :'declared_default',
         :'first_observed',
         :'last_seen',
-        :'data',
         :'created_at',
         :'updated_at'
       ])
@@ -100,6 +137,14 @@ module SmplkitGeneratedClient::Flags
         self.environment = attributes[:'environment']
       end
 
+      if attributes.key?(:'declared_type')
+        self.declared_type = attributes[:'declared_type']
+      end
+
+      if attributes.key?(:'declared_default')
+        self.declared_default = attributes[:'declared_default']
+      end
+
       if attributes.key?(:'first_observed')
         self.first_observed = attributes[:'first_observed']
       end
@@ -108,12 +153,6 @@ module SmplkitGeneratedClient::Flags
         self.last_seen = attributes[:'last_seen']
       end
 
-      if attributes.key?(:'data')
-        if (value = attributes[:'data']).is_a?(Hash)
-          self.data = value
-        end
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -135,9 +174,21 @@ module SmplkitGeneratedClient::Flags
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      declared_type_validator = EnumAttributeValidator.new('String', ["BOOLEAN", "STRING", "NUMERIC", "JSON"])
+      return false unless declared_type_validator.valid?(@declared_type)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] declared_type Object to be assigned
+    def declared_type=(declared_type)
+      validator = EnumAttributeValidator.new('String', ["BOOLEAN", "STRING", "NUMERIC", "JSON"])
+      unless validator.valid?(declared_type)
+        fail ArgumentError, "invalid value for \"declared_type\", must be one of #{validator.allowable_values}."
+      end
+      @declared_type = declared_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -145,9 +196,10 @@ module SmplkitGeneratedClient::Flags
       self.class == o.class &&
           service == o.service &&
           environment == o.environment &&
+          declared_type == o.declared_type &&
+          declared_default == o.declared_default &&
           first_observed == o.first_observed &&
           last_seen == o.last_seen &&
-          data == o.data &&
           created_at == o.created_at &&
           updated_at == o.updated_at
     end
@@ -161,7 +213,7 @@ module SmplkitGeneratedClient::Flags
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [service, environment, first_observed, last_seen, data, created_at, updated_at].hash
+      [service, environment, declared_type, declared_default, first_observed, last_seen, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API collection response envelope for flag sources.
   class FlagSourceListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_source_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API resource envelope for a flag source.  `id` is the source record's UUID. Sources are not created or modified directly — the flags service registers and refreshes them in response to SDK bulk-register requests.
   class FlagSourceResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/flag_value.rb

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # A named value in a constrained flag's value set.
   class FlagValue < ApiModelBase
+    # Human-readable label for the value.
     attr_accessor :name
 
     attr_accessor :value

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/manual_review_item.rb

@@ -14,13 +14,18 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # A flag rule that could not be safely modified by the bulk remove-references action.
   class ManualReviewItem < ApiModelBase
+    # Key of the flag containing the rule.
     attr_accessor :flag
 
+    # Environment containing the rule.
     attr_accessor :environment
 
+    # Position of the rule within the environment's `rules` array.
     attr_accessor :rule_index
 
+    # Why the rule needs manual review.
     attr_accessor :reason
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/remove_references_attributes.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # Counts and follow-ups returned by the remove-references action.
   class RemoveReferencesAttributes < ApiModelBase
+    # Keys of flags whose rules were modified.
     attr_accessor :flags_modified
 
+    # Total number of rules removed across all flags.
     attr_accessor :rules_removed
 
+    # Rules that referenced the context but could not be removed automatically (typically because the reference is inside an `and` expression where removal would broaden the rule).
     attr_accessor :rules_needing_manual_review
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/remove_references_request.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # Inputs to the remove-references action.  Exactly one of `context` or `context_type` must be provided.
   class RemoveReferencesRequest < ApiModelBase
+    # Identifier of the context instance to remove references to, formatted as `{type}:{key}` (e.g. `customer:c-123`).
     attr_accessor :context
 
+    # Context type to remove all references to (any attribute of this type).
     attr_accessor :context_type
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/remove_references_result_envelope.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API single-resource response envelope for the remove-references action.
   class RemoveReferencesResultEnvelope < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/remove_references_result_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API resource envelope for the remove-references result.
   class RemoveReferencesResultResource < ApiModelBase
     attr_accessor :type
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/usage_attributes.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # Usage counter for a single metered limit.
   class UsageAttributes < ApiModelBase
+    # Identifier of the metered limit, e.g. `flags.items`.
     attr_accessor :limit_key
 
+    # Period the counter covers. `current` is the only supported value.
     attr_accessor :period
 
+    # Count for the period.
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/usage_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API collection response envelope for usage counters.
   class UsageListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client/models/usage_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Flags
+  # JSON:API resource envelope for a usage counter.
   class UsageResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/flags/lib/smplkit_flags_client.rb

@@ -24,6 +24,7 @@ require 'smplkit_flags_client/models/flag_bulk_request'
 require 'smplkit_flags_client/models/flag_bulk_response'
 require 'smplkit_flags_client/models/flag_environment'
 require 'smplkit_flags_client/models/flag_list_response'
+require 'smplkit_flags_client/models/flag_request'
 require 'smplkit_flags_client/models/flag_resource'
 require 'smplkit_flags_client/models/flag_response'
 require 'smplkit_flags_client/models/flag_rule'

data/lib/smplkit/_generated/flags/spec/api/flag_sources_api_spec.rb

@@ -34,7 +34,7 @@ describe 'FlagSourcesApi' do
 
   # unit tests for list_all_flag_sources
   # List All Flag Sources
-  # List all flag sources across all flags. Optionally filter by environment or service.
+  # List service/environment observations across all flags for this account.  Filter by `environment` or `service` (or both) to narrow the result.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_environment 
   # @option opts [String] :filter_service 
@@ -47,7 +47,7 @@ describe 'FlagSourcesApi' do
 
   # unit tests for list_flag_sources
   # List Flag Sources
-  # List all sources (service/environment observations) for a specific flag.
+  # List the service/environment observations recorded for a single flag.
   # @param id 
   # @param [Hash] opts the optional parameters
   # @return [FlagSourceListResponse]

data/lib/smplkit/_generated/flags/spec/api/flags_api_spec.rb

@@ -34,7 +34,7 @@ describe 'FlagsApi' do
 
   # unit tests for bulk_register_flags
   # Bulk Register Flags
-  # Register flags discovered by an SDK. Creates new flags or updates source observations on existing ones.
+  # Register flags discovered by an SDK.  Creates a new flag for each unreported key and refreshes the service/environment source observation on each already-known key.
   # @param flag_bulk_request 
   # @param [Hash] opts the optional parameters
   # @return [FlagBulkResponse]
@@ -46,8 +46,8 @@ describe 'FlagsApi' do
 
   # unit tests for create_flag
   # Create Flag
-  # Create a new feature flag. The caller provides the id (key) in the request body.
-  # @param flag_response 
+  # Create a new feature flag. The caller provides the id (the flag key) in the request body.
+  # @param flag_request 
   # @param [Hash] opts the optional parameters
   # @return [FlagResponse]
   describe 'create_flag test' do
@@ -70,7 +70,7 @@ describe 'FlagsApi' do
 
   # unit tests for get_flag
   # Get Flag
-  # Return a feature flag by its key.
+  # Retrieve a feature flag by its key.
   # @param id 
   # @param [Hash] opts the optional parameters
   # @return [FlagResponse]
@@ -82,7 +82,7 @@ describe 'FlagsApi' do
 
   # unit tests for list_flags
   # List Flags
-  # List all feature flags for the authenticated account.
+  # List feature flags for this account.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_type 
   # @option opts [Boolean] :filter_managed 
@@ -97,9 +97,9 @@ describe 'FlagsApi' do
 
   # unit tests for update_flag
   # Update Flag
-  # Replace a feature flag entirely.
+  # Replace a feature flag entirely. Every writable field is overwritten.
   # @param id 
-  # @param flag_response 
+  # @param flag_request 
   # @param [Hash] opts the optional parameters
   # @return [FlagResponse]
   describe 'update_flag test' do

data/lib/smplkit/_generated/flags/spec/api/functions_api_spec.rb

@@ -34,7 +34,7 @@ describe 'FunctionsApi' do
 
   # unit tests for remove_references
   # Execute Remove References
-  # Bulk-remove context references from flag rules.  Traverses every flag in the account, removes rules that reference the specified context, and emits a single flags_changed event when done.
+  # Remove every rule that references a specific context across every flag.  Provide exactly one of `context` (matches a single instance, formatted as `{type}:{key}`) or `context_type` (matches any attribute of that context type). Rules whose reference sits inside an AND expression are not removed automatically; they are returned in `rules_needing_manual_review` for the caller to handle.
   # @param remove_references_request 
   # @param [Hash] opts the optional parameters
   # @return [RemoveReferencesResultEnvelope]

data/lib/smplkit/_generated/flags/spec/api/usage_api_spec.rb

@@ -34,7 +34,7 @@ describe 'UsageApi' do
 
   # unit tests for list_flags_usage
   # List Flags Usage
-  # Return current resource usage counts for the authenticated account.
+  # Report current-period usage counters for this account.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_period 
   # @return [UsageListResponse]

data/lib/smplkit/_generated/flags/spec/models/flag_bulk_item_spec.rb

@@ -36,6 +36,10 @@ describe SmplkitGeneratedClient::Flags::FlagBulkItem do
   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', ["BOOLEAN", "STRING", "NUMERIC", "JSON"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.type = value }.not_to raise_error
+      # end
     end
   end
 

data/lib/smplkit/_generated/flags/spec/models/flag_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#smplkit Flags API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+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::Flags::FlagRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Flags::FlagRequest do
+  #let(:instance) { SmplkitGeneratedClient::Flags::FlagRequest.new }
+
+  describe 'test an instance of FlagRequest' do
+    it 'should create an instance of FlagRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Flags::FlagRequest)
+    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