smplkit 2.0.13 → 2.0.15

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

@@ -20,27 +20,27 @@ module SmplkitGeneratedClient::Audit
       @api_client = api_client
     end
     # Create Forwarder
-    # Create a forwarder. Requires the ``audit.siem_streaming`` entitlement on the account; lower-tier accounts get 402.
-    # @param forwarder_response [ForwarderResponse] 
+    # Create a forwarder for this account.
+    # @param forwarder_request [ForwarderRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ForwarderResponse]
-    def create_forwarder(forwarder_response, opts = {})
-      data, _status_code, _headers = create_forwarder_with_http_info(forwarder_response, opts)
+    def create_forwarder(forwarder_request, opts = {})
+      data, _status_code, _headers = create_forwarder_with_http_info(forwarder_request, opts)
       data
     end
 
     # Create Forwarder
-    # Create a forwarder. Requires the ``audit.siem_streaming`` entitlement on the account; lower-tier accounts get 402.
-    # @param forwarder_response [ForwarderResponse] 
+    # Create a forwarder for this account.
+    # @param forwarder_request [ForwarderRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ForwarderResponse, Integer, Hash)>] ForwarderResponse data, response status code and response headers
-    def create_forwarder_with_http_info(forwarder_response, opts = {})
+    def create_forwarder_with_http_info(forwarder_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ForwardersApi.create_forwarder ...'
       end
-      # verify the required parameter 'forwarder_response' is set
-      if @api_client.config.client_side_validation && forwarder_response.nil?
-        fail ArgumentError, "Missing the required parameter 'forwarder_response' when calling ForwardersApi.create_forwarder"
+      # verify the required parameter 'forwarder_request' is set
+      if @api_client.config.client_side_validation && forwarder_request.nil?
+        fail ArgumentError, "Missing the required parameter 'forwarder_request' when calling ForwardersApi.create_forwarder"
       end
       # resource path
       local_var_path = '/api/v1/forwarders'
@@ -62,7 +62,7 @@ module SmplkitGeneratedClient::Audit
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(forwarder_response)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(forwarder_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ForwarderResponse'
@@ -88,7 +88,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Delete Forwarder
-    # Soft-delete a forwarder. Delivery rows are retained per the normal forwarder_delivery retention; a future create with the same slug is allowed (the unique index is partial on deleted_at IS NULL).
+    # Delete a forwarder.  Past delivery log entries are retained. A new forwarder may be created later under the same name.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -98,7 +98,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Delete Forwarder
-    # Soft-delete a forwarder. Delivery rows are retained per the normal forwarder_delivery retention; a future create with the same slug is allowed (the unique index is partial on deleted_at IS NULL).
+    # Delete a forwarder.  Past delivery log entries are retained. A new forwarder may be created later under the same name.
     # @param forwarder_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::Audit
     end
 
     # Execute Test Forwarder
-    # Execute a prepared HTTP request server-side and return the response.  The same SSRF guard that gates the in-line forwarder loop is applied here — internal/private addresses, link-local IPs (including the EC2 metadata service at 169.254.169.254), unique-local IPv6, and ports outside the configured allowlist are all rejected.
+    # Send a test HTTP request to a forwarder destination and return the result.  Useful for verifying a destination URL, credentials, or transform before saving the forwarder. The same network-safety rules that apply to live deliveries (private/internal address blocking, port allowlist) apply here.
     # @param test_forwarder_request [TestForwarderRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TestForwarderResponse]
@@ -159,7 +159,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Execute Test Forwarder
-    # Execute a prepared HTTP request server-side and return the response.  The same SSRF guard that gates the in-line forwarder loop is applied here — internal/private addresses, link-local IPs (including the EC2 metadata service at 169.254.169.254), unique-local IPv6, and ports outside the configured allowlist are all rejected.
+    # Send a test HTTP request to a forwarder destination and return the result.  Useful for verifying a destination URL, credentials, or transform before saving the forwarder. The same network-safety rules that apply to live deliveries (private/internal address blocking, port allowlist) apply here.
     # @param test_forwarder_request [TestForwarderRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TestForwarderResponse, Integer, Hash)>] TestForwarderResponse data, response status code and response headers
@@ -217,7 +217,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Get Forwarder
-    # Retrieve a single forwarder by id.  Returns 404 if no forwarder with that id exists in the caller's account, including if the forwarder is soft-deleted. Header values in the response are returned in plaintext so callers can perform a GET-modify-PUT round-trip without re-entering secrets (ADR-014). The persisted ``forwarder_delivery.request`` log column is what keeps redaction; that read path is unaffected by this route.
+    # Retrieve a single forwarder by id.  Header values are returned in plaintext so the resource can be round-tripped with `GET`, mutate, `PUT` without re-entering secrets.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [ForwarderResponse]
@@ -227,7 +227,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Get Forwarder
-    # Retrieve a single forwarder by id.  Returns 404 if no forwarder with that id exists in the caller&#39;s account, including if the forwarder is soft-deleted. Header values in the response are returned in plaintext so callers can perform a GET-modify-PUT round-trip without re-entering secrets (ADR-014). The persisted &#x60;&#x60;forwarder_delivery.request&#x60;&#x60; log column is what keeps redaction; that read path is unaffected by this route.
+    # Retrieve a single forwarder by id.  Header values are returned in plaintext so the resource can be round-tripped with &#x60;GET&#x60;, mutate, &#x60;PUT&#x60; without re-entering secrets.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ForwarderResponse, Integer, Hash)>] ForwarderResponse data, response status code and response headers
@@ -280,7 +280,7 @@ 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``, 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.
+    # List delivery log entries for a forwarder.  Default sort is newest first. Filter by `status` (one of `SUCCEEDED`, `FAILED`, `FILTERED_OUT`, `SKIPPED_DO_NOT_FORWARD` — case-insensitive), by `event_id`, or by a `created_at` range using interval notation (e.g. `[2026-01-01T00:00:00Z,*)`).
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_status 
@@ -295,7 +295,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Forwarder Deliveries
-    # List delivery rows for a forwarder.  Default sort is &#x60;&#x60;-created_at&#x60;&#x60;. Cursor pagination via &#x60;&#x60;page[after]&#x60;&#x60;. Filter by status (&#x60;&#x60;SUCCEEDED&#x60;&#x60; / &#x60;&#x60;FAILED&#x60;&#x60; / &#x60;&#x60;FILTERED_OUT&#x60;&#x60; / &#x60;&#x60;SKIPPED_DO_NOT_FORWARD&#x60;&#x60;, case-insensitive) or by a &#x60;&#x60;created_at&#x60;&#x60; range using the platform&#39;s interval notation (&#x60;&#x60;[2026-01-01T00:00:00Z,*)&#x60;&#x60;). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.
+    # List delivery log entries for a forwarder.  Default sort is newest first. Filter by &#x60;status&#x60; (one of &#x60;SUCCEEDED&#x60;, &#x60;FAILED&#x60;, &#x60;FILTERED_OUT&#x60;, &#x60;SKIPPED_DO_NOT_FORWARD&#x60; — case-insensitive), by &#x60;event_id&#x60;, or by a &#x60;created_at&#x60; range using interval notation (e.g. &#x60;[2026-01-01T00:00:00Z,*)&#x60;).
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_status 
@@ -362,7 +362,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Forwarders
-    # List forwarders for the authenticated account.  Reads do not require the entitlement — a downgraded account can still inspect what they configured, they just can't create new ones.
+    # List forwarders for this account.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_forwarder_type 
     # @option opts [Boolean] :filter_enabled 
@@ -375,7 +375,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Forwarders
-    # List forwarders for the authenticated account.  Reads do not require the entitlement — a downgraded account can still inspect what they configured, they just can&#39;t create new ones.
+    # List forwarders for this account.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :filter_forwarder_type 
     # @option opts [Boolean] :filter_enabled 
@@ -435,7 +435,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Retry Failed Forwarder Deliveries
-    # Retry every failed delivery for the forwarder.  For each failed delivery row, re-attempt with the latest forwarder configuration and the original event payload. Returns counts.
+    # Retry every failed delivery for this forwarder.  Each failed delivery is re-attempted using the forwarder's current configuration and the original event. Returns the counts.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [RetryFailedDeliveriesSummary]
@@ -445,7 +445,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Retry Failed Forwarder Deliveries
-    # Retry every failed delivery for the forwarder.  For each failed delivery row, re-attempt with the latest forwarder configuration and the original event payload. Returns counts.
+    # Retry every failed delivery for this forwarder.  Each failed delivery is re-attempted using the forwarder&#39;s current configuration and the original event. Returns the counts.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(RetryFailedDeliveriesSummary, Integer, Hash)>] RetryFailedDeliveriesSummary data, response status code and response headers
@@ -498,7 +498,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Retry Forwarder Delivery
-    # Retry a single failed delivery. Returns the new delivery row with its outcome. Prior delivery rows are not modified.
+    # Retry a single failed delivery.  Returns the new delivery log entry. The prior entry is left in place.
     # @param forwarder_id [String] 
     # @param delivery_id [String] 
     # @param [Hash] opts the optional parameters
@@ -509,7 +509,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Retry Forwarder Delivery
-    # Retry a single failed delivery. Returns the new delivery row with its outcome. Prior delivery rows are not modified.
+    # Retry a single failed delivery.  Returns the new delivery log entry. The prior entry is left in place.
     # @param forwarder_id [String] 
     # @param delivery_id [String] 
     # @param [Hash] opts the optional parameters
@@ -567,23 +567,23 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Update Forwarder
-    # Full-replace update. PUT semantics — every field is overwritten.  The GET path returns plaintext header values, so the standard get-mutate-put round-trip (ADR-014) preserves secrets without any extra work from the caller: GET, change one field, PUT the result.
+    # Replace an existing forwarder. Every writable field is overwritten.
     # @param forwarder_id [String] 
-    # @param forwarder_response [ForwarderResponse] 
+    # @param forwarder_request [ForwarderRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ForwarderResponse]
-    def update_forwarder(forwarder_id, forwarder_response, opts = {})
-      data, _status_code, _headers = update_forwarder_with_http_info(forwarder_id, forwarder_response, opts)
+    def update_forwarder(forwarder_id, forwarder_request, opts = {})
+      data, _status_code, _headers = update_forwarder_with_http_info(forwarder_id, forwarder_request, opts)
       data
     end
 
     # Update Forwarder
-    # Full-replace update. PUT semantics — every field is overwritten.  The GET path returns plaintext header values, so the standard get-mutate-put round-trip (ADR-014) preserves secrets without any extra work from the caller: GET, change one field, PUT the result.
+    # Replace an existing forwarder. Every writable field is overwritten.
     # @param forwarder_id [String] 
-    # @param forwarder_response [ForwarderResponse] 
+    # @param forwarder_request [ForwarderRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ForwarderResponse, Integer, Hash)>] ForwarderResponse data, response status code and response headers
-    def update_forwarder_with_http_info(forwarder_id, forwarder_response, opts = {})
+    def update_forwarder_with_http_info(forwarder_id, forwarder_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ForwardersApi.update_forwarder ...'
       end
@@ -591,9 +591,9 @@ module SmplkitGeneratedClient::Audit
       if @api_client.config.client_side_validation && forwarder_id.nil?
         fail ArgumentError, "Missing the required parameter 'forwarder_id' when calling ForwardersApi.update_forwarder"
       end
-      # verify the required parameter 'forwarder_response' is set
-      if @api_client.config.client_side_validation && forwarder_response.nil?
-        fail ArgumentError, "Missing the required parameter 'forwarder_response' when calling ForwardersApi.update_forwarder"
+      # verify the required parameter 'forwarder_request' is set
+      if @api_client.config.client_side_validation && forwarder_request.nil?
+        fail ArgumentError, "Missing the required parameter 'forwarder_request' when calling ForwardersApi.update_forwarder"
       end
       # resource path
       local_var_path = '/api/v1/forwarders/{forwarder_id}'.sub('{forwarder_id}', CGI.escape(forwarder_id.to_s))
@@ -615,7 +615,7 @@ module SmplkitGeneratedClient::Audit
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(forwarder_response)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(forwarder_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ForwarderResponse'

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

@@ -20,7 +20,7 @@ module SmplkitGeneratedClient::Audit
       @api_client = api_client
     end
     # Execute Wipe
-    # Delete every audit-database row scoped to the authenticated account.  Returns the per-table row counts that were deleted along with the completion timestamp. The action is atomic within the audit database — either every account-scoped row is gone, or none is. The body is required to be ``{}``; no parameters are accepted.
+    # Delete every audit record this account has stored.  Atomic: either every record is deleted, or none is. Returns the per-table counts and the completion timestamp. The request body must be `{}`.
     # @param body [Object] 
     # @param [Hash] opts the optional parameters
     # @return [WipeResponse]
@@ -30,7 +30,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Execute Wipe
-    # Delete every audit-database row scoped to the authenticated account.  Returns the per-table row counts that were deleted along with the completion timestamp. The action is atomic within the audit database — either every account-scoped row is gone, or none is. The body is required to be ``{}``; no parameters are accepted.
+    # Delete every audit record this account has stored.  Atomic: either every record is deleted, or none is. Returns the per-table counts and the completion timestamp. The request body must be `{}`.
     # @param body [Object] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(WipeResponse, Integer, Hash)>] WipeResponse data, response status code and response headers

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

@@ -19,78 +19,8 @@ module SmplkitGeneratedClient::Audit
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List Actions
-    # List the distinct ``action`` slugs seen in the account.  Without ``filter[resource_type]``, returns one row per distinct action — the same action may have been recorded with multiple resource types and the unfiltered dropdown shows it once.  With ``filter[resource_type]``, returns the actions seen with that specific resource type, powering the Activity tab's cascading filter behavior.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter_resource_type 
-    # @option opts [Integer] :page_size 
-    # @option opts [String] :page_after 
-    # @return [ActionListResponse]
-    def list_actions(opts = {})
-      data, _status_code, _headers = list_actions_with_http_info(opts)
-      data
-    end
-
-    # List Actions
-    # List the distinct ``action`` slugs seen in the account.  Without ``filter[resource_type]``, returns one row per distinct action — the same action may have been recorded with multiple resource types and the unfiltered dropdown shows it once.  With ``filter[resource_type]``, returns the actions seen with that specific resource type, powering the Activity tab's cascading filter behavior.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter_resource_type 
-    # @option opts [Integer] :page_size 
-    # @option opts [String] :page_after 
-    # @return [Array<(ActionListResponse, Integer, Hash)>] ActionListResponse data, response status code and response headers
-    def list_actions_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ResourceTypesApi.list_actions ...'
-      end
-      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ResourceTypesApi.list_actions, must be greater than or equal to 1.'
-      end
-
-      # resource path
-      local_var_path = '/api/v1/actions'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'filter[resource_type]'] = opts[:'filter_resource_type'] if !opts[:'filter_resource_type'].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?
-
-      # 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] || 'ActionListResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
-
-      new_options = opts.merge(
-        :operation => :"ResourceTypesApi.list_actions",
-        :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: ResourceTypesApi#list_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # List Resource Types
-    # List the distinct ``resource_type`` slugs seen in the account.  Each row's ``id`` is the slug itself, mirroring the smplkit convention of using customer-provided identifiers as the public-facing resource id (ADR-014).
+    # List the distinct `resource_type` slugs recorded for this account.  The resource `id` is the slug itself. Useful for populating filter dropdowns in a UI.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size 
     # @option opts [String] :page_after 
@@ -101,7 +31,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Resource Types
-    # List the distinct &#x60;&#x60;resource_type&#x60;&#x60; slugs seen in the account.  Each row&#39;s &#x60;&#x60;id&#x60;&#x60; is the slug itself, mirroring the smplkit convention of using customer-provided identifiers as the public-facing resource id (ADR-014).
+    # List the distinct &#x60;resource_type&#x60; slugs recorded for this account.  The resource &#x60;id&#x60; is the slug itself. Useful for populating filter dropdowns in a UI.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size 
     # @option opts [String] :page_after 

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

@@ -20,8 +20,8 @@ module SmplkitGeneratedClient::Audit
       @api_client = api_client
     end
     # List Usage
-    # Current-period usage and quota for the audit product.  Only ``filter[period]=current`` is supported; historical usage is a follow-up.
-    # @param filter_period [String] 
+    # Report the current-period usage counters for this account.
+    # @param filter_period [String] Period to report. `current` is the only supported value.
     # @param [Hash] opts the optional parameters
     # @return [UsageResponse]
     def list_usage(filter_period, opts = {})
@@ -30,8 +30,8 @@ module SmplkitGeneratedClient::Audit
     end
 
     # List Usage
-    # Current-period usage and quota for the audit product.  Only ``filter[period]=current`` is supported; historical usage is a follow-up.
-    # @param filter_period [String] 
+    # Report the current-period usage counters for this account.
+    # @param filter_period [String] Period to report. `current` is the only supported value.
     # @param [Hash] opts the optional parameters
     # @return [Array<(UsageResponse, Integer, Hash)>] UsageResponse data, response status code and response headers
     def list_usage_with_http_info(filter_period, opts = {})

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

@@ -14,29 +14,39 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # Public-facing event resource.  Attribute set on POST /api/v1/events:     - action (required)     - resource_type (required)     - resource_id (required)     - occurred_at (optional; defaults to ``created_at``)     - data (optional; defaults to ``{}``)  There is no top-level ``snapshot`` attribute. Customers wishing to record a resource snapshot place it inside ``data`` -- smplkit's internal convention nests it at ``data.snapshot``, but customers may follow their own convention.  Attribute set on GET responses includes everything above plus the server-populated fields: ``created_at``, ``actor_type``, ``actor_id``, ``actor_label``, ``idempotency_key``.
+  # An audit event — a record that something happened, attributed to an actor and a resource.  When recording a snapshot of the resource at the time of the event, place it inside `data`. smplkit's own integrations nest it under `data.snapshot`, but the slot is yours to use however you like.
   class Event < ApiModelBase
+    # Slug for what happened, e.g. `user.created`. Lowercase, dot-separated.
     attr_accessor :action
 
+    # Slug for the kind of resource the event is about, e.g. `user`. Lowercase, dot-separated.
     attr_accessor :resource_type
 
+    # Identifier of the specific resource the event is about.
     attr_accessor :resource_id
 
+    # When the event actually happened. Defaults to the server receipt time (`created_at`).
     attr_accessor :occurred_at
 
+    # Free-form payload attached to the event. Use it for resource snapshots (by convention under `data.snapshot`), request identifiers, or any other context the event needs to carry.
     attr_accessor :data
 
-    # When true, this event is recorded normally but is not forwarded to any configured SIEM forwarder. A forwarder_delivery row with status=skipped_do_not_forward is recorded for each enabled forwarder so the skip is visible in the delivery log.
+    # When `true`, the event is recorded but not delivered to any forwarder. A delivery log entry with status `SKIPPED_DO_NOT_FORWARD` is written for each enabled forwarder so the skip is visible in the delivery log.
     attr_accessor :do_not_forward
 
+    # When the event was received and recorded.
     attr_accessor :created_at
 
+    # Kind of credential that emitted the event, e.g. `USER` or `API_KEY`. Resolved server-side from the request credential.
     attr_accessor :actor_type
 
+    # Identifier of the actor that emitted the event.
     attr_accessor :actor_id
 
+    # Human-readable label for the actor (e.g. the user's email address or the API key name) at the time the event was recorded.
     attr_accessor :actor_label
 
+    # The idempotency key used to deduplicate the record. Echoes the `Idempotency-Key` header if one was supplied, otherwise a key derived from the event's content.
     attr_accessor :idempotency_key
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # JSON:API collection response with cursor pagination metadata.
+  # JSON:API collection response for audit events.
   class EventListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -0,0 +1,165 @@
+=begin
+#smplkit Audit API
+
+#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
+
+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::Audit
+  # JSON:API request envelope for recording an audit event.
+  class EventRequest < 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' => :'EventResource'
+      }
+    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::Audit::EventRequest` 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::Audit::EventRequest`. 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/audit/lib/smplkit_audit_client/models/event_resource.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # JSON:API resource envelope for an audit event.
+  # JSON:API resource envelope for an audit event.  `id` must not be specified for create requests (the server assigns it).
   class EventResource < ApiModelBase
     attr_accessor :id
 
@@ -53,6 +53,7 @@ module SmplkitGeneratedClient::Audit
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
       ])
     end
 
@@ -74,8 +75,6 @@ module SmplkitGeneratedClient::Audit
 
       if attributes.key?(:'id')
         self.id = attributes[:'id']
-      else
-        self.id = nil
       end
 
       if attributes.key?(:'type')
@@ -96,10 +95,6 @@ module SmplkitGeneratedClient::Audit
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
       if @attributes.nil?
         invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
@@ -111,21 +106,10 @@ module SmplkitGeneratedClient::Audit
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id.nil?
       return false if @attributes.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] id Value to be assigned
-    def id=(id)
-      if id.nil?
-        fail ArgumentError, 'id cannot be nil'
-      end
-
-      @id = id
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] attributes Value to be assigned
     def attributes=(attributes)

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

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # JSON:API single-resource response.
+  # JSON:API single-resource response for an audit event.
   class EventResponse < ApiModelBase
     attr_accessor :data