smplkit 2.0.9 → 2.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7197e7fb7387753aa3c144355cd6e45ed5e5115c622427627cbd6af366c2198f
-  data.tar.gz: 263fbb7eff2305226c8c4a7e6f4edeea8d4ff812c5c6fe6a4f12c0e50dae58b1
+  metadata.gz: 11d1397bb7c77eeb63a28eb21bf9aab0688feffe5e8df6339c363511713ac843
+  data.tar.gz: 8efcc6ad6061be18bbf48fb5993dffd693a9f2b1243a0b091fde72fbe46830c5
 SHA512:
-  metadata.gz: f9217bcf8d6bbec98a99e5ef046800502c7bf10978e198f7ad24d982fbd81bf28dbf6dd47863432cf2f462d8cdda7e48c7e2752d7c68a7ec95ec55b9eed448fa
-  data.tar.gz: f0e3441e536110e321aac911c5ceeca749104c41522e61ee0f3b09e12c606ea80786a656b785258526677ff37f87d731e36acb4c1f5adef6661d4cd0cfb57bae
+  metadata.gz: 936f0a2efbad65c8a7904b18ed28e0508892bbd4d641e6ed7774eba0df22c1c64aabe7f24780e0f2f31e5303905b58c3464122bff83f7c18863e81a3fcfe3dca
+  data.tar.gz: a0ec336127cd5a0d72bc943d0dda7e5df277cc010d4e6641699136b8d8eaecdad0b3eeab94f6c4ac54f5117109930b90f07e3e5df99f86724385a042b6a4099b

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb

@@ -280,11 +280,12 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Forwarder Deliveries
-    # List delivery rows for a forwarder.  Default sort is ``-created_at``. Cursor pagination via ``page[after]``. Filter by status (``succeeded`` / ``failed`` / ``filtered_out`` / ``skipped_do_not_forward``) or by a ``created_at`` range using the platform's interval notation (``[2026-01-01T00:00:00Z,*)``). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
+    # List delivery rows for a forwarder.  Default sort is ``-created_at``. Cursor pagination via ``page[after]``. Filter by status (``SUCCEEDED`` / ``FAILED`` / ``FILTERED_OUT`` / ``SKIPPED_DO_NOT_FORWARD``, case-insensitive) or by a ``created_at`` range using the platform's interval notation (``[2026-01-01T00:00:00Z,*)``). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_status 
     # @option opts [String] :filter_created_at 
+    # @option opts [String] :filter_event_id 
     # @option opts [Integer] :page_size 
     # @option opts [String] :page_after 
     # @return [ForwarderDeliveryListResponse]
@@ -294,11 +295,12 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Forwarder Deliveries
-    # List delivery rows for a forwarder.  Default sort is ``-created_at``. Cursor pagination via ``page[after]``. Filter by status (``succeeded`` / ``failed`` / ``filtered_out`` / ``skipped_do_not_forward``) or by a ``created_at`` range using the platform's interval notation (``[2026-01-01T00:00:00Z,*)``). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
+    # List delivery rows for a forwarder.  Default sort is ``-created_at``. Cursor pagination via ``page[after]``. Filter by status (``SUCCEEDED`` / ``FAILED`` / ``FILTERED_OUT`` / ``SKIPPED_DO_NOT_FORWARD``, case-insensitive) or by a ``created_at`` range using the platform's interval notation (``[2026-01-01T00:00:00Z,*)``). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_status 
     # @option opts [String] :filter_created_at 
+    # @option opts [String] :filter_event_id 
     # @option opts [Integer] :page_size 
     # @option opts [String] :page_after 
     # @return [Array<(ForwarderDeliveryListResponse, Integer, Hash)>] ForwarderDeliveryListResponse data, response status code and response headers
@@ -321,6 +323,7 @@ module SmplkitGeneratedClient::Audit
       query_params = opts[:query_params] || {}
       query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
       query_params[:'filter[created_at]'] = opts[:'filter_created_at'] if !opts[:'filter_created_at'].nil?
