smplkit 3.0.33 → 3.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78cfb3f85972678c7e6a5ba98fe400de6a60ff7c36517a4d00ec3b07f74f524d
-  data.tar.gz: ba49dfceadbe480abeda8ad0d2a4ebeeb7757f73af4b12b78885ddbb46240097
+  metadata.gz: 128a7c5f9091b8007c311817f08d6bc4644a76c1dcf1bb1d9191be83e07b3585
+  data.tar.gz: 365e17071a095bca5cab3e93ad0f5320176cca3f7e9e8b99ff94147b82f5f499
 SHA512:
-  metadata.gz: cb6bbc9c9af1b9b2c9c2d5761b08260aa9b9caf70884d786f6a740fdff5add3dff0bf9eb41660888473934d33403d2e3702ef628e045c46235aa6ff7de881cf5
-  data.tar.gz: fcc3e36fd16fcb43f75f72d3ef3bc69eee6c27602ea6e824cc25e59c35a655288ab818f79468e77d1b1677b7f1fe35b1bd8e43abb06851c0989ecfc16144f952
+  metadata.gz: ee3111c976ab077606fa16ba65713ea07c6c91b3120272637f4189dec3c1632f71f0f8caeb9ff63d63ae75e9fc5d8923b3ce7114a3f0e7bf1b5be711a490e55d
+  data.tar.gz: 7b83e652fd638225d291e5272e779617174239d8fc64ff9821c72e6f2ae76ed2caeadff24c014604f2f3e567d2744af5674541ed609297e95d4742bcfbe07880

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

@@ -0,0 +1,142 @@
+=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 'cgi'
+
+module SmplkitGeneratedClient::Audit
+  class ForwarderTypesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Forwarder Type
+    # Fetch a single forwarder type from the catalog.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ForwarderTypeResponse]
+    def get_forwarder_type_api_v1_forwarder_types_id_get(id, opts = {})
+      data, _status_code, _headers = get_forwarder_type_api_v1_forwarder_types_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Get Forwarder Type
+    # Fetch a single forwarder type from the catalog.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ForwarderTypeResponse, Integer, Hash)>] ForwarderTypeResponse data, response status code and response headers
+    def get_forwarder_type_api_v1_forwarder_types_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ForwarderTypesApi.get_forwarder_type_api_v1_forwarder_types_id_get ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ForwarderTypesApi.get_forwarder_type_api_v1_forwarder_types_id_get"
+      end
+      # resource path
+      local_var_path = '/api/v1/forwarder_types/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'ForwarderTypeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ForwarderTypesApi.get_forwarder_type_api_v1_forwarder_types_id_get",
+        :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: ForwarderTypesApi#get_forwarder_type_api_v1_forwarder_types_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Forwarder Types
+    # List all forwarder types in the catalog.  Returns every branded HTTP forwarder type defined in `forwarder_types/*.yaml` plus the synthetic `http` (Custom HTTP) entry. The response drives the console's create-forwarder UX, the docs vendor-reference page, and audit's own server-side template validation.
+    # @param [Hash] opts the optional parameters
+    # @return [ForwarderTypeListResponse]
+    def list_forwarder_types_api_v1_forwarder_types_get(opts = {})
+      data, _status_code, _headers = list_forwarder_types_api_v1_forwarder_types_get_with_http_info(opts)
+      data
+    end
+
+    # List Forwarder Types
+    # List all forwarder types in the catalog.  Returns every branded HTTP forwarder type defined in &#x60;forwarder_types/*.yaml&#x60; plus the synthetic &#x60;http&#x60; (Custom HTTP) entry. The response drives the console&#39;s create-forwarder UX, the docs vendor-reference page, and audit&#39;s own server-side template validation.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ForwarderTypeListResponse, Integer, Hash)>] ForwarderTypeListResponse data, response status code and response headers
+    def list_forwarder_types_api_v1_forwarder_types_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ForwarderTypesApi.list_forwarder_types_api_v1_forwarder_types_get ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/forwarder_types'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'ForwarderTypeListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ForwarderTypesApi.list_forwarder_types_api_v1_forwarder_types_get",
+        :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: ForwarderTypesApi#list_forwarder_types_api_v1_forwarder_types_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -37,7 +37,7 @@ module SmplkitGeneratedClient::Audit
     # 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
 
-    # Transport-specific delivery configuration. Shape is discriminated by ``forwarder_type``; today all destination types use ``HttpConfiguration``. Each managed vendor type (`DATADOG`, `NEW_RELIC`, `HONEYCOMB`, `SPLUNK_HEC`, `ELASTIC`) requires a vendor-specific authentication header to be present with a non-empty value; see the destination's documentation for the expected header name.
+    # Transport-specific delivery configuration. Shape is discriminated by ``forwarder_type``; today all destination types use ``HttpConfiguration``. Branded vendor types (everything except `http`) constrain the configuration against a per-vendor template — see `GET /api/v1/forwarder_types` for the URL pattern, fixed headers, and customer-supplied placeholders for each type.
     attr_accessor :configuration
 
     # When the forwarder was created.

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

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

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

