smplkit 3.0.17 → 3.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2266728c6a9809fd424e1ef3bfaf55aecc001b22e4fdf1847d1e550c52b4a50e
-  data.tar.gz: 928ab9e89ea2dca1548eb82a06aa8d9b525f874026437bb6b862b4cdc254a4c9
+  metadata.gz: 9aac495079938ab8bc622b249b90945d435ed134ce29f3a4583cea7ab3340422
+  data.tar.gz: dbb0c297f8bcfe63909cdfcabad6524baf4d40a35ad1c6d5efbcb7e416acbc85
 SHA512:
-  metadata.gz: 5df7bda61e6e5b0388d56a8171f642113da0491243d4ee443dd3d6ae516b0fbfb02875d6541d66a756710aba38bd4c078729b923329551320adde5cc14fa4c56
-  data.tar.gz: d028dd314e06e87fc6185f80695ba0c4bdf21b5d77d548c62e32bc2c4138590f7566c327cc83946191c26e233be9b0d923d1ba0d3d6fb59f835f91ca9f6f3bfa
+  metadata.gz: bc342b324650e1e75ef46662b5ec3b39ed71b987cb2e6d9e61f59e4747c6cded00efbed43bbf9bdeee24cf2a05a3cad4a30d62ef5d6cd035784cb8fca0f5ad20
+  data.tar.gz: b7ea349571de8d67fa56376fc1e4c7a66d5636e8581f59546b35d11f3031362f047b3a052b1bbe718397c45e016fc2929ae8d352191fe304309ff1bb4a0f10ca

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

@@ -14,11 +14,14 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # 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.
+  # 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 shaped by the configured transform and delivered to the destination defined by ``configuration``.
   class Forwarder < ApiModelBase
     # Human-readable name for the forwarder.
     attr_accessor :name
 
+    # Free-text description for the forwarder.
+    attr_accessor :description
+
     # Destination type.
     attr_accessor :forwarder_type
 
@@ -28,14 +31,14 @@ module SmplkitGeneratedClient::Audit
     # 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
+    # Engine used to evaluate ``transform``. Must be set whenever ``transform`` is set. Today only `JSONATA` is supported.
+    attr_accessor :transform_type
 
-    # HTTP request used to deliver each event to the destination.
-    attr_accessor :http
+    # Template applied to each event before delivery. The shape depends on ``transform_type``: for `JSONATA`, a string containing a JSONata expression. Omit to deliver the event JSON unchanged.
+    attr_accessor :transform
 
-    # URL-safe identifier derived from `name` at create time. Stable for the lifetime of the forwarder.
-    attr_accessor :slug
+    # Transport-specific delivery configuration. Shape is discriminated by ``forwarder_type``; today all destination types use ``HttpConfiguration``.
+    attr_accessor :configuration
 
     # When the forwarder was created.
     attr_accessor :created_at