+      query_params[:'filter[event_id]'] = opts[:'filter_event_id'] if !opts[:'filter_event_id'].nil?
       query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
 

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb

@@ -211,7 +211,7 @@ module SmplkitGeneratedClient::Audit
       return false if @event_id.nil?
       return false if @attempt_number.nil?
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["succeeded", "failed", "filtered_out", "skipped_do_not_forward"])
+      status_validator = EnumAttributeValidator.new('String', ["SUCCEEDED", "FAILED", "FILTERED_OUT", "SKIPPED_DO_NOT_FORWARD"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -249,7 +249,7 @@ module SmplkitGeneratedClient::Audit
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["succeeded", "failed", "filtered_out", "skipped_do_not_forward"])
+      validator = EnumAttributeValidator.new('String', ["SUCCEEDED", "FAILED", "FILTERED_OUT", "SKIPPED_DO_NOT_FORWARD"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_type.rb

@@ -15,13 +15,13 @@ require 'time'
 
 module SmplkitGeneratedClient::Audit
   class ForwarderType
-    HTTP = "http".freeze
-    DATADOG = "datadog".freeze
-    SPLUNK_HEC = "splunk_hec".freeze
-    SUMO_LOGIC = "sumo_logic".freeze
-    NEW_RELIC = "new_relic".freeze
-    HONEYCOMB = "honeycomb".freeze
-    ELASTIC = "elastic".freeze
+    HTTP = "HTTP".freeze
+    DATADOG = "DATADOG".freeze
+    SPLUNK_HEC = "SPLUNK_HEC".freeze
+    SUMO_LOGIC = "SUMO_LOGIC".freeze
+    NEW_RELIC = "NEW_RELIC".freeze
+    HONEYCOMB = "HONEYCOMB".freeze
+    ELASTIC = "ELASTIC".freeze
 
     def self.all_vars
       @all_vars ||= [HTTP, DATADOG, SPLUNK_HEC, SUMO_LOGIC, NEW_RELIC, HONEYCOMB, ELASTIC].freeze

data/lib/smplkit/_generated/audit/spec/api/forwarders_api_spec.rb

@@ -82,11 +82,12 @@ describe 'ForwardersApi' do
 
   # unit tests for list_forwarder_deliveries
   # List Forwarder Deliveries
-  # List delivery rows for a forwarder.  Default sort is ``-created_at``. Cursor pagination via ``page[after]``. Filter by status (``succeeded`` / ``failed`` / ``filtered_out`` / ``skipped_do_not_forward``) or by a ``created_at`` range using the platform's interval notation (``[2026-01-01T00:00:00Z,*)``). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
+  # List delivery rows for a forwarder.  Default sort is ``-created_at``. Cursor pagination via ``page[after]``. Filter by status (``SUCCEEDED`` / ``FAILED`` / ``FILTERED_OUT`` / ``SKIPPED_DO_NOT_FORWARD``, case-insensitive) or by a ``created_at`` range using the platform's interval notation (``[2026-01-01T00:00:00Z,*)``). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
   # @param forwarder_id 
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_status 
   # @option opts [String] :filter_created_at 
+  # @option opts [String] :filter_event_id 
   # @option opts [Integer] :page_size 
   # @option opts [String] :page_after 
   # @return [ForwarderDeliveryListResponse]

data/lib/smplkit/_generated/audit/spec/models/forwarder_delivery_spec.rb

@@ -48,7 +48,7 @@ describe SmplkitGeneratedClient::Audit::ForwarderDelivery do
   describe 'test attribute "status"' 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', ["succeeded", "failed", "filtered_out", "skipped_do_not_forward"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["SUCCEEDED", "FAILED", "FILTERED_OUT", "SKIPPED_DO_NOT_FORWARD"])
       # validator.allowable_values.each do |value|
       #   expect { instance.status = value }.not_to raise_error
       # end

data/lib/smplkit/_generated/config/lib/smplkit_config_client/api/configs_api.rb

@@ -20,27 +20,27 @@ module SmplkitGeneratedClient::Config
       @api_client = api_client
     end
     # Create Config
-    # Create a new configuration. The caller provides the id (key) in the request body.
-    # @param config_response [ConfigResponse] 
+    # Create a config for this account.  The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
+    # @param config_request [ConfigRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ConfigResponse]
-    def create_config(config_response, opts = {})
-      data, _status_code, _headers = create_config_with_http_info(config_response, opts)
+    def create_config(config_request, opts = {})
+      data, _status_code, _headers = create_config_with_http_info(config_request, opts)
       data
     end
 
     # Create Config
-    # Create a new configuration. The caller provides the id (key) in the request body.
-    # @param config_response [ConfigResponse] 
+    # Create a config for this account.  The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
+    # @param config_request [ConfigRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
-    def create_config_with_http_info(config_response, opts = {})
+    def create_config_with_http_info(config_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConfigsApi.create_config ...'
       end
-      # verify the required parameter 'config_response' is set
-      if @api_client.config.client_side_validation && config_response.nil?
-        fail ArgumentError, "Missing the required parameter 'config_response' when calling ConfigsApi.create_config"
+      # verify the required parameter 'config_request' is set
+      if @api_client.config.client_side_validation && config_request.nil?
+        fail ArgumentError, "Missing the required parameter 'config_request' when calling ConfigsApi.create_config"
       end
       # resource path
       local_var_path = '/api/v1/configs'
@@ -62,7 +62,7 @@ module SmplkitGeneratedClient::Config
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(config_response)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(config_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ConfigResponse'
@@ -88,7 +88,7 @@ module SmplkitGeneratedClient::Config
     end
 
     # Delete Config
-    # Delete a configuration by its key.
+    # Delete a config by its key.  A config that is referenced as `parent` by another config cannot be deleted; reparent or remove the parent reference on every child first. The `common` config cannot be deleted.
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -98,7 +98,7 @@ module SmplkitGeneratedClient::Config
     end
 
     # Delete Config
-    # Delete a configuration by its key.
+    # Delete a config by its key.  A config that is referenced as &#x60;parent&#x60; by another config cannot be deleted; reparent or remove the parent reference on every child first. The &#x60;common&#x60; config cannot be deleted.
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -149,7 +149,7 @@ module SmplkitGeneratedClient::Config
     end
 
     # Get Config
-    # Return a configuration by its key.
+    # Retrieve a single config by its key.
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [ConfigResponse]
@@ -159,7 +159,7 @@ module SmplkitGeneratedClient::Config
     end
 
     # Get Config
-    # Return a configuration by its key.
+    # Retrieve a single config by its key.
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
@@ -212,7 +212,7 @@ module SmplkitGeneratedClient::Config
     end
 
     # List Configs
-    # List all configurations for the authenticated account.
+    # List configs for this account.  Pass `filter[parent]=<parent_key>` to return only the direct children of a specific config.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_parent 
     # @return [ConfigListResponse]
@@ -222,7 +222,7 @@ module SmplkitGeneratedClient::Config
     end
 
     # List Configs
-    # List all configurations for the authenticated account.
+    # List configs for this account.  Pass &#x60;filter[parent]&#x3D;&lt;parent_key&gt;&#x60; to return only the direct children of a specific config.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_parent 
     # @return [Array<(ConfigListResponse, Integer, Hash)>] ConfigListResponse data, response status code and response headers
@@ -272,23 +272,23 @@ module SmplkitGeneratedClient::Config
     end
 
     # Update Config
-    # Replace a configuration entirely.
+    # Replace a config entirely. Every writable field is overwritten.
     # @param id [String] 
-    # @param config_response [ConfigResponse] 
+    # @param config_request [ConfigRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ConfigResponse]
-    def update_config(id, config_response, opts = {})
-      data, _status_code, _headers = update_config_with_http_info(id, config_response, opts)
+    def update_config(id, config_request, opts = {})
+      data, _status_code, _headers = update_config_with_http_info(id, config_request, opts)
       data
     end
 
     # Update Config
-    # Replace a configuration entirely.
+    # Replace a config entirely. Every writable field is overwritten.
     # @param id [String] 
-    # @param config_response [ConfigResponse] 
+    # @param config_request [ConfigRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ConfigResponse, Integer, Hash)>] ConfigResponse data, response status code and response headers
-    def update_config_with_http_info(id, config_response, opts = {})
+    def update_config_with_http_info(id, config_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConfigsApi.update_config ...'
       end
@@ -296,9 +296,9 @@ module SmplkitGeneratedClient::Config
       if @api_client.config.client_side_validation && id.nil?
         fail ArgumentError, "Missing the required parameter 'id' when calling ConfigsApi.update_config"
       end
-      # verify the required parameter 'config_response' is set
-      if @api_client.config.client_side_validation && config_response.nil?
-        fail ArgumentError, "Missing the required parameter 'config_response' when calling ConfigsApi.update_config"
+      # verify the required parameter 'config_request' is set
+      if @api_client.config.client_side_validation && config_request.nil?
+        fail ArgumentError, "Missing the required parameter 'config_request' when calling ConfigsApi.update_config"
       end
       # resource path
       local_var_path = '/api/v1/configs/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -320,7 +320,7 @@ module SmplkitGeneratedClient::Config
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(config_response)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(config_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ConfigResponse'

data/lib/smplkit/_generated/config/lib/smplkit_config_client/api/usage_api.rb

@@ -20,9 +20,9 @@ module SmplkitGeneratedClient::Config
       @api_client = api_client
     end
     # List Config Usage
-    # Return current resource usage counts for the authenticated account.
+    # Report the current-period usage counters for this account.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter_period 
+    # @option opts [String] :filter_period Period to report. `current` is the only supported value.
     # @return [UsageListResponse]
     def list_config_usage(opts = {})
       data, _status_code, _headers = list_config_usage_with_http_info(opts)
@@ -30,9 +30,9 @@ module SmplkitGeneratedClient::Config
     end
 
     # List Config Usage
-    # Return current resource usage counts for the authenticated account.
+    # Report the current-period usage counters for this account.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter_period 
+    # @option opts [String] :filter_period Period to report. `current` is the only supported value.
     # @return [Array<(UsageListResponse, Integer, Hash)>] UsageListResponse data, response status code and response headers
     def list_config_usage_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config.rb

@@ -14,19 +14,27 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
+  # A named bag of configuration items, optionally inheriting from another config.  Items are typed key/value pairs (`STRING`, `NUMBER`, `BOOLEAN`, `JSON`). Configs may declare per-environment overrides for any item declared on the config itself or anywhere in its inheritance chain; resolving a config against an environment merges the chain top-down and then applies the matching overrides.
   class Config < ApiModelBase
+    # Human-readable name for the config.
     attr_accessor :name
 
+    # Optional human-readable description of what this config holds.
     attr_accessor :description
 
+    # Key of another config to inherit items from. Inherited items appear as if declared on this config; locally declared items with the same key shadow them. Omit or set to `null` for a standalone config with no parent.
     attr_accessor :parent
 
+    # Map of item keys to item definitions declared on this config. Keys must be unique within the config; declared types are immutable once set and must match any type declared for the same key on an ancestor.
     attr_accessor :items
 
+    # Map of environment keys to per-environment override sets. An environment override applies when this config is resolved against that environment.
     attr_accessor :environments
 
+    # When the config was created.
     attr_accessor :created_at
 
+    # When the config was last modified.
     attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_definition.rb

@@ -14,12 +14,14 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
-  # Schema for a single config item.  ``value`` may be ``None`` to represent a cleared (typed but unset) slot — e.g. after a type change that could not coerce the previous value. See ADR-024.
+  # Type-declared item within a config.  Each item carries a value plus a declared type that constrains the value and any per-environment overrides for the same key.
   class ConfigItemDefinition < ApiModelBase
     attr_accessor :value
 
+    # Declared value type. Constrains the JSON shape of `value` and of every override of this key in the `environments` map.
     attr_accessor :type
 
+    # Optional human-readable explanation of what this item controls.
     attr_accessor :description
 
     class EnumAttributeValidator

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_override.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
-  # Schema for an environment override — value only, no type/description.
+  # Per-environment override of a single item value.
   class ConfigItemOverride < ApiModelBase
     attr_accessor :value
 

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
+  # JSON:API collection response for configs.
   class ConfigListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_request.rb

@@ -0,0 +1,165 @@
+=begin
+#smplkit Config API
+
+#Configuration management API for smplkit.
+
+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::Config
+  # JSON:API request envelope for creating or updating a config.
+  class ConfigRequest < 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' => :'ConfigResource'
+      }
+    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::Config::ConfigRequest` 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::Config::ConfigRequest`. 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/config/lib/smplkit_config_client/models/config_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
+  # JSON:API resource envelope for a config.  `id` is the human-readable key for the config and must be supplied by the caller on create. It is unique within the account.
   class ConfigResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_response.rb

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

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/environment_override.rb

@@ -14,8 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
-  # Schema for per-environment overrides.
+  # Per-environment override set for a config.
   class EnvironmentOverride < ApiModelBase
+    # Map of item keys to override values that apply when this environment is resolved. Each key must already be declared (with a type) on this config or one of its ancestors.
     attr_accessor :values
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/usage_attributes.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Config
+  # Usage counter for a single metered limit.
   class UsageAttributes < ApiModelBase
+    # Identifier of the metered limit, e.g. `config.items` or `config.inheritance_depth`.
     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/config/lib/smplkit_config_client/models/usage_list_response.rb

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

data/lib/smplkit/_generated/config/lib/smplkit_config_client/models/usage_resource.rb

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

data/lib/smplkit/_generated/config/lib/smplkit_config_client.rb

@@ -22,6 +22,7 @@ require 'smplkit_config_client/models/config'
 require 'smplkit_config_client/models/config_item_definition'
 require 'smplkit_config_client/models/config_item_override'
 require 'smplkit_config_client/models/config_list_response'
+require 'smplkit_config_client/models/config_request'
 require 'smplkit_config_client/models/config_resource'
 require 'smplkit_config_client/models/config_response'
 require 'smplkit_config_client/models/environment_override'

data/lib/smplkit/_generated/config/spec/api/configs_api_spec.rb

@@ -34,8 +34,8 @@ describe 'ConfigsApi' do
 
   # unit tests for create_config
   # Create Config
-  # Create a new configuration. The caller provides the id (key) in the request body.
-  # @param config_response 
+  # Create a config for this account.  The caller supplies the config's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the config.
+  # @param config_request 
   # @param [Hash] opts the optional parameters
   # @return [ConfigResponse]
   describe 'create_config test' do
@@ -46,7 +46,7 @@ describe 'ConfigsApi' do
 
   # unit tests for delete_config
   # Delete Config
-  # Delete a configuration by its key.
+  # Delete a config by its key.  A config that is referenced as `parent` by another config cannot be deleted; reparent or remove the parent reference on every child first. The `common` config cannot be deleted.
   # @param id 
   # @param [Hash] opts the optional parameters
   # @return [nil]
@@ -58,7 +58,7 @@ describe 'ConfigsApi' do
 
   # unit tests for get_config
   # Get Config
-  # Return a configuration by its key.
+  # Retrieve a single config by its key.
   # @param id 
   # @param [Hash] opts the optional parameters
   # @return [ConfigResponse]
@@ -70,7 +70,7 @@ describe 'ConfigsApi' do
 
   # unit tests for list_configs
   # List Configs
-  # List all configurations for the authenticated account.
+  # List configs for this account.  Pass `filter[parent]=<parent_key>` to return only the direct children of a specific config.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :filter_parent 
   # @return [ConfigListResponse]
@@ -82,9 +82,9 @@ describe 'ConfigsApi' do
 
   # unit tests for update_config
   # Update Config
-  # Replace a configuration entirely.
+  # Replace a config entirely. Every writable field is overwritten.
   # @param id 
-  # @param config_response 
+  # @param config_request 
   # @param [Hash] opts the optional parameters
   # @return [ConfigResponse]
   describe 'update_config test' do

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

@@ -34,9 +34,9 @@ describe 'UsageApi' do
 
   # unit tests for list_config_usage
   # List Config Usage
-  # Return current resource usage counts for the authenticated account.
+  # Report the current-period usage counters for this account.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter_period 
+  # @option opts [String] :filter_period Period to report. `current` is the only supported value.
   # @return [UsageListResponse]
   describe 'list_config_usage test' do
     it 'should work' do

data/lib/smplkit/_generated/config/spec/models/config_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#smplkit Config API
+
+#Configuration management API for smplkit.
+
+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::Config::ConfigRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Config::ConfigRequest do
+  #let(:instance) { SmplkitGeneratedClient::Config::ConfigRequest.new }
+
+  describe 'test an instance of ConfigRequest' do
+    it 'should create an instance of ConfigRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Config::ConfigRequest)
+    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/audit/events.rb

@@ -71,7 +71,7 @@ module Smplkit
       # +#next_cursor+ is the opaque token for the next page (or nil).
       def list(action: nil, resource_type: nil, resource_id: nil,
                actor_type: nil, actor_id: nil, occurred_at_range: nil,
-               page_size: nil, page_after: nil)
+               search: nil, page_size: nil, page_after: nil)
         # Generated client opts use snake_case keys that internally map
         # to the JSON:API ``filter[*]`` / ``page[*]`` query-string format
         # (see default_api.rb#list_events_with_http_info). Without the
@@ -84,6 +84,7 @@ module Smplkit
         opts[:filter_actor_type] = actor_type if actor_type
         opts[:filter_actor_id] = actor_id if actor_id
         opts[:filter_occurred_at] = occurred_at_range if occurred_at_range
+        opts[:filter_search] = search if search
         opts[:page_size] = page_size if page_size
         opts[:page_after] = page_after if page_after
 

data/lib/smplkit/audit/forwarders.rb

@@ -10,13 +10,13 @@ module Smplkit
     # {Forwarders#list}. The wrapper validates membership before
     # round-tripping to the wire.
     module ForwarderType
-      HTTP = "http"
-      DATADOG = "datadog"
-      SPLUNK_HEC = "splunk_hec"
-      SUMO_LOGIC = "sumo_logic"
-      NEW_RELIC = "new_relic"
-      HONEYCOMB = "honeycomb"
-      ELASTIC = "elastic"
+      HTTP = "HTTP"
+      DATADOG = "DATADOG"
+      SPLUNK_HEC = "SPLUNK_HEC"
+      SUMO_LOGIC = "SUMO_LOGIC"
+      NEW_RELIC = "NEW_RELIC"
+      HONEYCOMB = "HONEYCOMB"
+      ELASTIC = "ELASTIC"
 
       # Every supported value, in spec order. Useful for membership
       # checks, dropdown population, or test parametrization.
@@ -129,10 +129,11 @@ module Smplkit
         @actions = DeliveryActions.new(api)
       end
 
-      def list(forwarder_id, status: nil, created_at_range: nil, page_size: nil, page_after: nil)
+      def list(forwarder_id, status: nil, created_at_range: nil, event_id: nil, page_size: nil, page_after: nil)
         opts = {}
         opts[:filter_status] = status if status
         opts[:filter_created_at] = created_at_range if created_at_range
+        opts[:filter_event_id] = event_id if event_id
         opts[:page_size] = page_size if page_size
         opts[:page_after] = page_after if page_after
         resp = @api.list_forwarder_deliveries(forwarder_id, opts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.0.11
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -478,6 +478,7 @@ files:
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_definition.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_item_override.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_list_response.rb
+- lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_request.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_resource.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/config_response.rb
 - lib/smplkit/_generated/config/lib/smplkit_config_client/models/environment_override.rb
@@ -490,6 +491,7 @@ files:
 - lib/smplkit/_generated/config/spec/models/config_item_definition_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_item_override_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_list_response_spec.rb
+- lib/smplkit/_generated/config/spec/models/config_request_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_resource_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_response_spec.rb
 - lib/smplkit/_generated/config/spec/models/config_spec.rb