smplkit 3.0.101 → 3.0.103

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 023cc1c779a1121f562c18522ac3df12441aa82f224b886dcf51b92856607d9f
-  data.tar.gz: 38edf4febecc1c929d086456450d8b836ae5c73866aec3031d2f9c1bbce1eea4
+  metadata.gz: b4885e5b0997b0792d5b2a40437167f76818c0dca5185d78428d54ef6b650f4c
+  data.tar.gz: 75915674e533382f9ce457cffe2f5347c15bf24c2f26ec105fb3503d28c3b442
 SHA512:
-  metadata.gz: d79bfdecf66c1d5896c7f3db0a2faca933cfdeab6025888133ae1e2b999ef2525b0a25224d4295e4d5c4b4b9b0089a0428cee337f2a11d883955626e4214d1ae
-  data.tar.gz: 4ba20edec0551888d6aa7b13ddbd5fc99bd481794a1771e2c271c6f5c212a328cd028e060d9ddb6f59af56d71e094ff3648ae06100e621069b29186ff3ff4120
+  metadata.gz: e4fc9b5b6206da24bf576cc7c9e4a5f1dab28ffa58b53d5d41c41b78092d61ebdf8708a0024efa79c1d593d725237363a45db30a82a2a7de29af6f08ae509cf7
+  data.tar.gz: b2096cc388bde3c892b48235e826c3418dba647abde121f42190007015c4102dee95b6949e2d54e9a962d33da17a932721491b0cf623976ce09fc9a23e24ec6c

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan_definition.rb

@@ -22,11 +22,15 @@ module SmplkitGeneratedClient::App
     # Map of limit key to the cap that applies on this plan. `-1` indicates an unlimited cap.
     attr_accessor :limits
 
+    # For metered products only: map of metered limit key to the per-unit overage price in micro-USD ($0.000001) charged for each unit beyond the plan's included allotment. A rate of `0` means the plan stops at its allotment with no overage. Omitted for products that are not metered.
+    attr_accessor :overage_rates
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'price_monthly_cents' => :'price_monthly_cents',
-        :'limits' => :'limits'
+        :'limits' => :'limits',
+        :'overage_rates' => :'overage_rates'
       }
     end
 
@@ -44,13 +48,15 @@ module SmplkitGeneratedClient::App
     def self.openapi_types
       {
         :'price_monthly_cents' => :'Integer',
-        :'limits' => :'Hash<String, Integer>'
+        :'limits' => :'Hash<String, Integer>',
+        :'overage_rates' => :'Hash<String, Integer>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'overage_rates'
       ])
     end
 
@@ -83,6 +89,12 @@ module SmplkitGeneratedClient::App
       else
         self.limits = nil
       end
+
+      if attributes.key?(:'overage_rates')
+        if (value = attributes[:'overage_rates']).is_a?(Hash)
+          self.overage_rates = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -136,7 +148,8 @@ module SmplkitGeneratedClient::App
       return true if self.equal?(o)
       self.class == o.class &&
           price_monthly_cents == o.price_monthly_cents &&
-          limits == o.limits
+          limits == o.limits &&
+          overage_rates == o.overage_rates
     end
 
     # @see the `==` method
@@ -148,7 +161,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [price_monthly_cents, limits].hash
+      [price_monthly_cents, limits, overage_rates].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/product.rb

@@ -34,6 +34,9 @@ module SmplkitGeneratedClient::App
     # Map of limit key to limit definition for this product.
     attr_accessor :limits
 
+    # Limit keys on this product that are metered: each includes a monthly allotment in the plan price and bills per unit beyond it at the plan's `overage_rates` rate, rather than capping hard. Empty for products with no metered limits.
+    attr_accessor :metered_limits
+
     # Map of plan key to plan definition for this product.
     attr_accessor :plans
 
@@ -46,6 +49,7 @@ module SmplkitGeneratedClient::App
         :'features' => :'features',
         :'coming_soon' => :'coming_soon',
         :'limits' => :'limits',
+        :'metered_limits' => :'metered_limits',
         :'plans' => :'plans'
       }
     end
@@ -69,6 +73,7 @@ module SmplkitGeneratedClient::App
         :'features' => :'Array<String>',
         :'coming_soon' => :'Boolean',
         :'limits' => :'Hash<String, LimitDefinition>',