@@ -75,12 +78,13 @@ module SmplkitGeneratedClient::Audit
     def self.attribute_map
       {
         :'name' => :'name',
+        :'description' => :'description',
         :'forwarder_type' => :'forwarder_type',
         :'enabled' => :'enabled',
         :'filter' => :'filter',
+        :'transform_type' => :'transform_type',
         :'transform' => :'transform',
-        :'http' => :'http',
-        :'slug' => :'slug',
+        :'configuration' => :'configuration',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'deleted_at' => :'deleted_at',
@@ -102,12 +106,13 @@ module SmplkitGeneratedClient::Audit
     def self.openapi_types
       {
         :'name' => :'String',
+        :'description' => :'String',
         :'forwarder_type' => :'ForwarderType',
         :'enabled' => :'Boolean',
         :'filter' => :'Hash<String, Object>',
-        :'transform' => :'String',
-        :'http' => :'ForwarderHttp',
-        :'slug' => :'String',
+        :'transform_type' => :'String',
+        :'transform' => :'Object',
+        :'configuration' => :'HttpConfiguration',
         :'created_at' => :'Time',
         :'updated_at' => :'Time',
         :'deleted_at' => :'Time',
@@ -118,9 +123,10 @@ module SmplkitGeneratedClient::Audit
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'description',
         :'filter',
+        :'transform_type',
         :'transform',
-        :'slug',
         :'created_at',
         :'updated_at',
         :'deleted_at',
@@ -150,6 +156,10 @@ module SmplkitGeneratedClient::Audit
         self.name = nil
       end
 
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
       if attributes.key?(:'forwarder_type')
         self.forwarder_type = attributes[:'forwarder_type']
       else
@@ -168,18 +178,18 @@ module SmplkitGeneratedClient::Audit
         end
       end
 
+      if attributes.key?(:'transform_type')
+        self.transform_type = attributes[:'transform_type']
+      end
+
       if attributes.key?(:'transform')
         self.transform = attributes[:'transform']
       end
 
-      if attributes.key?(:'http')
-        self.http = attributes[:'http']
+      if attributes.key?(:'configuration')
+        self.configuration = attributes[:'configuration']
       else
-        self.http = nil
-      end
-
-      if attributes.key?(:'slug')
-        self.slug = attributes[:'slug']
+        self.configuration = nil
       end
 
       if attributes.key?(:'created_at')
@@ -216,16 +226,16 @@ module SmplkitGeneratedClient::Audit
         invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
       end
 
-      if @forwarder_type.nil?
-        invalid_properties.push('invalid value for "forwarder_type", forwarder_type cannot be nil.')
+      if !@description.nil? && @description.to_s.length > 2000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 2000.')
       end
 
-      if !@transform.nil? && @transform.to_s.length > 16384
-        invalid_properties.push('invalid value for "transform", the character length must be smaller than or equal to 16384.')
+      if @forwarder_type.nil?
+        invalid_properties.push('invalid value for "forwarder_type", forwarder_type cannot be nil.')
       end
 
-      if @http.nil?
-        invalid_properties.push('invalid value for "http", http cannot be nil.')
+      if @configuration.nil?
+        invalid_properties.push('invalid value for "configuration", configuration cannot be nil.')
       end
 
       invalid_properties
@@ -238,9 +248,11 @@ module SmplkitGeneratedClient::Audit
       return false if @name.nil?
       return false if @name.to_s.length > 200
       return false if @name.to_s.length < 1
+      return false if !@description.nil? && @description.to_s.length > 2000
       return false if @forwarder_type.nil?
-      return false if !@transform.nil? && @transform.to_s.length > 16384
-      return false if @http.nil?
+      transform_type_validator = EnumAttributeValidator.new('String', ["JSONATA"])
+      return false unless transform_type_validator.valid?(@transform_type)
+      return false if @configuration.nil?
       true
     end
 
@@ -262,6 +274,16 @@ module SmplkitGeneratedClient::Audit
       @name = name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 2000.'
+      end
+
+      @description = description
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] forwarder_type Value to be assigned
     def forwarder_type=(forwarder_type)
@@ -272,24 +294,24 @@ module SmplkitGeneratedClient::Audit
       @forwarder_type = forwarder_type
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] transform Value to be assigned
-    def transform=(transform)
-      if !transform.nil? && transform.to_s.length > 16384
-        fail ArgumentError, 'invalid value for "transform", the character length must be smaller than or equal to 16384.'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transform_type Object to be assigned
+    def transform_type=(transform_type)
+      validator = EnumAttributeValidator.new('String', ["JSONATA"])
+      unless validator.valid?(transform_type)
+        fail ArgumentError, "invalid value for \"transform_type\", must be one of #{validator.allowable_values}."
       end
-
-      @transform = transform
+      @transform_type = transform_type
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] http Value to be assigned
-    def http=(http)
-      if http.nil?
-        fail ArgumentError, 'http cannot be nil'
+    # @param [Object] configuration Value to be assigned
+    def configuration=(configuration)
+      if configuration.nil?
+        fail ArgumentError, 'configuration cannot be nil'
       end
 
-      @http = http
+      @configuration = configuration
     end
 
     # Checks equality by comparing each attribute.
@@ -298,12 +320,13 @@ module SmplkitGeneratedClient::Audit
       return true if self.equal?(o)
       self.class == o.class &&
           name == o.name &&
+          description == o.description &&
           forwarder_type == o.forwarder_type &&
           enabled == o.enabled &&
           filter == o.filter &&
+          transform_type == o.transform_type &&
           transform == o.transform &&
-          http == o.http &&
-          slug == o.slug &&
+          configuration == o.configuration &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           deleted_at == o.deleted_at &&
@@ -319,7 +342,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].hash
+      [name, description, forwarder_type, enabled, filter, transform_type, transform, configuration, 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_http.rb → http_configuration.rb}

