smplkit 2.0.13 → 2.0.15

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

@@ -14,32 +14,41 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # Public-facing forwarder resource.  Attribute set on POST /api/v1/forwarders:     - name (required)     - forwarder_type (required)     - http (required)     - enabled (optional, defaults true)     - filter (optional, JSON Logic)     - transform (optional, JSONata)  The slug is server-derived from name on create; it is immutable on update because consumers (UI, observability) key off it.
+  # A destination that receives audit events recorded for the account.  Each event recorded for the account is evaluated against every enabled forwarder. If the filter expression evaluates truthy — or is absent — the event is delivered to the destination using the configured HTTP request. The slug, derived from `name` at create time, is the stable identifier used by the console and other tooling.
   class Forwarder < ApiModelBase
+    # Human-readable name for the forwarder.
     attr_accessor :name
 
+    # Destination type.
     attr_accessor :forwarder_type
 
+    # Whether the forwarder is currently delivering events. Set to `false` to pause deliveries without deleting the forwarder.
     attr_accessor :enabled
 
+    # JSON Logic expression evaluated against each event. The event is delivered only if the expression returns truthy. Omit to deliver every event.
     attr_accessor :filter
 
+    # JSONata template applied to each event before delivery. Omit to deliver the event unchanged.
     attr_accessor :transform
 
+    # HTTP request used to deliver each event to the destination.
     attr_accessor :http
 
+    # URL-safe identifier derived from `name` at create time. Stable for the lifetime of the forwarder.
     attr_accessor :slug
 
+    # When the forwarder was created.
     attr_accessor :created_at
 
+    # When the forwarder was last modified.
     attr_accessor :updated_at
 
+    # When the forwarder was deleted. `null` for active forwarders.
     attr_accessor :deleted_at
 
+    # Monotonic counter incremented on every update, starting at 1.
     attr_accessor :version
 
-    attr_accessor :data
-
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -75,8 +84,7 @@ module SmplkitGeneratedClient::Audit
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'deleted_at' => :'deleted_at',
-        :'version' => :'version',
-        :'data' => :'data'
+        :'version' => :'version'
       }
     end
 
@@ -103,8 +111,7 @@ module SmplkitGeneratedClient::Audit
         :'created_at' => :'Time',
         :'updated_at' => :'Time',
         :'deleted_at' => :'Time',
-        :'version' => :'Integer',
-        :'data' => :'Hash<String, Object>'
+        :'version' => :'Integer'
       }
     end
 
@@ -117,7 +124,7 @@ module SmplkitGeneratedClient::Audit
         :'created_at',
         :'updated_at',
         :'deleted_at',
-        :'version',
+        :'version'
       ])
     end
 
@@ -190,12 +197,6 @@ module SmplkitGeneratedClient::Audit
       if attributes.key?(:'version')
         self.version = attributes[:'version']
       end
-
-      if attributes.key?(:'data')
-        if (value = attributes[:'data']).is_a?(Hash)
-          self.data = value
-        end
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -306,8 +307,7 @@ module SmplkitGeneratedClient::Audit
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           deleted_at == o.deleted_at &&
-          version == o.version &&
-          data == o.data
+          version == o.version
     end
 
     # @see the `==` method
@@ -319,7 +319,7 @@ module SmplkitGeneratedClient::Audit
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, forwarder_type, enabled, filter, transform, http, slug, created_at, updated_at, deleted_at, version, data].hash
+      [name, forwarder_type, enabled, filter, transform, http, slug, created_at, updated_at, deleted_at, version].hash
     end
 
     # Builds the object from hash

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

@@ -14,26 +14,36 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # Read-only delivery log row.  All fields are server-populated. Headers in ``request`` always show redacted values, regardless of who configured them.
+  # A log entry for one attempt to deliver an event to a forwarder.
   class ForwarderDelivery < ApiModelBase
+    # Forwarder the delivery belongs to.
     attr_accessor :forwarder_id
 
+    # Event that was being delivered.
     attr_accessor :event_id
 
+    # 1 for the initial delivery, incremented for each retry.
     attr_accessor :attempt_number
 