+        :'metered_limits' => :'Array<String>',
         :'plans' => :'Hash<String, PlanDefinition>'
       }
     end
@@ -132,6 +137,12 @@ module SmplkitGeneratedClient::App
         self.limits = nil
       end
 
+      if attributes.key?(:'metered_limits')
+        if (value = attributes[:'metered_limits']).is_a?(Array)
+          self.metered_limits = value
+        end
+      end
+
       if attributes.key?(:'plans')
         if (value = attributes[:'plans']).is_a?(Hash)
           self.plans = value
@@ -227,6 +238,7 @@ module SmplkitGeneratedClient::App
           features == o.features &&
           coming_soon == o.coming_soon &&
           limits == o.limits &&
+          metered_limits == o.metered_limits &&
           plans == o.plans
     end
 
@@ -239,7 +251,7 @@ module SmplkitGeneratedClient::App
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [display_name, description, tagline, features, coming_soon, limits, plans].hash
+      [display_name, description, tagline, features, coming_soon, limits, metered_limits, plans].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/app/spec/models/plan_definition_spec.rb

@@ -39,4 +39,10 @@ describe SmplkitGeneratedClient::App::PlanDefinition do
     end
   end
 
+  describe 'test attribute "overage_rates"' 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/app/spec/models/product_spec.rb

@@ -63,6 +63,12 @@ describe SmplkitGeneratedClient::App::Product do
     end
   end
 
+  describe 'test attribute "metered_limits"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "plans"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/lib/smplkit/audit/categories.rb

@@ -8,16 +8,19 @@ module Smplkit
     # Response time is independent of how many years of events the account has
     # accumulated. Sorted alphabetically; offset paginated.
     class Categories
-      def initialize(api)
+      def initialize(api, environment: nil)
         @api = api
+        @environment = environment
       end
 
       # List the distinct +category+ values seen in the account.
       #
       # +environments+ scopes the listing to a set of environments: pass an
       # array of environment keys and/or the reserved +"smplkit"+ control-plane
-      # bucket; the values are comma-joined into +filter[environment]+. Omitting
-      # it (or passing an empty array) leaves the filter off entirely.
+      # bucket; the values are comma-joined into +filter[environment]+. Omit it
+      # (the default) to scope the listing to the client's configured
+      # environment; with no configured environment the filter is left off
+      # entirely.
       #
       # @param page_number [Integer, nil] 1-based page index. Omit for the first
       #   page.
@@ -28,7 +31,8 @@ module Smplkit
       #   count server-side). Omit to skip it.
       # @param environments [Array<String>, nil] Environment keys and/or the
       #   reserved +"smplkit"+ control-plane bucket to scope the listing to. Omit
-      #   to leave the filter off entirely.
+      #   to fall back to the client's configured environment; with no configured
+      #   environment the filter is left off entirely.
       # @return [Smplkit::Audit::CategoryListPage] A page of the matching
       #   category values.
       def list(page_number: nil, page_size: nil, meta_total: nil, environments: nil)
@@ -36,8 +40,8 @@ module Smplkit
         opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
         opts[:meta_total] = meta_total unless meta_total.nil?
-        joined_environments = Smplkit::Audit.join_environments(environments)
-        opts[:filter_environment] = joined_environments if joined_environments
+        resolved_environment = Smplkit::Audit.resolve_environment_filter(environments, @environment)
+        opts[:filter_environment] = resolved_environment if resolved_environment
 
         resp = Smplkit::Audit.call_api { @api.list_categories(opts) }
         rows = (resp.data || []).map { |r| Category.from_resource(r) }

data/lib/smplkit/audit/client.rb

@@ -21,9 +21,13 @@ module Smplkit
     #   from +base_domain+/+scheme+; supplied directly by the top-level clients
     #   which have already computed it.
     # @param environment [String, nil] Deployment environment to scope recording
-    #   and reads to. Optional — forwarder CRUD and discovery are
-    #   environment-agnostic, and reads accept an explicit +environments: [...]+
-    #   filter.
+    #   and reads to. Sent on the event request body when recording and as the
+    #   default +filter[environment]+ on the read surfaces (events list and the
+    #   resource_type / event_type / category discovery lists). Optional —
+    #   forwarder CRUD is environment-agnostic, and reads accept an explicit
+    #   +environments: [...]+ filter that overrides this default. With no
+    #   configured environment, recording falls back to the server-side default
+    #   environment and the read filter is left off.
     # @param profile [String, nil] Named +~/.smplkit+ profile section.
     # @param base_domain [String, nil] Base domain for API requests (default
     #   +"smplkit.com"+).