@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # HTTP request configuration used to deliver an event to the destination.
-  class ForwarderHttp < ApiModelBase
+  # HTTP request configuration used to deliver an event to the destination.  Used when the parent forwarder's ``forwarder_type`` is one of the HTTP-family destinations (``HTTP``, ``DATADOG``, ``SPLUNK_HEC``, ``SUMO_LOGIC``, ``NEW_RELIC``, ``HONEYCOMB``, ``ELASTIC``). When other transports land (``FTP``, ``SQS``, …) their own configuration schemas will join this one as members of a discriminated union under the ``configuration`` field of ``Forwarder``.
+  class HttpConfiguration < ApiModelBase
     # HTTP method used when delivering an event.
     attr_accessor :method
 
@@ -25,9 +25,6 @@ module SmplkitGeneratedClient::Audit
     # 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
 
@@ -59,7 +56,6 @@ module SmplkitGeneratedClient::Audit
         :'method' => :'method',
         :'url' => :'url',
         :'headers' => :'headers',
-        :'body' => :'body',
         :'success_status' => :'success_status'
       }
     end
@@ -80,7 +76,6 @@ module SmplkitGeneratedClient::Audit
         :'method' => :'String',
         :'url' => :'String',
         :'headers' => :'Array<HttpHeader>',
-        :'body' => :'String',
         :'success_status' => :'String'
       }
     end
@@ -88,7 +83,6 @@ module SmplkitGeneratedClient::Audit
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'body',
       ])
     end
 
@@ -96,14 +90,14 @@ module SmplkitGeneratedClient::Audit
     # @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::ForwarderHttp` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::HttpConfiguration` 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::ForwarderHttp`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::HttpConfiguration`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -126,10 +120,6 @@ module SmplkitGeneratedClient::Audit
         end
       end
 
-      if attributes.key?(:'body')
-        self.body = attributes[:'body']
-      end
-
       if attributes.key?(:'success_status')
         self.success_status = attributes[:'success_status']
       else
@@ -154,10 +144,6 @@ module SmplkitGeneratedClient::Audit
         invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
       end
 
-      if !@body.nil? && @body.to_s.length > 65536
-        invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 65536.')
-      end
-
       if !@success_status.nil? && @success_status.to_s.length > 3
         invalid_properties.push('invalid value for "success_status", the character length must be smaller than or equal to 3.')
       end
@@ -174,7 +160,6 @@ module SmplkitGeneratedClient::Audit
       return false if @url.nil?
       return false if @url.to_s.length > 2048
       return false if @url.to_s.length < 1
-      return false if !@body.nil? && @body.to_s.length > 65536
       return false if !@success_status.nil? && @success_status.to_s.length > 3
       true
     end
@@ -207,16 +192,6 @@ module SmplkitGeneratedClient::Audit
       @url = url
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] body Value to be assigned
-    def body=(body)
-      if !body.nil? && body.to_s.length > 65536
-        fail ArgumentError, 'invalid value for "body", the character length must be smaller than or equal to 65536.'
-      end
-
-      @body = body
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] success_status Value to be assigned
     def success_status=(success_status)
@@ -239,7 +214,6 @@ module SmplkitGeneratedClient::Audit
           method == o.method &&
           url == o.url &&
           headers == o.headers &&
-          body == o.body &&
           success_status == o.success_status
     end
 
@@ -252,7 +226,7 @@ module SmplkitGeneratedClient::Audit
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method, url, headers, body, success_status].hash
+      [method, url, headers, success_status].hash
     end
 
     # Builds the object from hash

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

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Audit
-  # A single HTTP header attached to a forwarder delivery request.
+  # A single HTTP header attached to a forwarder delivery request.  Header values carrying secrets (API keys, bearer tokens, HEC tokens) are encrypted at the application layer before persistence; the wire representation here is always plaintext.
   class HttpHeader < ApiModelBase
     # Header name.
     attr_accessor :name

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

@@ -25,9 +25,6 @@ module SmplkitGeneratedClient::Audit
     # 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
 
@@ -62,7 +59,6 @@ module SmplkitGeneratedClient::Audit
         :'method' => :'method',
         :'url' => :'url',
         :'headers' => :'headers',
-        :'body' => :'body',
         :'success_status' => :'success_status',
         :'timeout_ms' => :'timeout_ms'
       }
@@ -84,7 +80,6 @@ module SmplkitGeneratedClient::Audit
         :'method' => :'String',
         :'url' => :'String',
         :'headers' => :'Array<HttpHeader>',
-        :'body' => :'String',
         :'success_status' => :'String',
         :'timeout_ms' => :'Integer'
       }