+    # Delivery outcome. `SUCCEEDED` and `FAILED` are the live-delivery outcomes; `FILTERED_OUT` is recorded when the forwarder's filter rejected the event; `SKIPPED_DO_NOT_FORWARD` is recorded when the event was emitted with `do_not_forward=true`.
     attr_accessor :status
 
+    # The HTTP request as it was sent to the destination. Header values are redacted.
     attr_accessor :request
 
+    # HTTP status code returned by the destination.
     attr_accessor :response_status
 
+    # Response body returned by the destination.
     attr_accessor :response_body
 
+    # Elapsed time of the delivery attempt in milliseconds.
     attr_accessor :latency_ms
 
+    # Error message if the delivery did not complete.
     attr_accessor :error
 
+    # When the delivery attempt was recorded.
     attr_accessor :created_at
 
     class EnumAttributeValidator

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # JSON:API collection response for forwarder deliveries.
   class ForwarderDeliveryListResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # JSON:API resource envelope for a forwarder delivery log entry.
   class ForwarderDeliveryResource < ApiModelBase
     attr_accessor :id
 

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

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # JSON:API single-resource response for a forwarder delivery.
   class ForwarderDeliveryResponse < ApiModelBase
     attr_accessor :data
 

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

@@ -14,18 +14,45 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # The destination HTTP request shape stored encrypted on a forwarder.  ``success_status`` is a string: either a single status code (e.g. ``\"200\"``, ``\"204\"``) or a class (e.g. ``\"2xx\"``, ``\"3xx\"``). The string-only contract is intentional — a Pydantic ``int | str`` union confused several SDK code generators (Java in particular wrote the default ``\"2xx\"`` unquoted into a typed enum). String covers both shapes universally with a single wire type.
+  # HTTP request configuration used to deliver an event to the destination.
   class ForwarderHttp < ApiModelBase
+    # HTTP method used when delivering an event.
     attr_accessor :method
 
+    # Destination URL.
     attr_accessor :url
 
+    # HTTP headers attached to each delivery request.
     attr_accessor :headers
 
+    # Request body sent to the destination. If omitted, the event JSON is sent as the body.
     attr_accessor :body
 
+    # HTTP response status that indicates a successful delivery. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
     attr_accessor :success_status
 
+    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
       {
@@ -142,6 +169,8 @@ module SmplkitGeneratedClient::Audit
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      method_validator = EnumAttributeValidator.new('String', ["GET", "POST", "PUT", "PATCH", "DELETE"])
+      return false unless method_validator.valid?(@method)
       return false if @url.nil?
       return false if @url.to_s.length > 2048
       return false if @url.to_s.length < 1
@@ -150,6 +179,16 @@ module SmplkitGeneratedClient::Audit
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] method Object to be assigned
+    def method=(method)
+      validator = EnumAttributeValidator.new('String', ["GET", "POST", "PUT", "PATCH", "DELETE"])
+      unless validator.valid?(method)
+        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
+      end
+      @method = method
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] url Value to be assigned
     def url=(url)

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

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

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_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 creating or updating a forwarder.
+  class ForwarderRequest < 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' => :'ForwarderResource'
+      }
+    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::ForwarderRequest` 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::ForwarderRequest`. 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/forwarder_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # JSON:API resource envelope for a forwarder.  `id` must not be specified for create requests (the server assigns it).
   class ForwarderResource < ApiModelBase
     attr_accessor :id
 
@@ -52,6 +53,7 @@ module SmplkitGeneratedClient::Audit
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id',
       ])
     end
 
@@ -73,8 +75,6 @@ module SmplkitGeneratedClient::Audit
 
       if attributes.key?(:'id')
         self.id = attributes[:'id']
-      else
-        self.id = nil
       end
 
       if attributes.key?(:'type')
@@ -95,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
@@ -110,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/forwarder_response.rb

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

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

@@ -14,10 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # A single header on a forwarder's HTTP destination.
+  # A single HTTP header attached to a forwarder delivery request.
   class HttpHeader < ApiModelBase
+    # Header name.
     attr_accessor :name
 
+    # Header value.
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # Counts returned by the retry-failed-deliveries action.
   class RetryFailedDeliveriesSummary < ApiModelBase
+    # Number of failed deliveries that were re-attempted.
     attr_accessor :attempted
 
+    # Number of re-attempts that succeeded.
     attr_accessor :succeeded
 
