noresponse 10.0.10 → 10.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d96b8580166e44806112443d1675e10b636e5c6c80d66163632042e21385c8d3
-  data.tar.gz: 65422e8912fcbec275173a0d1b9fec1c0f78851bf8504a2fb6b8f8e06bf5db65
+  metadata.gz: 11deaafb30241b9fc0e9d1d7d44fbedba4fc85260486e5a10a4fdc62be3c34b3
+  data.tar.gz: 84f28e10935cb2c180b8faa6bee41b8d7c9779bf941217a27866ee3f9ea1ca30
 SHA512:
-  metadata.gz: a8db10579a56cdf898208e5ba72e7d8f0d74ac9b1622469ec9704d84d2880c02b7747fff0f10e3d09a17d3af8d037a6bf489e2d0af5d1f1d0cecfa2dc02384ea
-  data.tar.gz: 399fe22b16111ba4de9cb5cb6b4e1a942682a9f931c8e5457ccc645e02c522a3571e34133adeae86a13270caee10c3d3226b81bbde7eb2c309035f4f62993d46
+  metadata.gz: 2eff2d401db21e107b427fed6d02671fe46ab5c92791bbc567bfaea1d918b8eb82150b5f977d2a458f633f0fe39e68cb8fec23ccb71e67f0c85bcc71525d3d45
+  data.tar.gz: 06fe0c24ce4404c94393470d7f8d3a7ea18e7a7e5bb1191feb0e04c91ab4dd1b8204efb42126daab1f0cad9e0c30415350c31051f3e6049209a34fa337a807e1

data/lib/no_response/events.rb

@@ -3029,7 +3029,7 @@ module NoResponse
       http_headers: nil
     )
       # start_screening - Start a screening.
