noresponse 10.0.12 → 10.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d85291717a92183c2302b31d3d0f62582b5561a73c71ad96653471708f6f320
-  data.tar.gz: 21707ffd2be377765fbb485bb748edfd1f4aade4891ca596926088ccc0f7acc9
+  metadata.gz: a9d583f5c8f0b06adc80bb220a841bce567584d6f9c197995799d71720f12aaa
+  data.tar.gz: 7cb2890a3937c798476a19f7f89c8c9ca2a149887d9bd4c24cd5fb6f0da161ff
 SHA512:
-  metadata.gz: faaf0a015394cdd88127765ae24a0674c25196b492d0b45b9b161af3b970c84ebe96a78e03939e39f843ca56e3327da05f0b635dd7b37d2fe80c6dc90d88dd75
-  data.tar.gz: 926780bbb6c32c1fe083c8600d760c1e78c30f23e4bab8d5d5d694b0d95afb173f17082c8e3a8de294888462bd38468bbc38f90b098c3520513702d9ad60395e
+  metadata.gz: 20042b422dced170ddff9a2bb330b70462fefaa633b15bd62617ded43d2a32cd5b62d6b070eb284ae99a76dd958c78378594b57ff86dc7c720144be14bf37543
+  data.tar.gz: 842ccde2835a7e443e9cc7b429bb4d297b65befe3d0a099358312a97dab85483b14a53bd111eae68c7ad0e4861268fbefeed5f590f96c9bb6a7abd72d5896ded

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 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.
+      # 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 the synthetic connector, which makes up deterministic profiles, posts and findings.
       request = Models::Operations::StartScreeningRequest.new(
         workspace_id: workspace_id,
         environment: environment,

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Access - public profiles were read; a private or locked one exists but could not be read.
+      class Access
+        include ::Crystalline::Enum
+        enums do
+          PUBLIC = new("public")
+          PRIVATE = new("private")
+          LOCKED = new("locked")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/{profile.rbi → access.rbi}

@@ -1,9 +1,9 @@
 # typed: true
 # frozen_string_literal: true
 
-class NoResponse::Models::Shared::Profile
+class NoResponse::Models::Shared::Access
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class NoResponse::Models::Shared::Profile
+class NoResponse::Models::Shared::Access
 end

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

@@ -30,10 +30,10 @@ module NoResponse
             }
           }
         )
-        # What the latest screening read, per platform.
+        # The denominator of a screening: accounts found, how many could be read, items read and the period they span, so a clean result is distinct from a person nobody could see.
         field(
           :coverage,
-          Models::Shared::AttendeeCoverage,
+          Models::Shared::ScreeningCoverage,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("coverage"), required: true}}
         )
 
@@ -48,6 +48,12 @@ module NoResponse
           ::String,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("updated_at"), required: true}}
         )
+        # What screening cost, in US cents, in total and per implementation.
+        field(
+          :spend,
+          Models::Shared::ScreeningSpend,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("spend"), required: true}}
+        )
         # Your own id for the attendee, unique within the event. A later row with the same external id updates this attendee.
         field(
           :external_id,
@@ -145,9 +151,10 @@ module NoResponse
             event_id: ::String,
             name: ::String,
             match_state: Models::Shared::MatchState,
-            coverage: Models::Shared::AttendeeCoverage,
+            coverage: Models::Shared::ScreeningCoverage,
             created_at: ::String,
             updated_at: ::String,
+            spend: Models::Shared::ScreeningSpend,
             external_id: T.nilable(::String),
             email: T.nilable(::String),
             phone: T.nilable(::String),
@@ -172,6 +179,7 @@ module NoResponse
           coverage:,
           created_at:,
           updated_at:,
+          spend:,
           external_id: nil,
           email: nil,
           phone: nil,
@@ -193,6 +201,7 @@ module NoResponse
           @coverage = coverage
           @created_at = created_at
           @updated_at = updated_at
+          @spend = spend
           @external_id = external_id
           @email = email
           @phone = phone
@@ -218,6 +227,7 @@ module NoResponse
           return false unless @coverage == other.coverage
           return false unless @created_at == other.created_at
           return false unless @updated_at == other.updated_at
+          return false unless @spend == other.spend
           return false unless @external_id == other.external_id
           return false unless @email == other.email
           return false unless @phone == other.phone

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

@@ -48,6 +48,12 @@ class NoResponse::Models::Shared::Attendee
   def updated_at=(str_)
   end
 
+  def spend
+  end
+
+  def spend=(str_)
+  end
+
   def external_id
   end
 

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

@@ -15,18 +15,30 @@ module NoResponse
           Models::Shared::Attendee,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attendee"), required: true}}
         )