+    # Number of re-attempts that failed again.
     attr_accessor :failed
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,20 +14,48 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # Plain-JSON body for the test_forwarder execute action.  Mirrors the encrypted ``ForwarderHttp`` shape with one addition — ``timeout_ms``, capped server-side.
+  # Inputs to the test-forwarder action.  Mirrors a forwarder's HTTP destination configuration with one addition: `timeout_ms`, applied per-request and capped server-side.
   class TestForwarderRequest < ApiModelBase
+    # HTTP method used for the test request.
     attr_accessor :method
 
+    # Destination URL.
     attr_accessor :url
 
+    # HTTP headers attached to the test request.
     attr_accessor :headers
 
+    # Request body. If omitted, an empty body is sent.
     attr_accessor :body
 
+    # HTTP response status that indicates success. Either a specific status code (e.g. `200`, `204`) or a status class (`1xx`, `2xx`, `3xx`, `4xx`, `5xx`).
     attr_accessor :success_status
 
+    # Per-request timeout in milliseconds. Capped at 30 seconds.
     attr_accessor :timeout_ms
 
+    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
       {
@@ -159,6 +187,8 @@ module SmplkitGeneratedClient::Audit
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      method_validator = EnumAttributeValidator.new('String', ["GET", "POST", "PUT", "PATCH", "DELETE"])
+      return false unless method_validator.valid?(@method)
       return false if @url.nil?
       return false if @url.to_s.length > 2048
       return false if @url.to_s.length < 1
@@ -169,6 +199,16 @@ module SmplkitGeneratedClient::Audit
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] method Object to be assigned
+    def method=(method)
+      validator = EnumAttributeValidator.new('String', ["GET", "POST", "PUT", "PATCH", "DELETE"])
+      unless validator.valid?(method)
+        fail ArgumentError, "invalid value for \"method\", must be one of #{validator.allowable_values}."
+      end
+      @method = method
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] url Value to be assigned
     def url=(url)

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

@@ -14,18 +14,24 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # Plain-JSON response body. Headers are echoed back unredacted because the caller already supplied them — the response is for the caller, not persisted into the delivery log.
+  # Result of a test-forwarder execution.
   class TestForwarderResponse < ApiModelBase
+    # True if the destination responded with a status matching `success_status`.
     attr_accessor :succeeded
 
+    # HTTP status code returned by the destination.
     attr_accessor :response_status
 
+    # Headers returned by the destination.
     attr_accessor :response_headers
 
+    # Response body returned by the destination.
     attr_accessor :response_body
 
+    # Elapsed time of the request in milliseconds.
     attr_accessor :latency_ms
 
+    # Error message if the request did not complete.
     attr_accessor :error
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,12 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # Attribute set for a usage resource.  The shape mirrors the ``/api/v1/usage`` contract used by config, flags, and logging — three fields, no per-product extras. Per-period limits live in the product catalog (``GET /api/v1/products``); the usage endpoint reports counts only.
+  # Usage counter for a single metered limit.
   class UsageAttributes < ApiModelBase
+    # Identifier of the metered limit, e.g. `audit.customer_events_per_month`.
     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/audit/lib/smplkit_audit_client/models/wipe_response.rb

@@ -14,11 +14,14 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # Summary of a completed wipe action.
   class WipeResponse < ApiModelBase
+    # Always `true` for a successful wipe.
     attr_accessor :wiped
 
     attr_accessor :tables
 
+    # When the wipe completed.
     attr_accessor :completed_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -14,17 +14,24 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
+  # Counts of records deleted, broken down by record kind.
   class WipeTablesSummary < ApiModelBase
+    # Number of audit events deleted.
     attr_accessor :audit_event
 
+    # Number of monthly usage-quota counters deleted.
     attr_accessor :audit_event_quota
 
+    # Number of forwarders deleted.
     attr_accessor :forwarder
 
+    # Number of forwarder delivery log entries deleted.
     attr_accessor :forwarder_delivery
 
+    # Number of distinct `resource_type` entries deleted.
     attr_accessor :resource_type
 
+    # Number of distinct `action` entries deleted.
     attr_accessor :action
 
     # Attribute mapping from ruby-style variable name to JSON key.