-      # Start a screening of new attendees and everyone on watch or escalated, with an Idempotency-Key. It finishes completed, partial or failed minutes to hours later; poll it. The test environment screens with stand-ins that find no accounts.
+      # Start a screening of new attendees and everyone on watch or escalated, with an Idempotency-Key. It finishes completed, partial or failed minutes to hours later; poll it. The answer carries estimated_spend; a screening whose estimate exceeds what the daily screening cap has left answers 409 screening_cap_exceeded. The test environment screens with stand-ins that find no accounts.
       request = Models::Operations::StartScreeningRequest.new(
         workspace_id: workspace_id,
         environment: environment,

data/lib/no_response/models/shared/conflicterrorcode.rb

@@ -36,6 +36,7 @@ module NoResponse
           AGGREGATE_ERASED_DATA = new("aggregate_erased_data")
           EVENT_CONFLICT = new("event_conflict")
           EVENT_LIMIT_REACHED = new("event_limit_reached")
+          SCREENING_CAP_EXCEEDED = new("screening_cap_exceeded")
           SCREENING_UNAVAILABLE = new("screening_unavailable")
         end
 

data/lib/no_response/models/shared/metric.rb

@@ -4,13 +4,14 @@
 module NoResponse
   module Models
     module Shared
-      # Metric - assessments: assessments admitted. webhook_deliveries: events sent to endpoints, one per event per endpoint. key_usage_events: key-usage events accepted.
+      # Metric - assessments: assessments admitted. webhook_deliveries: events sent to endpoints, one per event per endpoint. key_usage_events: key-usage events accepted. screenings: attendees a screening recorded a final result for, one per attendee per screening; a failed attendee counts nothing.
       class Metric
         include ::Crystalline::Enum
         enums do
           ASSESSMENTS = new("assessments")
           WEBHOOK_DELIVERIES = new("webhook_deliveries")
           KEY_USAGE_EVENTS = new("key_usage_events")
+          SCREENINGS = new("screenings")
         end
 
         open!

data/lib/no_response/models/shared/policyhistoryitem.rb

@@ -9,7 +9,7 @@ module NoResponse
         extend T::Sig
         include Crystalline::MetadataFields
 
-        # One environment's settings: how long its assessments are kept, and for each flow the risk thresholds that decide it and the depth a request that names none is served at, and the sources it refuses. Live and test each have their own. A flow without thresholds of its own uses account_creation's (inherits_account_creation). Every change is recorded in the audit log as settings.updated, with who made it.
+        # One environment's settings: how long its assessments are kept, and for each flow the risk thresholds that decide it and the depth a request that names none is served at, the sources it refuses, and the daily cap on screening spend. Live and test each have their own. A flow without thresholds of its own uses account_creation's (inherits_account_creation). Every change is recorded in the audit log as settings.updated, with who made it.
         field(
           :settings,
           Models::Shared::Settings,

data/lib/no_response/models/shared/screening.rb

@@ -100,6 +100,18 @@ module NoResponse
           ::Integer,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attendees_failed"), required: true}}
         )
+        # What the screening was estimated to cost when it started, in minor units of USD (cents): its attendees at its depth and platforms. Until the screening finishes, what it has not yet spent counts against the environment's screening_daily_cap.
+        field(
+          :estimated_spend,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("estimated_spend"), required: true}}
+        )
+        # What the attendees it has screened recorded, in minor units of USD. Each counts toward the UTC day it was recorded on; a failed attendee records nothing.
+        field(
+          :spent,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("spent"), required: true}}
+        )
 
         field(
           :started_at,
@@ -134,6 +146,8 @@ module NoResponse
             attendees_done: ::Integer,
             attendees_flagged: ::Integer,
             attendees_failed: ::Integer,
+            estimated_spend: ::Integer,
+            spent: ::Integer,
             started_at: T.nilable(::String),
             finished_at: T.nilable(::String),
             error_code: T.nilable(::String)
@@ -154,6 +168,8 @@ module NoResponse
           attendees_done:,
           attendees_flagged:,
           attendees_failed:,
+          estimated_spend:,
+          spent:,
           started_at: nil,
           finished_at: nil,
           error_code: nil
@@ -171,6 +187,8 @@ module NoResponse
           @attendees_done = attendees_done
           @attendees_flagged = attendees_flagged
           @attendees_failed = attendees_failed
+          @estimated_spend = estimated_spend
+          @spent = spent
           @started_at = started_at
           @finished_at = finished_at
           @error_code = error_code
@@ -192,6 +210,8 @@ module NoResponse
           return false unless @attendees_done == other.attendees_done
           return false unless @attendees_flagged == other.attendees_flagged
           return false unless @attendees_failed == other.attendees_failed
+          return false unless @estimated_spend == other.estimated_spend
+          return false unless @spent == other.spent
           return false unless @started_at == other.started_at
           return false unless @finished_at == other.finished_at
           return false unless @error_code == other.error_code

data/lib/no_response/models/shared/screening.rbi

@@ -84,6 +84,18 @@ class NoResponse::Models::Shared::Screening
   def attendees_failed=(str_)
   end
 
+  def estimated_spend
+  end
+
+  def estimated_spend=(str_)
+  end
+
+  def spent
+  end
+
+  def spent=(str_)
+  end
+
   def started_at
   end
 

data/lib/no_response/models/shared/settings.rb

@@ -4,7 +4,7 @@
 module NoResponse
   module Models
     module Shared
-      # One environment's settings: how long its assessments are kept, and for each flow the risk thresholds that decide it and the depth a request that names none is served at, and the sources it refuses. Live and test each have their own. A flow without thresholds of its own uses account_creation's (inherits_account_creation). Every change is recorded in the audit log as settings.updated, with who made it.
+      # One environment's settings: how long its assessments are kept, and for each flow the risk thresholds that decide it and the depth a request that names none is served at, the sources it refuses, and the daily cap on screening spend. Live and test each have their own. A flow without thresholds of its own uses account_creation's (inherits_account_creation). Every change is recorded in the audit log as settings.updated, with who made it.
       class Settings
         extend T::Sig
         include Crystalline::MetadataFields
@@ -63,6 +63,12 @@ module NoResponse
           Crystalline::Nilable.new(::String),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("updated_at")}}
         )
