smplkit 1.0.19 → 1.0.21

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

@@ -0,0 +1,86 @@
+=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 UsageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @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] 
+    # @param [Hash] opts the optional parameters
+    # @return [UsageResponse]
+    def list_usage(filter_period, opts = {})
+      data, _status_code, _headers = list_usage_with_http_info(filter_period, opts)
+      data
+    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] 
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.list_usage ...'
+      end
+      # verify the required parameter 'filter_period' is set
+      if @api_client.config.client_side_validation && filter_period.nil?
+        fail ArgumentError, "Missing the required parameter 'filter_period' when calling UsageApi.list_usage"
+      end
+      # resource path
+      local_var_path = '/api/v1/usage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[period]'] = filter_period
+
+      # 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] || 'UsageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.list_usage",
+        :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: UsageApi#list_usage\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/event.rb

@@ -28,6 +28,9 @@ module SmplkitGeneratedClient::Audit
 
     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.
+    attr_accessor :do_not_forward
+
     attr_accessor :created_at
 
     attr_accessor :actor_type
@@ -47,6 +50,7 @@ module SmplkitGeneratedClient::Audit
         :'occurred_at' => :'occurred_at',
         :'snapshot' => :'snapshot',
         :'data' => :'data',
+        :'do_not_forward' => :'do_not_forward',
         :'created_at' => :'created_at',
         :'actor_type' => :'actor_type',
         :'actor_id' => :'actor_id',
@@ -74,6 +78,7 @@ module SmplkitGeneratedClient::Audit
         :'occurred_at' => :'Time',
         :'snapshot' => :'Hash<String, Object>',
         :'data' => :'Hash<String, Object>',
+        :'do_not_forward' => :'Boolean',
         :'created_at' => :'Time',
         :'actor_type' => :'String',
         :'actor_id' => :'String',
@@ -145,6 +150,12 @@ module SmplkitGeneratedClient::Audit
         end
       end
 
+      if attributes.key?(:'do_not_forward')
+        self.do_not_forward = attributes[:'do_not_forward']
+      else
+        self.do_not_forward = false
+      end
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -264,6 +275,7 @@ module SmplkitGeneratedClient::Audit
           occurred_at == o.occurred_at &&
           snapshot == o.snapshot &&
           data == o.data &&
+          do_not_forward == o.do_not_forward &&
           created_at == o.created_at &&
           actor_type == o.actor_type &&
           actor_id == o.actor_id &&
@@ -280,7 +292,7 @@ module SmplkitGeneratedClient::Audit
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, resource_type, resource_id, occurred_at, snapshot, data, created_at, actor_type, actor_id, actor_label, idempotency_key].hash
+      [action, resource_type, resource_id, occurred_at, snapshot, data, do_not_forward, created_at, actor_type, actor_id, actor_label, idempotency_key].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,353 @@
+=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
+  # 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.
+  class Forwarder < ApiModelBase
+    attr_accessor :name
+
+    attr_accessor :forwarder_type
+
+    attr_accessor :enabled
+
+    attr_accessor :filter
+
+    attr_accessor :transform
+
+    attr_accessor :http
+
+    attr_accessor :slug
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    attr_accessor :deleted_at
+
+    attr_accessor :version
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'forwarder_type' => :'forwarder_type',
+        :'enabled' => :'enabled',
+        :'filter' => :'filter',
+        :'transform' => :'transform',
+        :'http' => :'http',
+        :'slug' => :'slug',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+        :'deleted_at' => :'deleted_at',
+        :'version' => :'version',
+        :'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
+      {
+        :'name' => :'String',
+        :'forwarder_type' => :'String',
+        :'enabled' => :'Boolean',
+        :'filter' => :'Hash<String, Object>',
+        :'transform' => :'String',
+        :'http' => :'ForwarderHttp',
+        :'slug' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time',
+        :'deleted_at' => :'Time',
+        :'version' => :'Integer',
+        :'data' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'filter',
+        :'transform',
+        :'slug',
+        :'created_at',
+        :'updated_at',
+        :'deleted_at',
+        :'version',
+      ])
+    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::Forwarder` 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::Forwarder`. 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?(:'forwarder_type')
+        self.forwarder_type = attributes[:'forwarder_type']
+      else
+        self.forwarder_type = nil
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      else
+        self.enabled = true
+      end
+
+      if attributes.key?(:'filter')
+        if (value = attributes[:'filter']).is_a?(Hash)
+          self.filter = value
+        end
+      end
+
+      if attributes.key?(:'transform')
+        self.transform = attributes[:'transform']
+      end
+
+      if attributes.key?(:'http')
+        self.http = attributes[:'http']
+      else
+        self.http = nil
+      end
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'deleted_at')
+        self.deleted_at = attributes[:'deleted_at']
+      end
+
+      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?
+    # @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 @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if @name.to_s.length < 1
+        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.')
+      end
+
+      if @forwarder_type.to_s.length < 1
+        invalid_properties.push('invalid value for "forwarder_type", the character length must be greater than or equal to 1.')
+      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.')
+      end
+
+      if @http.nil?
+        invalid_properties.push('invalid value for "http", http 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 @name.to_s.length > 200
+      return false if @name.to_s.length < 1
+      return false if @forwarder_type.nil?
+      return false if @forwarder_type.to_s.length < 1
+      return false if !@transform.nil? && @transform.to_s.length > 16384
+      return false if @http.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
+
+      if name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] forwarder_type Value to be assigned
+    def forwarder_type=(forwarder_type)
+      if forwarder_type.nil?
+        fail ArgumentError, 'forwarder_type cannot be nil'
+      end
+
+      if forwarder_type.to_s.length < 1
+        fail ArgumentError, 'invalid value for "forwarder_type", the character length must be greater than or equal to 1.'
+      end
+
+      @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.'
+      end
+
+      @transform = transform
+    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'
+      end
+
+      @http = http
+    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 &&
+          forwarder_type == o.forwarder_type &&
+          enabled == o.enabled &&
+          filter == o.filter &&
+          transform == o.transform &&
+          http == o.http &&
+          slug == o.slug &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          deleted_at == o.deleted_at &&
+          version == o.version &&
+          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
+      [name, forwarder_type, enabled, filter, transform, http, slug, created_at, updated_at, deleted_at, version, 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