smplkit 3.0.26 → 3.0.27

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

@@ -0,0 +1,220 @@
+=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
+  # Scan statistics for a search response.  Exposed so a selective JSON Logic filter doesn't silently look like \"0 matches\" when the truth is \"the scan ceiling was reached before the filter had a chance to find page[size] matches.\"
+  class SearchScanMeta < ApiModelBase
+    # Rows scanned after column filters narrowed the candidate set, before the JSON Logic expression was applied.
+    attr_accessor :scanned
+
+    # Rows the JSON Logic expression matched. Equal to `len(data)` for the page being returned plus any matches found beyond the page size.
+    attr_accessor :matched
+
+    # `true` if the server hit the per-request scan ceiling before finding `page[size]` matches. When true, paginate again with the returned `links.next` cursor to continue scanning past the ceiling.
+    attr_accessor :exhausted
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'scanned' => :'scanned',
+        :'matched' => :'matched',
+        :'exhausted' => :'exhausted'
+      }
+    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
+      {
+        :'scanned' => :'Integer',
+        :'matched' => :'Integer',
+        :'exhausted' => :'Boolean'
+      }
+    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::SearchScanMeta` 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::SearchScanMeta`. 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?(:'scanned')
+        self.scanned = attributes[:'scanned']
+      else
+        self.scanned = nil
+      end
+
+      if attributes.key?(:'matched')
+        self.matched = attributes[:'matched']
+      else
+        self.matched = nil
+      end
+
+      if attributes.key?(:'exhausted')
+        self.exhausted = attributes[:'exhausted']
+      else
+        self.exhausted = 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 @scanned.nil?
+        invalid_properties.push('invalid value for "scanned", scanned cannot be nil.')
+      end
+
+      if @matched.nil?
+        invalid_properties.push('invalid value for "matched", matched cannot be nil.')
+      end
+
+      if @exhausted.nil?
+        invalid_properties.push('invalid value for "exhausted", exhausted 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 @scanned.nil?
+      return false if @matched.nil?
+      return false if @exhausted.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scanned Value to be assigned
+    def scanned=(scanned)
+      if scanned.nil?
+        fail ArgumentError, 'scanned cannot be nil'
+      end
+
+      @scanned = scanned
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] matched Value to be assigned
+    def matched=(matched)
+      if matched.nil?
+        fail ArgumentError, 'matched cannot be nil'
+      end
+
+      @matched = matched
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] exhausted Value to be assigned
+    def exhausted=(exhausted)
+      if exhausted.nil?
+        fail ArgumentError, 'exhausted cannot be nil'
+      end
+
+      @exhausted = exhausted
+    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 &&
+          scanned == o.scanned &&
+          matched == o.matched &&
+          exhausted == o.exhausted
+    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
+      [scanned, matched, exhausted].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.rb

@@ -48,6 +48,11 @@ require 'smplkit_audit_client/models/resource_type_attributes'
 require 'smplkit_audit_client/models/resource_type_list_response'
 require 'smplkit_audit_client/models/resource_type_resource'
 require 'smplkit_audit_client/models/retry_failed_deliveries_summary'
+require 'smplkit_audit_client/models/search_events_list_links'
+require 'smplkit_audit_client/models/search_events_list_meta'
+require 'smplkit_audit_client/models/search_events_request'
+require 'smplkit_audit_client/models/search_events_response'
+require 'smplkit_audit_client/models/search_scan_meta'
 require 'smplkit_audit_client/models/test_forwarder_request'
 require 'smplkit_audit_client/models/test_forwarder_response'
 require 'smplkit_audit_client/models/usage_attributes'
@@ -59,6 +64,7 @@ require 'smplkit_audit_client/api/actions_api'
 require 'smplkit_audit_client/api/events_api'
 require 'smplkit_audit_client/api/forwarders_api'
 require 'smplkit_audit_client/api/resource_types_api'
+require 'smplkit_audit_client/api/search_api'
 require 'smplkit_audit_client/api/usage_api'
 
 module SmplkitGeneratedClient::Audit

data/lib/smplkit/_generated/audit/spec/api/search_api_spec.rb

