noresponse 10.0.11 → 10.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11deaafb30241b9fc0e9d1d7d44fbedba4fc85260486e5a10a4fdc62be3c34b3
-  data.tar.gz: 84f28e10935cb2c180b8faa6bee41b8d7c9779bf941217a27866ee3f9ea1ca30
+  metadata.gz: a9d583f5c8f0b06adc80bb220a841bce567584d6f9c197995799d71720f12aaa
+  data.tar.gz: 7cb2890a3937c798476a19f7f89c8c9ca2a149887d9bd4c24cd5fb6f0da161ff
 SHA512:
-  metadata.gz: 2eff2d401db21e107b427fed6d02671fe46ab5c92791bbc567bfaea1d918b8eb82150b5f977d2a458f633f0fe39e68cb8fec23ccb71e67f0c85bcc71525d3d45
-  data.tar.gz: 06fe0c24ce4404c94393470d7f8d3a7ea18e7a7e5bb1191feb0e04c91ab4dd1b8204efb42126daab1f0cad9e0c30415350c31051f3e6049209a34fa337a807e1
+  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/attendeedecided.rb

@@ -0,0 +1,89 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # A reviewer recorded a decision on an attendee. The decision's note stays in the API. Sent once per recorded review; an attendee's latest review is its decision, so order by decided_at.
+      class AttendeeDecided
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The attendee's event.
+        field(
+          :event_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("event_id"), required: true}}
+        )
+        # The attendee decided on.
+        field(
+          :attendee_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attendee_id"), required: true}}
+        )
+        # The recorded review.
+        field(
+          :review_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("review_id"), required: true}}
+        )
+
+        field(
+          :decision,
+          Models::Shared::AttendeeDecision,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("decision"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::AttendeeDecision, false)
+            }
+          }
+        )
+        # Who decided: the member's external user id, or the API key's label, as the attendee's decided_by.
+        field(
+          :decided_by,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("decided_by"), required: true}}
+        )
+        # When the decision was recorded; equal to the event's created_at.
+        field(
+          :decided_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("decided_at"), required: true}}
+        )
+
+        sig {
+          params(
+            event_id: ::String,
+            attendee_id: ::String,
+            review_id: ::String,
+            decision: Models::Shared::AttendeeDecision,
+            decided_by: ::String,
+            decided_at: ::String
+          )
+            .void
+        }
+        def initialize(event_id:, attendee_id:, review_id:, decision:, decided_by:, decided_at:)
+          @event_id = event_id
+          @attendee_id = attendee_id
+          @review_id = review_id
+          @decision = decision
+          @decided_by = decided_by
+          @decided_at = decided_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @event_id == other.event_id
+          return false unless @attendee_id == other.attendee_id
+          return false unless @review_id == other.review_id
+          return false unless @decision == other.decision
+          return false unless @decided_by == other.decided_by
+          return false unless @decided_at == other.decided_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AttendeeDecided
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AttendeeDecided
+  def event_id
+  end
+
+  def event_id=(str_)
+  end
+
+  def attendee_id
+  end
+
+  def attendee_id=(str_)
+  end
+
+  def review_id
+  end
+
+  def review_id=(str_)
+  end
+
+  def decision
+  end
+
+  def decision=(str_)
+  end
+
+  def decided_by
+  end
+
+  def decided_by=(str_)
+  end
+
+  def decided_at
+  end
+
+  def decided_at=(str_)
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The attendee.decided event.
+      class AttendeeDecidedEvent
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The event id, equal to the NR-Webhook-Id header and across redeliveries and every endpoint the event fans out to.
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+        # When the event was created. Equal across redeliveries; the signing timestamp header is per delivery.
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # A reviewer recorded a decision on an attendee. The decision's note stays in the API. Sent once per recorded review; an attendee's latest review is its decision, so order by decided_at.
+        field(
+          :data,
+          Models::Shared::AttendeeDecided,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("data"), required: true}}
+        )
+        # Always attendee.decided.
+        field :type, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("type"), required: true}}
+        # Present, and true, only on an event sent by POST /v1/webhooks/{endpoint_id}/test: its data is a fixed example assessment, not one of the workspace's, so a receiver acknowledges it and applies nothing. Real events have no test member.
+        field(
+          :test,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("test")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            created_at: ::String,
+            data: Models::Shared::AttendeeDecided,
+            type: ::String,
+            test: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(id:, created_at:, data:, type: "attendee.decided", test: nil)
+          @id = id
+          @created_at = created_at
+          @data = data
+          unless type == "attendee.decided"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "attendee.decided"
+          @test = test
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @created_at == other.created_at
+          return false unless @data == other.data
+          return false unless @type == other.type
+          return false unless @test == other.test
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AttendeeDecidedEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AttendeeDecidedEvent
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def data
+  end
+
+  def data=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def test
+  end
+
+  def test=(str_)
+  end
+end

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

@@ -0,0 +1,95 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # A screening recorded a finding on an attendee. It says which attendee and how severe, not what they posted, who they are or why: GET the attendee report for the findings. Sent once per screening that flags the attendee, so a re-screen of someone on watch announces them again.
+      class AttendeeFlagged
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The attendee's event.
+        field(
+          :event_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("event_id"), required: true}}
+        )
+        # The flagged attendee.
+        field(
+          :attendee_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("attendee_id"), required: true}}
+        )
+        # The screening that flagged them.
+        field(
+          :screening_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("screening_id"), required: true}}
+        )
+
+        field(
+          :highest_band,
+          Models::Shared::HighestBand,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("highest_band"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::HighestBand, false)
+            }
+          }
+        )
+        # How sure the screening is that the accounts it read are the attendee's. A finding on a possible match is at most moderate, on a probable match at most high.
+        field(
+          :match_state,
+          Models::Shared::AttendeeFlaggedMatchState,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("match_state"),
+              required: true,
+              'decoder': ::NoResponse::Utils.enum_from_string(Models::Shared::AttendeeFlaggedMatchState, false)
+            }
+          }
+        )
+        # When the screening recorded the finding; equal to the event's created_at.
+        field(
+          :flagged_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("flagged_at"), required: true}}
+        )
+
+        sig {
+          params(
+            event_id: ::String,
+            attendee_id: ::String,
+            screening_id: ::String,
+            highest_band: Models::Shared::HighestBand,
+            match_state: Models::Shared::AttendeeFlaggedMatchState,
+            flagged_at: ::String
+          )
+            .void
+        }
+        def initialize(event_id:, attendee_id:, screening_id:, highest_band:, match_state:, flagged_at:)
+          @event_id = event_id
+          @attendee_id = attendee_id
+          @screening_id = screening_id
+          @highest_band = highest_band
+          @match_state = match_state
+          @flagged_at = flagged_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @event_id == other.event_id
+          return false unless @attendee_id == other.attendee_id
+          return false unless @screening_id == other.screening_id
+          return false unless @highest_band == other.highest_band
+          return false unless @match_state == other.match_state
+          return false unless @flagged_at == other.flagged_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AttendeeFlagged
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AttendeeFlagged
+  def event_id
+  end
+
+  def event_id=(str_)
+  end
+
+  def attendee_id
+  end
+
+  def attendee_id=(str_)
+  end
+
+  def screening_id
+  end
+
+  def screening_id=(str_)
+  end
+
+  def highest_band
+  end
+
+  def highest_band=(str_)
+  end
+
+  def match_state
+  end
+
+  def match_state=(str_)
+  end
+
+  def flagged_at
+  end
+
+  def flagged_at=(str_)
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The attendee.flagged event.
+      class AttendeeFlaggedEvent
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The event id, equal to the NR-Webhook-Id header and across redeliveries and every endpoint the event fans out to.
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+        # When the event was created. Equal across redeliveries; the signing timestamp header is per delivery.
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+        # A screening recorded a finding on an attendee. It says which attendee and how severe, not what they posted, who they are or why: GET the attendee report for the findings. Sent once per screening that flags the attendee, so a re-screen of someone on watch announces them again.
+        field(
+          :data,
+          Models::Shared::AttendeeFlagged,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("data"), required: true}}
+        )
+        # Always attendee.flagged.
+        field :type, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("type"), required: true}}
+        # Present, and true, only on an event sent by POST /v1/webhooks/{endpoint_id}/test: its data is a fixed example assessment, not one of the workspace's, so a receiver acknowledges it and applies nothing. Real events have no test member.
+        field(
+          :test,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("test")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            created_at: ::String,
+            data: Models::Shared::AttendeeFlagged,
+            type: ::String,
+            test: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(id:, created_at:, data:, type: "attendee.flagged", test: nil)
+          @id = id
+          @created_at = created_at
+          @data = data
+          unless type == "attendee.flagged"
+            raise ArgumentError, "Invalid value for type"
+          end
+
+          @type = "attendee.flagged"
+          @test = test
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @id == other.id
+          return false unless @created_at == other.created_at
+          return false unless @data == other.data
+          return false unless @type == other.type
+          return false unless @test == other.test
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AttendeeFlaggedEvent
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AttendeeFlaggedEvent
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def data
+  end
+
+  def data=(str_)
+  end
+
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def test
+  end
+
+  def test=(str_)
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # AttendeeFlaggedMatchState - How sure the screening is that the accounts it read are the attendee's. A finding on a possible match is at most moderate, on a probable match at most high.
+      class AttendeeFlaggedMatchState < T::Enum
+        enums do
+          CONFIRMED = new("confirmed")
+          PROBABLE = new("probable")
+          POSSIBLE = new("possible")
+          NONE_FOUND = new("none_found")
+          INACCESSIBLE = new("inaccessible")
+        end
+      end
+    end
+  end
+end

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

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