+        # The most the environment's screenings may spend in one UTC day, in minor units of USD (cents), 0 to 100000000; null is no cap. Default 50000. A screening whose estimated_spend exceeds the cap less the day's recorded spend and what open screenings may still spend answers 409 screening_cap_exceeded.
+        field(
+          :screening_daily_cap,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("screening_daily_cap"), required: true}}
+        )
 
         sig {
           params(
@@ -73,7 +79,8 @@ module NoResponse
             flows: Models::Shared::SettingsFlows,
             refused_sources: T::Array[Models::Shared::SourceId],
             updated_by: T.nilable(::String),
-            updated_at: T.nilable(::String)
+            updated_at: T.nilable(::String),
+            screening_daily_cap: T.nilable(::Integer)
           )
             .void
         }
@@ -85,7 +92,8 @@ module NoResponse
           flows:,
           refused_sources:,
           updated_by: nil,
-          updated_at: nil
+          updated_at: nil,
+          screening_daily_cap: nil
         )
           @workspace_id = workspace_id
           @environment = environment
@@ -95,6 +103,7 @@ module NoResponse
           @refused_sources = refused_sources
           @updated_by = updated_by
           @updated_at = updated_at
+          @screening_daily_cap = screening_daily_cap
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
@@ -108,6 +117,7 @@ module NoResponse
           return false unless @refused_sources == other.refused_sources
           return false unless @updated_by == other.updated_by
           return false unless @updated_at == other.updated_at
+          return false unless @screening_daily_cap == other.screening_daily_cap
           true
         end
       end

data/lib/no_response/models/shared/settings.rbi

@@ -53,4 +53,10 @@ class NoResponse::Models::Shared::Settings
 
   def updated_at=(str_)
   end
+
+  def screening_daily_cap
+  end
+
+  def screening_daily_cap=(str_)
+  end
 end

data/lib/no_response/models/shared/settingsrequest.rb

@@ -38,6 +38,12 @@ module NoResponse
           Crystalline::Nilable.new(::String),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("change_reason")}}
         )
+        # Replaces the daily screening cap, in minor units of USD; null removes the cap. Needs settings.write only, like retention_days.
+        field(
+          :screening_daily_cap,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("screening_daily_cap")}}
+        )
 
         sig {
           params(
@@ -45,7 +51,8 @@ module NoResponse
             refused_sources: T.nilable(T::Array[Models::Shared::SourceId]),
             flows: T.nilable(Models::Shared::SettingsRequestFlows),
             expected_policy_version: T.nilable(::Integer),
-            change_reason: T.nilable(::String)
+            change_reason: T.nilable(::String),
+            screening_daily_cap: T.nilable(::Integer)
           )
             .void
         }
@@ -54,13 +61,15 @@ module NoResponse
           refused_sources: nil,
           flows: nil,
           expected_policy_version: nil,
-          change_reason: nil
+          change_reason: nil,
+          screening_daily_cap: nil
         )
           @retention_days = retention_days
           @refused_sources = refused_sources
           @flows = flows
           @expected_policy_version = expected_policy_version
           @change_reason = change_reason
+          @screening_daily_cap = screening_daily_cap
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
@@ -71,6 +80,7 @@ module NoResponse
           return false unless @flows == other.flows
           return false unless @expected_policy_version == other.expected_policy_version
           return false unless @change_reason == other.change_reason
+          return false unless @screening_daily_cap == other.screening_daily_cap
           true
         end
       end

data/lib/no_response/models/shared/settingsrequest.rbi

@@ -35,4 +35,10 @@ class NoResponse::Models::Shared::SettingsRequest
 
   def change_reason=(str_)
   end
+
+  def screening_daily_cap
+  end
+
+  def screening_daily_cap=(str_)
+  end
 end

data/lib/no_response/models/shared/usage.rb

@@ -4,7 +4,7 @@
 module NoResponse
   module Models
     module Shared
-      # Body of the 200 answer to GET /v1/workspaces/{workspace_id}/usage: what the workspace's environments were metered for on each UTC day from from through to. Each billable unit is counted once, where it becomes final: an assessment when it is admitted (by flow and depth), a webhook delivery once per event per endpoint (retries and replays add nothing), and a key-usage event once when the ingest accepts it. A count does not change when the assessment, account or workspace is later deleted. A day, environment or metric with nothing counted has no item. No prices or billing. console_lookups is the one limit: the live environment's daily cap on console lookups, as spent today.
+      # Body of the 200 answer to GET /v1/workspaces/{workspace_id}/usage: what the workspace's environments were metered for on each UTC day from from through to. Each billable unit is counted once, where it becomes final: an assessment when it is admitted (by flow and depth), a webhook delivery once per event per endpoint (retries and replays add nothing), a key-usage event once when the ingest accepts it, and a screened attendee once per screening when its result is recorded. A count does not change when the assessment, account or workspace is later deleted. A day, environment or metric with nothing counted has no item. No prices or billing; screening spend is in each screening's spent. console_lookups is the one limit: the live environment's daily cap on console lookups, as spent today.
       class Usage
         extend T::Sig
         include Crystalline::MetadataFields