@@ -0,0 +1,47 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for SmplkitGeneratedClient::Audit::SearchApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SearchApi' do
+  before do
+    # run before each test
+    @api_instance = SmplkitGeneratedClient::Audit::SearchApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SearchApi' do
+    it 'should create an instance of SearchApi' do
+      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::Audit::SearchApi)
+    end
+  end
+
+  # unit tests for search_events
+  # Search Events
+  # Search audit events with column filters and an optional JSON Logic expression.  Without a JSON Logic `filter`: behaves like `GET /api/v1/events` with the same column filters.  With a JSON Logic `filter`: the search is silently capped to the last 30 days by `occurred_at` (intersected with any explicit `filter[occurred_at]` the caller supplied), the column filters narrow the candidate set in SQL, and the JSON Logic expression runs in memory against each candidate row using the same `json-logic-qubit` evaluator the forwarder pipeline uses. Up to 50,000 rows are scanned per request; the response's `meta.scan` block reports the scan stats so a selective filter doesn't look like \"0 matches\" when the truth is \"ceiling reached.\"
+  # @param search_events_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SearchEventsResponse]
+  describe 'search_events test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

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

@@ -0,0 +1,36 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Audit::SearchEventsListLinks
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Audit::SearchEventsListLinks do
+  #let(:instance) { SmplkitGeneratedClient::Audit::SearchEventsListLinks.new }
+
+  describe 'test an instance of SearchEventsListLinks' do
+    it 'should create an instance of SearchEventsListLinks' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::SearchEventsListLinks)
+    end
+  end
+
+  describe 'test attribute "_next"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

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

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Audit::SearchEventsListMeta
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Audit::SearchEventsListMeta do
+  #let(:instance) { SmplkitGeneratedClient::Audit::SearchEventsListMeta.new }
+
+  describe 'test an instance of SearchEventsListMeta' do
+    it 'should create an instance of SearchEventsListMeta' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::SearchEventsListMeta)
+    end
+  end
+
+  describe 'test attribute "page_size"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "scan"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

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

@@ -0,0 +1,96 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Audit::SearchEventsRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Audit::SearchEventsRequest do
+  #let(:instance) { SmplkitGeneratedClient::Audit::SearchEventsRequest.new }
+
+  describe 'test an instance of SearchEventsRequest' do
+    it 'should create an instance of SearchEventsRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::SearchEventsRequest)
+    end
+  end
+
+  describe 'test attribute "filter"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_action"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_resource_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_resource_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_actor_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_actor_id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_occurred_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "filter_search"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "page_size"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "page_after"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "sort"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

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

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Audit::SearchEventsResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Audit::SearchEventsResponse do
+  #let(:instance) { SmplkitGeneratedClient::Audit::SearchEventsResponse.new }
+
+  describe 'test an instance of SearchEventsResponse' do
+    it 'should create an instance of SearchEventsResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::SearchEventsResponse)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "meta"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "links"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

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

@@ -0,0 +1,48 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Audit::SearchScanMeta
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Audit::SearchScanMeta do
+  #let(:instance) { SmplkitGeneratedClient::Audit::SearchScanMeta.new }
+
+  describe 'test an instance of SearchScanMeta' do
+    it 'should create an instance of SearchScanMeta' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::SearchScanMeta)
+    end
+  end
+
+  describe 'test attribute "scanned"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "matched"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "exhausted"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.26
+  version: 3.0.27
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -423,6 +423,7 @@ files:
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/events_api.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/resource_types_api.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/search_api.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/usage_api.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api_client.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api_error.rb
@@ -458,6 +459,11 @@ files:
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/retry_failed_deliveries_summary.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/search_events_list_links.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/search_events_list_meta.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/search_events_request.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/search_events_response.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/search_scan_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_request.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/usage_attributes.rb
@@ -468,6 +474,7 @@ files:
 - lib/smplkit/_generated/audit/spec/api/events_api_spec.rb
 - lib/smplkit/_generated/audit/spec/api/forwarders_api_spec.rb
 - lib/smplkit/_generated/audit/spec/api/resource_types_api_spec.rb
+- lib/smplkit/_generated/audit/spec/api/search_api_spec.rb
 - lib/smplkit/_generated/audit/spec/api/usage_api_spec.rb
 - lib/smplkit/_generated/audit/spec/models/action_attributes_spec.rb
 - lib/smplkit/_generated/audit/spec/models/action_list_response_spec.rb
@@ -499,6 +506,11 @@ files:
 - lib/smplkit/_generated/audit/spec/models/resource_type_list_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/resource_type_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/retry_failed_deliveries_summary_spec.rb
+- lib/smplkit/_generated/audit/spec/models/search_events_list_links_spec.rb
+- lib/smplkit/_generated/audit/spec/models/search_events_list_meta_spec.rb
+- lib/smplkit/_generated/audit/spec/models/search_events_request_spec.rb
+- lib/smplkit/_generated/audit/spec/models/search_events_response_spec.rb
+- lib/smplkit/_generated/audit/spec/models/search_scan_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/test_forwarder_request_spec.rb
 - lib/smplkit/_generated/audit/spec/models/test_forwarder_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/usage_attributes_spec.rb