@@ -0,0 +1,325 @@
+=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
+  # The catalog entry's attributes — one branded forwarder type or the synthetic Custom HTTP entry.
+  class ForwarderTypeAttributes < ApiModelBase
+    # Human-readable label shown in the type-picker.
+    attr_accessor :name
+
+    # Absolute URL to the icon asset, served by audit at `/api/v1/forwarder_types/{id}/icon`.
+    attr_accessor :icon
+
+    # Transport family — today only `HTTP`. New base types will add their own configuration shape and runtime handler.
+    attr_accessor :base_type
+
+    # Link to the vendor's own documentation for this destination.
+    attr_accessor :docs_url
+
+    # True for the synthetic `http` Custom HTTP entry, which has no vendor template — the customer supplies URL, headers, and transform from scratch. False for branded types.
+    attr_accessor :is_custom
+
+    # Delivery template. Shape depends on `base_type`.
+    attr_accessor :configuration
+
+    # UI metadata keyed by placeholder name. Each `{name}` token appearing in `configuration` (URL, header value) has a matching entry here describing how to prompt for it.
+    attr_accessor :placeholders
+
+    # Default transform shipped with the type, or `null` if none.
+    attr_accessor :transform
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'icon' => :'icon',
+        :'base_type' => :'base_type',
+        :'docs_url' => :'docs_url',
+        :'is_custom' => :'is_custom',
+        :'configuration' => :'configuration',
+        :'placeholders' => :'placeholders',
+        :'transform' => :'transform'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'icon' => :'String',
+        :'base_type' => :'String',
+        :'docs_url' => :'String',
+        :'is_custom' => :'Boolean',
+        :'configuration' => :'ForwarderTypeHttpConfiguration',
+        :'placeholders' => :'Hash<String, ForwarderTypePlaceholder>',
+        :'transform' => :'ForwarderTypeTransform'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'docs_url',
+        :'transform'
+      ])
+    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::ForwarderTypeAttributes` 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::ForwarderTypeAttributes`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      else
+        self.icon = nil
+      end
+
+      if attributes.key?(:'base_type')
+        self.base_type = attributes[:'base_type']
+      else
+        self.base_type = nil
+      end
+
+      if attributes.key?(:'docs_url')
+        self.docs_url = attributes[:'docs_url']
+      end
+
+      if attributes.key?(:'is_custom')
+        self.is_custom = attributes[:'is_custom']
+      else
+        self.is_custom = nil
+      end
+
+      if attributes.key?(:'configuration')
+        self.configuration = attributes[:'configuration']
+      else
+        self.configuration = nil
+      end
+
+      if attributes.key?(:'placeholders')
+        if (value = attributes[:'placeholders']).is_a?(Hash)
+          self.placeholders = value
+        end
+      else
+        self.placeholders = nil
+      end
+
+      if attributes.key?(:'transform')
+        self.transform = attributes[:'transform']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @icon.nil?
+        invalid_properties.push('invalid value for "icon", icon cannot be nil.')
+      end
+
+      if @base_type.nil?
+        invalid_properties.push('invalid value for "base_type", base_type cannot be nil.')
+      end
+
+      if @is_custom.nil?
+        invalid_properties.push('invalid value for "is_custom", is_custom cannot be nil.')
+      end
+
+      if @configuration.nil?
+        invalid_properties.push('invalid value for "configuration", configuration cannot be nil.')
+      end
+
+      if @placeholders.nil?
+        invalid_properties.push('invalid value for "placeholders", placeholders 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 @name.nil?
+      return false if @icon.nil?
+      return false if @base_type.nil?
+      return false if @is_custom.nil?
+      return false if @configuration.nil?
+      return false if @placeholders.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] icon Value to be assigned
+    def icon=(icon)
+      if icon.nil?
+        fail ArgumentError, 'icon cannot be nil'
+      end
+
+      @icon = icon
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] base_type Value to be assigned
+    def base_type=(base_type)
+      if base_type.nil?
+        fail ArgumentError, 'base_type cannot be nil'
+      end
+
+      @base_type = base_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_custom Value to be assigned
+    def is_custom=(is_custom)
+      if is_custom.nil?
+        fail ArgumentError, 'is_custom cannot be nil'
+      end
+
+      @is_custom = is_custom
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] configuration Value to be assigned
+    def configuration=(configuration)
+      if configuration.nil?
+        fail ArgumentError, 'configuration cannot be nil'
+      end
+
+      @configuration = configuration
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] placeholders Value to be assigned
+    def placeholders=(placeholders)
+      if placeholders.nil?
+        fail ArgumentError, 'placeholders cannot be nil'
+      end
+
+      @placeholders = placeholders
+    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 &&
+          name == o.name &&
+          icon == o.icon &&
+          base_type == o.base_type &&
+          docs_url == o.docs_url &&
+          is_custom == o.is_custom &&
+          configuration == o.configuration &&
+          placeholders == o.placeholders &&
+          transform == o.transform
+    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
+      [name, icon, base_type, docs_url, is_custom, configuration, placeholders, transform].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