-        # The accounts the screening matched, with how each was matched.
+        # The accounts the latest screening matched, with how each was matched.
         field(
           :profiles,
-          Crystalline::Array.new(Models::Shared::Profile),
+          Crystalline::Array.new(Models::Shared::ScreeningProfile),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("profiles"), required: true}}
         )
-        # What the screening flagged, with its evidence.
+        # What the latest screening flagged, most severe first, each citing its evidence.
         field(
           :findings,
-          Crystalline::Array.new(Models::Shared::Finding),
+          Crystalline::Array.new(Models::Shared::ScreeningFinding),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("findings"), required: true}}
         )
+        # The posts the findings cite.
+        field(
+          :posts,
+          Crystalline::Array.new(Models::Shared::ScreeningPost),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("posts"), required: true}}
+        )
+        # The images and videos the findings cite.
+        field(
+          :media,
+          Crystalline::Array.new(Models::Shared::ScreeningMedia),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("media"), required: true}}
+        )
         # Every recorded decision, oldest first.
         field(
           :reviews,
@@ -37,16 +49,20 @@ module NoResponse
         sig {
           params(
             attendee: Models::Shared::Attendee,
-            profiles: T::Array[Models::Shared::Profile],
-            findings: T::Array[Models::Shared::Finding],
+            profiles: T::Array[Models::Shared::ScreeningProfile],
+            findings: T::Array[Models::Shared::ScreeningFinding],
+            posts: T::Array[Models::Shared::ScreeningPost],
+            media: T::Array[Models::Shared::ScreeningMedia],
             reviews: T::Array[Models::Shared::AttendeeReview]
           )
             .void
         }
-        def initialize(attendee:, profiles:, findings:, reviews:)
+        def initialize(attendee:, profiles:, findings:, posts:, media:, reviews:)
           @attendee = attendee
           @profiles = profiles
           @findings = findings
+          @posts = posts
+          @media = media
           @reviews = reviews
         end
 
@@ -56,6 +72,8 @@ module NoResponse
           return false unless @attendee == other.attendee
           return false unless @profiles == other.profiles
           return false unless @findings == other.findings
+          return false unless @posts == other.posts
+          return false unless @media == other.media
           return false unless @reviews == other.reviews
           true
         end

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

@@ -24,6 +24,18 @@ class NoResponse::Models::Shared::AttendeeReport
   def findings=(str_)
   end
 
+  def posts
+  end
+
+  def posts=(str_)
+  end
+
+  def media
+  end
+
+  def media=(str_)
+  end
+
   def reviews
   end
 

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

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # FindingBand - How severe a finding is, most severe first.
+      class FindingBand
+        include ::Crystalline::Enum
+        enums do
+          CRITICAL = new("critical")
+          HIGH = new("high")
+          MODERATE = new("moderate")
+          LOW = new("low")
+          INFO = new("info")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/{attendee_coverage.rbi → findingband.rbi}

@@ -1,9 +1,9 @@
 # typed: true
 # frozen_string_literal: true
 
-class NoResponse::Models::Shared::AttendeeCoverage
+class NoResponse::Models::Shared::FindingBand
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class NoResponse::Models::Shared::AttendeeCoverage
+class NoResponse::Models::Shared::FindingBand
 end

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

@@ -0,0 +1,27 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # FindingCategory - What a finding is about: a direct threat to the principal or the event, intent to harm without a named target, fixation on the principal, a grievance against the host, research into the venue, route or security, weapons tied to any of these, disruption or protest planning toward this event, violent extremist content or identification, prior harassment or stalking of staff or principals, or posting the principal's addresses or movements.
+      class FindingCategory
+        include ::Crystalline::Enum
+        enums do
+          DIRECT_THREAT = new("direct_threat")
+          HARM_INTENT = new("harm_intent")
+          FIXATION = new("fixation")
+          GRIEVANCE = new("grievance")
+          SECURITY_RESEARCH = new("security_research")
+          WEAPONS = new("weapons")
+          DISRUPTION = new("disruption")
+          VIOLENT_EXTREMISM = new("violent_extremism")
+          HARASSMENT = new("harassment")
+          MOVEMENT_EXPOSURE = new("movement_exposure")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/{screening_platform.rbi → findingcategory.rbi}

@@ -1,9 +1,9 @@
 # typed: true
 # frozen_string_literal: true
 
-class NoResponse::Models::Shared::ScreeningPlatform
+class NoResponse::Models::Shared::FindingCategory
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class NoResponse::Models::Shared::ScreeningPlatform
+class NoResponse::Models::Shared::FindingCategory
 end

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

@@ -9,6 +9,7 @@ module NoResponse
         extend T::Sig
         include Crystalline::MetadataFields
 
+        # A platform a screening can cover. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.
         field(
           :platform,
           Models::Shared::HandlePlatform,

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

@@ -4,7 +4,7 @@
 module NoResponse
   module Models
     module Shared
-
+      # HandlePlatform - A platform a screening can cover. synthetic is the deterministic connector's own platform, for exercising the product end to end with no network.
       class HandlePlatform
         include ::Crystalline::Enum
         enums do
@@ -18,6 +18,7 @@ module NoResponse
           REDDIT = new("reddit")
           TELEGRAM = new("telegram")
           LINKEDIN = new("linkedin")
+          SYNTHETIC = new("synthetic")
         end
 
         open!

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class MediaType
+        include ::Crystalline::Enum
+        enums do
+          IMAGE = new("image")
+          VIDEO = new("video")
+        end
+
+        open!
+      end
+    end
+  end
+end

data/lib/no_response/models/shared/{finding.rbi → mediatype.rbi}

@@ -1,9 +1,9 @@
 # typed: true
 # frozen_string_literal: true
 
-class NoResponse::Models::Shared::Finding
+class NoResponse::Models::Shared::MediaType
   extend ::Crystalline::MetadataFields::ClassMethods
 end
 
-class NoResponse::Models::Shared::Finding
+class NoResponse::Models::Shared::MediaType
 end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # ProfileMatchState - How sure the screening is that a profile is the attendee's, from its evidence: confirmed is two or more hard identifiers (email, phone, a supplied handle, or a fact an existing source returned), probable is one identifier beyond the name, possible is the name alone.
+      class ProfileMatchState
+        include ::Crystalline::Enum
+        enums do
+          CONFIRMED = new("confirmed")
+          PROBABLE = new("probable")
+          POSSIBLE = new("possible")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ProfileMatchState
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ProfileMatchState
+end

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

@@ -28,7 +28,7 @@ module NoResponse
             }
           }
         )
