smplkit 3.0.26 → 3.0.27

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

@@ -0,0 +1,292 @@
+=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
+  # Request body for ``POST /api/v1/search/events``.  Mirrors every column filter accepted by ``GET /api/v1/events`` with identical semantics, and adds a top-level ``filter`` field carrying a JSON Logic expression. When ``filter`` is present the search is silently capped to the last 30 days by ``occurred_at``; the expression is then evaluated in memory against each row that passes the column filters using the same ``json-logic-qubit`` evaluator that runs in the forwarder pipeline (so search results match what would be forwarded).  Filter-combination rules match ``GET /api/v1/events`` exactly:  - ``filter[resource_id]`` must be accompanied by   ``filter[resource_type]`` — the index is keyed on the pair. - ``filter[search]`` must be accompanied by either   ``filter[occurred_at]`` or ``filter[resource_type]`` +   ``filter[resource_id]`` — substring matching has no index, so an   unbounded substring scan is rejected.
+  class SearchEventsRequest < ApiModelBase
+    # The HTTP request as it was sent to the destination. Header values are redacted.
+    attr_accessor :filter
+
+    # Exact match on the event's `action` field.
+    attr_accessor :filter_action
+
+    # Exact match on the event's `resource_type` field.
+    attr_accessor :filter_resource_type
+
+    # Exact match on the event's `resource_id` field. Must be accompanied by `filter[resource_type]`.
+    attr_accessor :filter_resource_id
+
+    # Exact match on the event's `actor_type` field.
+    attr_accessor :filter_actor_type
+
+    # Exact match on the event's `actor_id` field.
+    attr_accessor :filter_actor_id
+
+    # Date range using interval notation, e.g. `[2026-04-01T00:00:00Z,2026-04-15T00:00:00Z)`. Required by `filter[search]` when the resource pair isn't provided. When a JSON Logic `filter` is present, the effective range is intersected with the last 30 days.
+    attr_accessor :filter_occurred_at
+
+    # Case-insensitive substring match on `resource_id` or `description`. Must be accompanied by either `filter[occurred_at]` or `filter[resource_type]` + `filter[resource_id]`.
+    attr_accessor :filter_search
+
+    # Maximum events to return. Range 1..1000, default 10. The default is intentionally smaller than the list endpoint's default of 1000 because the search UI typically renders results one card at a time.
+    attr_accessor :page_size
+
+    # Opaque cursor — pass the previous response's `links.next` cursor verbatim to fetch the next page. Keep the same `sort` value across paginated requests.
+    attr_accessor :page_after
+
+    # Sort field: `occurred_at` or `created_at`, optionally prefixed with `-` for descending order. Default `-occurred_at` (newest first).
+    attr_accessor :sort
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filter' => :'filter',
+        :'filter_action' => :'filter[action]',
+        :'filter_resource_type' => :'filter[resource_type]',
+        :'filter_resource_id' => :'filter[resource_id]',
+        :'filter_actor_type' => :'filter[actor_type]',
+        :'filter_actor_id' => :'filter[actor_id]',
+        :'filter_occurred_at' => :'filter[occurred_at]',
+        :'filter_search' => :'filter[search]',
+        :'page_size' => :'page[size]',
+        :'page_after' => :'page[after]',
+        :'sort' => :'sort'
+      }
+    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
+      {
+        :'filter' => :'Hash<String, Object>',
+        :'filter_action' => :'String',
+        :'filter_resource_type' => :'String',
+        :'filter_resource_id' => :'String',
+        :'filter_actor_type' => :'String',
+        :'filter_actor_id' => :'String',
+        :'filter_occurred_at' => :'String',
+        :'filter_search' => :'String',
+        :'page_size' => :'Integer',
+        :'page_after' => :'String',
+        :'sort' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'filter',
+        :'filter_action',
+        :'filter_resource_type',
+        :'filter_resource_id',
+        :'filter_actor_type',
+        :'filter_actor_id',
+        :'filter_occurred_at',
+        :'filter_search',
+        :'page_after',
+      ])
+    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::SearchEventsRequest` 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::SearchEventsRequest`. 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?(:'filter')
+        if (value = attributes[:'filter']).is_a?(Hash)
+          self.filter = value
+        end
+      end
+
+      if attributes.key?(:'filter_action')
+        self.filter_action = attributes[:'filter_action']
+      end
+
+      if attributes.key?(:'filter_resource_type')
+        self.filter_resource_type = attributes[:'filter_resource_type']
+      end
+
+      if attributes.key?(:'filter_resource_id')
+        self.filter_resource_id = attributes[:'filter_resource_id']
+      end
+
+      if attributes.key?(:'filter_actor_type')
+        self.filter_actor_type = attributes[:'filter_actor_type']
+      end
+
+      if attributes.key?(:'filter_actor_id')
+        self.filter_actor_id = attributes[:'filter_actor_id']
+      end
+
+      if attributes.key?(:'filter_occurred_at')
+        self.filter_occurred_at = attributes[:'filter_occurred_at']
+      end
+
+      if attributes.key?(:'filter_search')
+        self.filter_search = attributes[:'filter_search']
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      else
+        self.page_size = 10
+      end
+
+      if attributes.key?(:'page_after')
+        self.page_after = attributes[:'page_after']
+      end
+
+      if attributes.key?(:'sort')
+        self.sort = attributes[:'sort']
+      else
+        self.sort = '-occurred_at'
+      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 !@page_size.nil? && @page_size > 1000
+        invalid_properties.push('invalid value for "page_size", must be smaller than or equal to 1000.')
+      end
+
+      if !@page_size.nil? && @page_size < 1
+        invalid_properties.push('invalid value for "page_size", must be greater than or equal to 1.')
+      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 !@page_size.nil? && @page_size > 1000
+      return false if !@page_size.nil? && @page_size < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_size Value to be assigned
+    def page_size=(page_size)
+      if page_size.nil?
+        fail ArgumentError, 'page_size cannot be nil'
+      end
+
+      if page_size > 1000
+        fail ArgumentError, 'invalid value for "page_size", must be smaller than or equal to 1000.'
+      end
+
+      if page_size < 1
+        fail ArgumentError, 'invalid value for "page_size", must be greater than or equal to 1.'
+      end
+
+      @page_size = page_size
+    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 &&
+          filter == o.filter &&
+          filter_action == o.filter_action &&
+          filter_resource_type == o.filter_resource_type &&
+          filter_resource_id == o.filter_resource_id &&
+          filter_actor_type == o.filter_actor_type &&
+          filter_actor_id == o.filter_actor_id &&
+          filter_occurred_at == o.filter_occurred_at &&
+          filter_search == o.filter_search &&
+          page_size == o.page_size &&
+          page_after == o.page_after &&
+          sort == o.sort
+    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
+      [filter, filter_action, filter_resource_type, filter_resource_id, filter_actor_type, filter_actor_id, filter_occurred_at, filter_search, page_size, page_after, sort].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/search_events_response.rb

@@ -0,0 +1,203 @@
+=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 list envelope returned by the search endpoint.  Structurally identical to ``EventListResponse`` from the list endpoint — the only difference is the extra `scan` block inside `meta` (`SearchEventsListMeta` vs `EventListMeta`).
+  class SearchEventsResponse < ApiModelBase
+    attr_accessor :data
+
+    attr_accessor :meta
+
+    attr_accessor :links
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta',
+        :'links' => :'links'
+      }
+    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' => :'Array<EventResource>',
+        :'meta' => :'SearchEventsListMeta',
+        :'links' => :'SearchEventsListLinks'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'links'
+      ])
+    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::SearchEventsResponse` 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::SearchEventsResponse`. 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')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = nil
+      end
+
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
+      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
+
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta 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?
+      return false if @meta.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
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    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 &&
+          meta == o.meta &&
+          links == o.links
+    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, meta, links].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