@@ -93,7 +88,6 @@ module SmplkitGeneratedClient::Audit
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'body',
         :'timeout_ms'
       ])
     end
@@ -132,10 +126,6 @@ module SmplkitGeneratedClient::Audit
         end
       end
 
-      if attributes.key?(:'body')
-        self.body = attributes[:'body']
-      end
-
       if attributes.key?(:'success_status')
         self.success_status = attributes[:'success_status']
       else
@@ -164,10 +154,6 @@ module SmplkitGeneratedClient::Audit
         invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
       end
 
-      if !@body.nil? && @body.to_s.length > 65536
-        invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 65536.')
-      end
-
       if !@success_status.nil? && @success_status.to_s.length > 3
         invalid_properties.push('invalid value for "success_status", the character length must be smaller than or equal to 3.')
       end
@@ -192,7 +178,6 @@ module SmplkitGeneratedClient::Audit
       return false if @url.nil?
       return false if @url.to_s.length > 2048
       return false if @url.to_s.length < 1
-      return false if !@body.nil? && @body.to_s.length > 65536
       return false if !@success_status.nil? && @success_status.to_s.length > 3
       return false if !@timeout_ms.nil? && @timeout_ms > 30000
       return false if !@timeout_ms.nil? && @timeout_ms < 1
@@ -227,16 +212,6 @@ module SmplkitGeneratedClient::Audit
       @url = url
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] body Value to be assigned
-    def body=(body)
-      if !body.nil? && body.to_s.length > 65536
-        fail ArgumentError, 'invalid value for "body", the character length must be smaller than or equal to 65536.'
-      end
-
-      @body = body
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] success_status Value to be assigned
     def success_status=(success_status)
@@ -273,7 +248,6 @@ module SmplkitGeneratedClient::Audit
           method == o.method &&
           url == o.url &&
           headers == o.headers &&
-          body == o.body &&
           success_status == o.success_status &&
           timeout_ms == o.timeout_ms
     end
@@ -287,7 +261,7 @@ module SmplkitGeneratedClient::Audit
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [method, url, headers, body, success_status, timeout_ms].hash
+      [method, url, headers, success_status, timeout_ms].hash
     end
 
     # Builds the object from hash

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

@@ -35,12 +35,12 @@ require 'smplkit_audit_client/models/forwarder_delivery_list_meta'
 require 'smplkit_audit_client/models/forwarder_delivery_list_response'
 require 'smplkit_audit_client/models/forwarder_delivery_resource'
 require 'smplkit_audit_client/models/forwarder_delivery_response'
-require 'smplkit_audit_client/models/forwarder_http'
 require 'smplkit_audit_client/models/forwarder_list_response'
 require 'smplkit_audit_client/models/forwarder_request'
 require 'smplkit_audit_client/models/forwarder_resource'
 require 'smplkit_audit_client/models/forwarder_response'
 require 'smplkit_audit_client/models/forwarder_type'
+require 'smplkit_audit_client/models/http_configuration'
 require 'smplkit_audit_client/models/http_header'
 require 'smplkit_audit_client/models/list_meta'
 require 'smplkit_audit_client/models/pagination_meta'

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

@@ -33,6 +33,12 @@ describe SmplkitGeneratedClient::Audit::Forwarder do
     end
   end
 
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "forwarder_type"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -51,19 +57,23 @@ describe SmplkitGeneratedClient::Audit::Forwarder do
     end
   end
 
-  describe 'test attribute "transform"' do
+  describe 'test attribute "transform_type"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["JSONATA"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.transform_type = value }.not_to raise_error
+      # end
     end
   end
 
-  describe 'test attribute "http"' do
+  describe 'test attribute "transform"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  describe 'test attribute "slug"' do
+  describe 'test attribute "configuration"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/lib/smplkit/_generated/audit/spec/models/{forwarder_http_spec.rb → http_configuration_spec.rb}

@@ -14,16 +14,16 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for SmplkitGeneratedClient::Audit::ForwarderHttp
+# Unit tests for SmplkitGeneratedClient::Audit::HttpConfiguration
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe SmplkitGeneratedClient::Audit::ForwarderHttp do
-  #let(:instance) { SmplkitGeneratedClient::Audit::ForwarderHttp.new }
+describe SmplkitGeneratedClient::Audit::HttpConfiguration do
+  #let(:instance) { SmplkitGeneratedClient::Audit::HttpConfiguration.new }
 