@@ -64,21 +68,26 @@ module Smplkit
         HttpPool.configure(cfg)
         api_client = SmplkitGeneratedClient::Audit::ApiClient.new(cfg)
         api_client.default_headers["User-Agent"] = "smplkit-ruby-sdk/#{Smplkit::VERSION}"
-        # Runtime audit ops are environment-scoped: record / list / get /
-        # discovery all resolve their environment from the
-        # +X-Smplkit-Environment+ request header (ADR-055). We stamp it once
-        # at the client level from the SDK's configured runtime environment so
-        # every generated call carries it. It is stamped before +extra_headers+
-        # is applied so a caller-supplied entry of the same name wins (explicit
-        # override).
-        api_client.default_headers["X-Smplkit-Environment"] = environment unless environment.nil?
+        # Runtime audit ops are environment-scoped, but the scoping is
+        # body-driven (ADR-055): +events.record+ stamps the configured
+        # environment onto the event request body, and the read surfaces
+        # (events list plus the resource_type / event_type / category discovery
+        # lists) default +filter[environment]+ to it. The transport therefore
+        # carries only auth plus any caller-supplied +extra_headers+ — no
+        # environment header. Forwarder CRUD is environment-agnostic.
         extra_headers&.each do |k, v|
           api_client.default_headers[k] = v unless SDK_OWNED_HEADERS.include?(k.downcase)
         end
-        @events = Events.new(SmplkitGeneratedClient::Audit::EventsApi.new(api_client))
-        @resource_types = ResourceTypes.new(SmplkitGeneratedClient::Audit::ResourceTypesApi.new(api_client))
-        @event_types = EventTypes.new(SmplkitGeneratedClient::Audit::EventTypesApi.new(api_client))
-        @categories = Categories.new(SmplkitGeneratedClient::Audit::CategoriesApi.new(api_client))
+        @events = Events.new(SmplkitGeneratedClient::Audit::EventsApi.new(api_client), environment: environment)
+        @resource_types = ResourceTypes.new(
+          SmplkitGeneratedClient::Audit::ResourceTypesApi.new(api_client), environment: environment
+        )
+        @event_types = EventTypes.new(
+          SmplkitGeneratedClient::Audit::EventTypesApi.new(api_client), environment: environment
+        )
+        @categories = Categories.new(
+          SmplkitGeneratedClient::Audit::CategoriesApi.new(api_client), environment: environment
+        )
         @forwarders = ForwardersClient.new(SmplkitGeneratedClient::Audit::ForwardersApi.new(api_client))
       end
 

data/lib/smplkit/audit/event_types.rb

@@ -13,16 +13,19 @@ module Smplkit
     #
     # Sorted alphabetically; offset paginated.
     class EventTypes
-      def initialize(api)
+      def initialize(api, environment: nil)
         @api = api
+        @environment = environment
       end
 
       # List the distinct +event_type+ slugs seen in the account.
       #
       # +environments+ scopes the listing to a set of environments: pass an
       # array of environment keys and/or the reserved +"smplkit"+ control-plane
-      # bucket; the values are comma-joined into +filter[environment]+. Omitting
-      # it (or passing an empty array) leaves the filter off entirely.
+      # bucket; the values are comma-joined into +filter[environment]+. Omit it
+      # (the default) to scope the listing to the client's configured
+      # environment; with no configured environment the filter is left off
+      # entirely.
       #
       # @param filter_resource_type [String, nil] Restrict the listing to
       #   event_types seen with this +resource_type+. Omit to list every distinct
@@ -36,7 +39,8 @@ module Smplkit
       #   count server-side). Omit to skip it.
       # @param environments [Array<String>, nil] Environment keys and/or the
       #   reserved +"smplkit"+ control-plane bucket to scope the listing to. Omit