-        # partial finished with some attendees not covered; attendees_failed counts them.
+        # partial finished with some attendees or platforms not covered; attendees_failed and attendees_partial count them.
         field(
           :status,
           Models::Shared::ScreeningStatus,
@@ -55,7 +55,7 @@ module NoResponse
 
         field(
           :platforms,
-          Crystalline::Array.new(Models::Shared::ScreeningPlatform),
+          Crystalline::Array.new(Models::Shared::HandlePlatform),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("platforms"), required: true}}
         )
 
@@ -100,6 +100,12 @@ module NoResponse
           ::Integer,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attendees_failed"), required: true}}
         )
+        # Attendees screened with some requested platform not covered; their coverage names which.
+        field(
+          :attendees_partial,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attendees_partial"), 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,
@@ -112,6 +118,12 @@ module NoResponse
           ::Integer,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("spent"), required: true}}
         )
+        # What screening cost, in US cents, in total and per implementation.
+        field(
+          :spend,
+          Models::Shared::ScreeningSpend,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("spend"), required: true}}
+        )
 
         field(
           :started_at,
@@ -138,7 +150,7 @@ module NoResponse
             environment: Models::Shared::AuditSettingsEnvironment,
             status: Models::Shared::ScreeningStatus,
             depth: Models::Shared::ScreeningDepth,
-            platforms: T::Array[Models::Shared::ScreeningPlatform],
+            platforms: T::Array[Models::Shared::HandlePlatform],
             requested_by: ::String,
             created_at: ::String,
             expires_at: ::String,
@@ -146,8 +158,10 @@ module NoResponse
             attendees_done: ::Integer,
             attendees_flagged: ::Integer,
             attendees_failed: ::Integer,
+            attendees_partial: ::Integer,
             estimated_spend: ::Integer,
             spent: ::Integer,
+            spend: Models::Shared::ScreeningSpend,
             started_at: T.nilable(::String),
             finished_at: T.nilable(::String),
             error_code: T.nilable(::String)
@@ -168,8 +182,10 @@ module NoResponse
           attendees_done:,
           attendees_flagged:,
           attendees_failed:,
+          attendees_partial:,
           estimated_spend:,
           spent:,
+          spend:,
           started_at: nil,
           finished_at: nil,
           error_code: nil
@@ -187,8 +203,10 @@ module NoResponse
           @attendees_done = attendees_done
           @attendees_flagged = attendees_flagged
           @attendees_failed = attendees_failed
+          @attendees_partial = attendees_partial
           @estimated_spend = estimated_spend
           @spent = spent
+          @spend = spend
           @started_at = started_at
           @finished_at = finished_at
           @error_code = error_code
@@ -210,8 +228,10 @@ 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 @attendees_partial == other.attendees_partial
           return false unless @estimated_spend == other.estimated_spend
           return false unless @spent == other.spent
+          return false unless @spend == other.spend
           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,12 @@ class NoResponse::Models::Shared::Screening
   def attendees_failed=(str_)
   end
 
+  def attendees_partial
+  end
+
+  def attendees_partial=(str_)
+  end
+
   def estimated_spend
   end
 
@@ -96,6 +102,12 @@ class NoResponse::Models::Shared::Screening
   def spent=(str_)
   end
 
+  def spend
+  end
+
+  def spend=(str_)
+  end
+
   def started_at
   end
 

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

@@ -0,0 +1,82 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The denominator of a screening: accounts found, how many could be read, items read and the period they span, so a clean result is distinct from a person nobody could see.
+      class ScreeningCoverage
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :accounts_found,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("accounts_found"), required: true}}
+        )
+
+        field(
+          :accounts_accessible,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("accounts_accessible"), required: true}}
+        )
+
+        field(
+          :items_read,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items_read"), required: true}}
+        )
+
+        field(
+          :platforms,
+          Crystalline::Array.new(Models::Shared::ScreeningPlatformCoverage),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("platforms"), required: true}}
+        )
+        # The oldest item read on any platform.
+        field(
+          :period_from,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("period_from")}}
+        )
+        # The newest item read on any platform.
+        field(
+          :period_to,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("period_to")}}
+        )
+
+        sig {
+          params(
+            accounts_found: ::Integer,
+            accounts_accessible: ::Integer,
+            items_read: ::Integer,
+            platforms: T::Array[Models::Shared::ScreeningPlatformCoverage],
+            period_from: T.nilable(::String),
+            period_to: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(accounts_found:, accounts_accessible:, items_read:, platforms:, period_from: nil, period_to: nil)
+          @accounts_found = accounts_found
+          @accounts_accessible = accounts_accessible
+          @items_read = items_read
+          @platforms = platforms
+          @period_from = period_from
+          @period_to = period_to
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @accounts_found == other.accounts_found
+          return false unless @accounts_accessible == other.accounts_accessible
+          return false unless @items_read == other.items_read
+          return false unless @platforms == other.platforms
+          return false unless @period_from == other.period_from
+          return false unless @period_to == other.period_to
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ScreeningCoverage
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ScreeningCoverage
+  def accounts_found
+  end
+
+  def accounts_found=(str_)
+  end
+
+  def accounts_accessible
+  end
+
+  def accounts_accessible=(str_)
+  end
+
+  def items_read
+  end
+
+  def items_read=(str_)
+  end
+
+  def platforms
+  end
+
+  def platforms=(str_)
+  end
+
+  def period_from
+  end
+
+  def period_from=(str_)
+  end
+
+  def period_to
+  end
+
+  def period_to=(str_)
+  end
+end