-  describe 'test an instance of ForwarderHttp' do
-    it 'should create an instance of ForwarderHttp' do
+  describe 'test an instance of HttpConfiguration' do
+    it 'should create an instance of HttpConfiguration' do
       # uncomment below to test the instance creation
-      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::ForwarderHttp)
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::HttpConfiguration)
     end
   end
 
@@ -49,12 +49,6 @@ describe SmplkitGeneratedClient::Audit::ForwarderHttp do
     end
   end
 
-  describe 'test attribute "body"' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   describe 'test attribute "success_status"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

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

@@ -49,12 +49,6 @@ describe SmplkitGeneratedClient::Audit::TestForwarderRequest do
     end
   end
 
-  describe 'test attribute "body"' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   describe 'test attribute "success_status"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/lib/smplkit/audit/models.rb

@@ -142,14 +142,14 @@ module Smplkit
 
     # rubocop:disable Lint/StructNewOverride -- ``:method`` matches the
     # API attribute and shadowing Struct#method is the expected ergonomics.
-    ForwarderHttp = Struct.new(:method, :url, :headers, :body, :success_status, keyword_init: true) do
-      def initialize(method: "POST", url: "", headers: nil, body: nil, success_status: "2xx")
-        super(method: method, url: url, headers: headers || [], body: body, success_status: success_status)
+    HttpConfiguration = Struct.new(:method, :url, :headers, :success_status, keyword_init: true) do
+      def initialize(method: "POST", url: "", headers: nil, success_status: "2xx")
+        super(method: method, url: url, headers: headers || [], success_status: success_status)
       end
 
       def self.to_wire(src)
         h = src.is_a?(Hash) ? new(**src) : src
-        SmplkitGeneratedClient::Audit::ForwarderHttp.new(
+        SmplkitGeneratedClient::Audit::HttpConfiguration.new(
           method: h.method,
           url: h.url,
           headers: (h.headers || []).map do |hdr|
@@ -161,7 +161,6 @@ module Smplkit
                           end
             SmplkitGeneratedClient::Audit::HttpHeader.new(name: name, value: value)
           end,
-          body: h.body,
           success_status: h.success_status
         )
       end
@@ -173,7 +172,6 @@ module Smplkit
           method: src.method || "POST",
           url: src.url || "",
           headers: (src.headers || []).map { |h| HttpHeader.new(name: h.name, value: h.value) },
-          body: src.body,
           success_status: src.success_status || "2xx"
         )
       end
@@ -183,8 +181,8 @@ module Smplkit
     # rubocop:disable Lint/StructNewOverride -- ``:filter`` matches the
     # API attribute and shadowing Struct#filter is the expected ergonomics.
     Forwarder = Struct.new(
-      :id, :name, :slug, :forwarder_type, :enabled,
-      :filter, :transform, :http,
+      :id, :name, :description, :forwarder_type, :enabled,
+      :filter, :transform_type, :transform, :configuration,
       :created_at, :updated_at, :deleted_at, :version,
       keyword_init: true
     ) do