-      #   to leave the filter off entirely.
+      #   to fall back to the client's configured environment; with no configured
+      #   environment the filter is left off entirely.
       # @return [Smplkit::Audit::EventTypeListPage] A page of the matching
       #   event-type slugs.
       def list(filter_resource_type: nil, page_number: nil, page_size: nil, meta_total: nil, environments: nil)
@@ -45,8 +49,8 @@ module Smplkit
         opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
         opts[:meta_total] = meta_total unless meta_total.nil?
-        joined_environments = Smplkit::Audit.join_environments(environments)
-        opts[:filter_environment] = joined_environments if joined_environments
+        resolved_environment = Smplkit::Audit.resolve_environment_filter(environments, @environment)
+        opts[:filter_environment] = resolved_environment if resolved_environment
 
         resp = Smplkit::Audit.call_api { @api.list_event_types(opts) }
         rows = (resp.data || []).map { |r| EventType.from_resource(r) }

data/lib/smplkit/audit/events.rb

@@ -9,8 +9,9 @@ module Smplkit
     # +flush: true+ to block until the event is durable before continuing.
     # +#list+ and +#get+ are synchronous reads.
     class Events
-      def initialize(api)
+      def initialize(api, environment: nil)
         @api = api
+        @environment = environment
         @buffer = EventBuffer.new(api)
       end
 
@@ -105,6 +106,13 @@ module Smplkit
           data: data || {},
           do_not_forward: do_not_forward
         )