data/lib/no_response/models/shared/usagecount.rb

@@ -22,7 +22,7 @@ module NoResponse
         )
 
         field :day, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("day"), required: true}}
-        # assessments: assessments admitted. webhook_deliveries: events sent to endpoints, one per event per endpoint. key_usage_events: key-usage events accepted.
+        # assessments: assessments admitted. webhook_deliveries: events sent to endpoints, one per event per endpoint. key_usage_events: key-usage events accepted. screenings: attendees a screening recorded a final result for, one per attendee per screening; a failed attendee counts nothing.
         field(
           :metric,
           Models::Shared::Metric,

data/lib/no_response/sdkconfiguration.rb

@@ -95,9 +95,9 @@ module NoResponse
 
       @language = "ruby"
       @openapi_doc_version = "1"
-      @sdk_version = "10.0.10"
+      @sdk_version = "10.0.11"
       @gen_version = "internal"
-      @user_agent = "noresponse-sdk/ruby 10.0.10 internal 1 noresponse"
+      @user_agent = "noresponse-sdk/ruby 10.0.11 internal 1 noresponse"
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

data/lib/no_response/settings.rb

@@ -49,7 +49,7 @@ module NoResponse
     }
     def get(workspace_id:, environment:, retries: nil, timeout_ms: nil, http_headers: nil)
       # get - Read an environment's settings.
-      # Read this environment retention, source selection and effective flow policies. A flow without its own thresholds inherits account_creation. Requires settings or management. Another environment answers404. Read-only and safe to retry.
+      # Read this environment retention, source selection, daily screening cap and effective flow policies. A flow without its own thresholds inherits account_creation. Requires settings or management. Another environment answers404. Read-only and safe to retry.
       request = Models::Operations::GetSettingsRequest.new(
         workspace_id: workspace_id,
         environment: environment
@@ -340,7 +340,7 @@ module NoResponse
     }
     def update(body:, workspace_id:, environment:, retries: nil, timeout_ms: nil, http_headers: nil)
       # update - Change an environment's settings.
-      # Change named retention, source or flow settings in one transaction. Requires settings or management; changes to active policy also require policy_publish, which legacy management includes. Use expected_policy_version to reject concurrent changes and record a change_reason. Each accepted change creates a fresh version and an atomic audit event. Retention-only edits do not require policy publication authority. Flow thresholds preserve their declared ordering and bounds.
+      # Change named retention, screening cap, source or flow settings in one transaction. Requires settings or management; changes to active policy also require policy_publish, which legacy management includes. Use expected_policy_version to reject concurrent changes and record a change_reason. Each accepted change creates a fresh version and an atomic audit event. Retention and screening cap edits do not require policy publication authority. Flow thresholds preserve their declared ordering and bounds.
       request = Models::Operations::UpdateSettingsRequest.new(
         workspace_id: workspace_id,
         environment: environment,

data/lib/no_response/usage.rb

@@ -50,7 +50,7 @@ module NoResponse
     }
     def get(workspace_id:, from: nil, to: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # get - Read a workspace's usage.
-      # Read daily usage units for the environments you can access. These counts are unpriced. With live access it also returns the daily console lookup cap: used, limit and resets_at.
+      # Read daily usage units, screenings included, for the environments you can access. These counts are unpriced. With live access it also returns the daily console lookup cap: used, limit and resets_at.
       request = Models::Operations::GetUsageRequest.new(
         workspace_id: workspace_id,
         from: from,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noresponse
 version: !ruby/object:Gem::Version
-  version: 10.0.10
+  version: 10.0.11
 platform: ruby
 authors:
 - NoResponse