@@ -193,12 +191,13 @@ module Smplkit
         new(
           id: resource.id,
           name: a.name,
-          slug: a.slug,
+          description: a.description,
           forwarder_type: a.forwarder_type,
           enabled: a.enabled.nil? || a.enabled,
           filter: a.filter.nil? ? nil : Smplkit::Helpers.deep_stringify_keys(a.filter),
+          transform_type: a.transform_type,
           transform: a.transform,
-          http: ForwarderHttp.from_wire(a.http),
+          configuration: HttpConfiguration.from_wire(a.configuration),
           created_at: a.created_at,
           updated_at: a.updated_at,
           deleted_at: a.deleted_at,

data/lib/smplkit/management/audit.rb

@@ -26,25 +26,30 @@ module Smplkit
 
       # Create a forwarder.
       #
-      # @param name [String] Display name. The slug is derived
-      #   server-side.
+      # @param name [String] Display name.
       # @param forwarder_type [String, Smplkit::Audit::ForwarderType]
       #   One of the published {Smplkit::Audit::ForwarderType} constants
       #   (or the equivalent string).
-      # @param http [Smplkit::Audit::ForwarderHttp, Hash] Destination
-      #   configuration. Headers carry credentials and are encrypted at
-      #   rest server-side; reads return them redacted.
+      # @param configuration [Smplkit::Audit::HttpConfiguration, Hash]
+      #   Transport-specific delivery configuration. Today every
+      #   forwarder_type uses {HttpConfiguration}; the URL and header
+      #   values inside are stored encrypted server-side and round-trip
+      #   to GET in plaintext.
+      # @param description [String, nil] Optional free-text description.
       # @param enabled [Boolean] Whether the forwarder is active.
       # @param filter [Hash, nil] Optional JSON Logic filter; events
       #   that don't match are recorded as +filtered_out+ deliveries.
-      # @param transform [String, nil] Optional JSONata template
-      #   applied to the event payload before POST. Nil/empty sends the
-      #   event as-is.
-      def create(name:, forwarder_type:, http:, enabled: true,
-                 filter: nil, transform: nil)
+      # @param transform_type [String, nil] Engine that evaluates
+      #   +transform+. Set to +"JSONATA"+ whenever +transform+ is set.
+      # @param transform [String, nil] Optional template applied to the
+      #   event payload before delivery (for +JSONATA+, a JSONata
+      #   expression). Nil sends the event JSON unchanged.
+      def create(name:, forwarder_type:, configuration:, description: nil, enabled: true,
+                 filter: nil, transform_type: nil, transform: nil)
         body = build_body(nil, name: name, forwarder_type: forwarder_type,
-                               http: http, enabled: enabled,
-                               filter: filter, transform: transform)
+                               configuration: configuration, description: description,
+                               enabled: enabled, filter: filter,
+                               transform_type: transform_type, transform: transform)
         resp = Smplkit::Audit.call_api { @api.create_forwarder(body) }
         Smplkit::Audit::Forwarder.from_resource(resp.data)
       end
@@ -69,15 +74,15 @@ module Smplkit
 
       # Full-replace update. PUT semantics — every field is overwritten.
       #
-      # Header values must be re-supplied as plaintext; the GET path
-      # redacts them, so a PUT body containing +"<redacted>"+ would
-      # persist that literal. Track real header values client-side and
-      # round-trip them on update.
-      def update(forwarder_id, name:, forwarder_type:, http:, enabled: true,
-                 filter: nil, transform: nil)
+      # The URL and header values inside +configuration+ are returned in
+      # plaintext on GET, so a fetched forwarder can be round-tripped to
+      # PUT without re-entering secrets.
+      def update(forwarder_id, name:, forwarder_type:, configuration:, description: nil,
+                 enabled: true, filter: nil, transform_type: nil, transform: nil)
         body = build_body(forwarder_id, name: name, forwarder_type: forwarder_type,
-                                        http: http, enabled: enabled,
-                                        filter: filter, transform: transform)
+                                        configuration: configuration, description: description,
+                                        enabled: enabled, filter: filter,
+                                        transform_type: transform_type, transform: transform)
         resp = Smplkit::Audit.call_api { @api.update_forwarder(forwarder_id, body) }
         Smplkit::Audit::Forwarder.from_resource(resp.data)
       end
@@ -89,14 +94,17 @@ module Smplkit
 
       private
 
-      def build_body(id, name:, forwarder_type:, http:, enabled:, filter:, transform:)
+      def build_body(id, name:, forwarder_type:, configuration:, description:, enabled:,
+                     filter:, transform_type:, transform:)
         attrs = SmplkitGeneratedClient::Audit::Forwarder.new(
           name: name,
+          description: description,
           forwarder_type: Smplkit::Audit::ForwarderType.coerce(forwarder_type),
           enabled: enabled,
-          http: Smplkit::Audit::ForwarderHttp.to_wire(http),
           filter: filter,
-          transform: transform
+          transform_type: transform_type,
+          transform: transform,
+          configuration: Smplkit::Audit::HttpConfiguration.to_wire(configuration)
         )
         resource = SmplkitGeneratedClient::Audit::ForwarderResource.new(
           id: id ? id.to_s : "",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.17
+  version: 3.0.18
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -445,12 +445,12 @@ files:
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_response.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_http.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_request.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_type.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/http_configuration.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/http_header.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/list_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/pagination_meta.rb
@@ -485,13 +485,13 @@ files:
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_spec.rb
-- lib/smplkit/_generated/audit/spec/models/forwarder_http_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_list_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_request_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_type_spec.rb
+- lib/smplkit/_generated/audit/spec/models/http_configuration_spec.rb
 - lib/smplkit/_generated/audit/spec/models/http_header_spec.rb
 - lib/smplkit/_generated/audit/spec/models/list_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/pagination_meta_spec.rb