+        # Stamp the client's configured environment onto the event body — the
+        # body-driven replacement for the old +X-Smplkit-Environment+ header
+        # (ADR-055). Left off when nil so a single-environment credential
+        # resolves it server-side. Assigning conditionally (rather than passing
+        # +environment: nil+ through the constructor) keeps the field out of the
+        # serialized body entirely when unconfigured.
+        attrs.environment = @environment unless @environment.nil?
         resource = SmplkitGeneratedClient::Audit::EventResource.new(
           id: "",
           type: "event",
@@ -141,6 +149,13 @@ module Smplkit
       # +occurred_at_range+, or with both +resource_type+ and +resource_id+ —
       # or the request is rejected.
       #
+      # +environments+ scopes the read to a set of environments: pass an array
+      # of environment keys and/or the reserved +"smplkit"+ control-plane
+      # bucket; the values are sent comma-separated as +filter[environment]+.
+      # Omit it (the default) to scope the read to the client's configured
+      # environment; with no configured environment the filter is left off
+      # entirely.
+      #
       # @param event_type [String, nil] Return only events with this
       #   +event_type+. Omit to match any.
       # @param resource_type [String, nil] Return only events about this
@@ -160,7 +175,8 @@ module Smplkit
       #   or the request is rejected. Omit to disable text filtering.
       # @param environments [Array<String>, nil] Environment keys (and/or the
       #   reserved +"smplkit"+ control-plane bucket) to scope the read to. Omit
-      #   to leave the filter off entirely.
+      #   to fall back to the client's configured environment; with no configured
+      #   environment the filter is left off entirely.
       # @param page_size [Integer, nil] Maximum number of events to return in
       #   this page.
       # @param page_after [String, nil] Opaque cursor from a previous page's
@@ -183,8 +199,8 @@ module Smplkit
         opts[:filter_actor_id] = actor_id if actor_id
         opts[:filter_occurred_at] = occurred_at_range if occurred_at_range
         opts[:filter_search] = search if search
-        joined_environments = Smplkit::Audit.join_environments(environments)
-        opts[:filter_environment] = joined_environments if joined_environments
+        resolved_environment = Smplkit::Audit.resolve_environment_filter(environments, @environment)
+        opts[:filter_environment] = resolved_environment if resolved_environment
         opts[:page_size] = page_size if page_size
         opts[:page_after] = page_after if page_after
 

data/lib/smplkit/audit/models.rb

@@ -79,6 +79,28 @@ module Smplkit
       values.empty? ? nil : values.join(",")
     end
 
+    # Resolve the +filter[environment]+ value for a read surface.
+    #
+    # An explicit, non-empty +environments+ list always wins and is comma-joined
+    # via {join_environments}. Otherwise the client's configured +default+
+    # environment scopes the read — the body-driven replacement for the old
+    # per-request +X-Smplkit-Environment+ header (ADR-055), which previously
+    # scoped every read to the client's environment. A client with no configured
+    # environment and no explicit list returns +nil+ so the caller omits the
+    # query param and the credential's own scoping applies server-side.
+    #
+    # @param environments [Array<String>, String, nil] Explicit per-call
+    #   environment filter; an empty/blank value falls through to +default+.
+    # @param default [String, nil] The client's configured environment.
+    # @return [String, nil] The +filter[environment]+ value, or +nil+ to omit it.
+    # @api private
+    def self.resolve_environment_filter(environments, default)
+      joined = join_environments(environments)
+      return joined unless joined.nil?
+
+      default
+    end
+
     # Supported SIEM forwarder destination types.
     #
     # Members are declared in alphabetical order. Customers pass these
@@ -204,7 +226,7 @@ module Smplkit
     #     Read-only and always present on reads — the audit service resolves it
     #     when the event is recorded (from a single-environment credential, or
     #     from the runtime SDK's configured environment, which the SDK sends on
-    #     every recording call). Never set on the recording request body.
+    #     the recording request body).
     AuditEvent = Struct.new(
       :id, :event_type, :resource_type, :resource_id,
       :occurred_at, :created_at,

data/lib/smplkit/audit/resource_types.rb

@@ -8,16 +8,19 @@ module Smplkit
     # Response time is independent of how many years of events the account has
     # accumulated. Sorted alphabetically; offset paginated.
     class ResourceTypes
-      def initialize(api)
+      def initialize(api, environment: nil)
         @api = api
+        @environment = environment
       end
 
       # List the distinct +resource_type+ slugs seen in the account.
       #
       # +environments+ scopes the listing to a set of environments: pass an
       # array of environment keys and/or the reserved +"smplkit"+ control-plane
-      # bucket; the values are comma-joined into +filter[environment]+. Omitting
-      # it (or passing an empty array) leaves the filter off entirely.
+      # bucket; the values are comma-joined into +filter[environment]+. Omit it
+      # (the default) to scope the listing to the client's configured
+      # environment; with no configured environment the filter is left off
+      # entirely.
       #
       # @param page_number [Integer, nil] 1-based page index. Omit for the first
       #   page.
@@ -28,7 +31,8 @@ module Smplkit
       #   count server-side). Omit to skip it.
       # @param environments [Array<String>, nil] Environment keys and/or the
       #   reserved +"smplkit"+ control-plane bucket to scope the listing to. Omit
-      #   to leave the filter off entirely.
+      #   to fall back to the client's configured environment; with no configured
+      #   environment the filter is left off entirely.
       # @return [Smplkit::Audit::ResourceTypeListPage] A page of the matching
       #   resource-type slugs.
       def list(page_number: nil, page_size: nil, meta_total: nil, environments: nil)
@@ -36,8 +40,8 @@ module Smplkit
         opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
         opts[:meta_total] = meta_total unless meta_total.nil?
-        joined_environments = Smplkit::Audit.join_environments(environments)
-        opts[:filter_environment] = joined_environments if joined_environments
+        resolved_environment = Smplkit::Audit.resolve_environment_filter(environments, @environment)
+        opts[:filter_environment] = resolved_environment if resolved_environment
 
         resp = Smplkit::Audit.call_api { @api.list_resource_types(opts) }
         rows = (resp.data || []).map { |r| ResourceType.from_resource(r) }

data/lib/smplkit/client.rb

@@ -124,9 +124,11 @@ module Smplkit
       # borrows the shared logging transport and WebSocket. The two management
       # sub-clients live at client.logging.loggers / client.logging.log_groups.
       @logging = Logging::LoggingClient.new(parent: self, transport: @transports.logging_http, metrics: @metrics)
-      # Audit's full surface on one client; this runtime instance carries the
-      # configured environment as ``X-Smplkit-Environment`` and owns its own
-      # transport (closed in ``close``).
+      # Audit's full surface on one client; this runtime instance scopes audit
+      # ops to the configured environment via the body-driven path (ADR-055):
+      # ``events.record`` stamps it on the event body and the read surfaces
+      # default ``filter[environment]`` to it. Owns its own transport (closed in
+      # ``close``).
       @audit = Audit::AuditClient.new(
         api_key: cfg.api_key, base_url: audit_url, environment: cfg.environment, extra_headers: extra_headers
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.101
+  version: 3.0.103
 platform: ruby
 authors:
 - Smpl Solutions LLC