noresponse 2.0.17

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

@@ -0,0 +1,149 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class Signal
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Signal kind, for example account_presence or breach_exposure. New kinds may appear; ignore any you do not know.
+        field :type, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("type"), required: true}}
+        # Which submitted identifier a signal concerns. ip is a selector of breach_exposure only.
+        field(
+          :identifier,
+          Models::Shared::IdentifierKind,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("identifier"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::IdentifierKind, false)
+            }
+          }
+        )
+        # Per-signal outcome. A source that timed out, was blocked or errored reports blocked, unavailable or inconclusive with a reason and is listed in incomplete_sources; not_found is a definite absence.
+        field(
+          :outcome,
+          Models::Shared::SignalOutcome,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("outcome"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::SignalOutcome, false)
+            }
+          }
+        )
+        # Opaque, tenant-scoped projection of the source that produced a signal. It stays stable for your tenant while the projection key is unchanged and reveals no upstream provider, feed, breach table or source record.
+        field(
+          :source_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("source_id"), required: true}}
+        )
+        # Freshness class of the evidence behind a signal. unknown whenever no evidence was obtained.
+        field(
+          :freshness,
+          Models::Shared::Freshness,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("freshness"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Freshness, false)
+            }
+          }
+        )
+        # Why a signal or source did not produce a definite found/not_found. timed_out means the source missed the request deadline; a continuation may still settle it. deferred means the (source, identifier) pair is async-only and was not attempted on the synchronous path; a continuation settles it.
+        field(
+          :reason,
+          Crystalline::Nilable.new(Models::Shared::FailureReason),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("reason"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::FailureReason, true)
+            }
+          }
+        )
+        # Opaque pointer to evidence NoResponse holds for this signal. It carries no breach value, credential or page body.
+        field(
+          :evidence_ref,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("evidence_ref")}}
+        )
+        # When the evidence was first observed.
+        field(
+          :observed_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("observed_at")}}
+        )
+        # When the source was last queried for this identifier.
+        field(
+          :last_checked_at,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("last_checked_at")}}
+        )
+        # Facts about the number only: line type, carrier and country. The upstream provider, its scores and its verdicts stay internal.
+        field(
+          :enrichment,
+          Crystalline::Nilable.new(Models::Shared::PhoneEnrichment),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("enrichment")}}
+        )
+
+        sig {
+          params(
+            type: ::String,
+            identifier: Models::Shared::IdentifierKind,
+            outcome: Models::Shared::SignalOutcome,
+            source_id: ::String,
+            freshness: Models::Shared::Freshness,
+            reason: T.nilable(Models::Shared::FailureReason),
+            evidence_ref: T.nilable(::String),
+            observed_at: T.nilable(::String),
+            last_checked_at: T.nilable(::String),
+            enrichment: T.nilable(Models::Shared::PhoneEnrichment)
+          )
+            .void
+        }
+        def initialize(
+          type:,
+          identifier:,
+          outcome:,
+          source_id:,
+          freshness:,
+          reason: nil,
+          evidence_ref: nil,
+          observed_at: nil,
+          last_checked_at: nil,
+          enrichment: nil
+        )
+          @type = type
+          @identifier = identifier
+          @outcome = outcome
+          @source_id = source_id
+          @freshness = freshness
+          @reason = reason
+          @evidence_ref = evidence_ref
+          @observed_at = observed_at
+          @last_checked_at = last_checked_at
+          @enrichment = enrichment
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @type == other.type
+          return false unless @identifier == other.identifier
+          return false unless @outcome == other.outcome
+          return false unless @source_id == other.source_id
+          return false unless @freshness == other.freshness
+          return false unless @reason == other.reason
+          return false unless @evidence_ref == other.evidence_ref
+          return false unless @observed_at == other.observed_at
+          return false unless @last_checked_at == other.last_checked_at
+          return false unless @enrichment == other.enrichment
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Signal
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Signal
+  def type
+  end
+
+  def type=(str_)
+  end
+
+  def identifier
+  end
+
+  def identifier=(str_)
+  end
+
+  def outcome
+  end
+
+  def outcome=(str_)
+  end
+
+  def source_id
+  end
+
+  def source_id=(str_)
+  end
+
+  def freshness
+  end
+
+  def freshness=(str_)
+  end
+
+  def reason
+  end
+
+  def reason=(str_)
+  end
+
+  def evidence_ref
+  end
+
+  def evidence_ref=(str_)
+  end
+
+  def observed_at
+  end
+
+  def observed_at=(str_)
+  end
+
+  def last_checked_at
+  end
+
+  def last_checked_at=(str_)
+  end
+
+  def enrichment
+  end
+
+  def enrichment=(str_)
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # SignalOutcome - Per-signal outcome. A source that timed out, was blocked or errored reports blocked, unavailable or inconclusive with a reason and is listed in incomplete_sources; not_found is a definite absence.
+      class SignalOutcome
+        include ::Crystalline::Enum
+        enums do
+          FOUND = new("found")
+          NOT_FOUND = new("not_found")
+          INCONCLUSIVE = new("inconclusive")
+          BLOCKED = new("blocked")
+          UNAVAILABLE = new("unavailable")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class SocialProfile
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class SocialProfileUnion
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Status - complete: final; nothing is still running. A lane that failed or missed its 10 s deadline stays listed in incomplete_sources, and confidence is lower. partial: a recommendation exists and at least one lane is still running or did not settle (see incomplete_sources). pending: nothing usable before the deadline; no recommendation yet, poll or wait for the webhook.
+      class Status
+        include ::Crystalline::Enum
+        enums do
+          COMPLETE = new("complete")
+          PARTIAL = new("partial")
+          PENDING = new("pending")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class Timezone
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class TimezoneUnion
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Transport - Where this context was derived. Backend is the trusted integration path; browser values are treated as weak hints. provider_hook is a hosted provider hook (an Auth0 or WorkOS Action) calling at hook_point; it needs hook_point and verified false, and its authentication facts are not scored.
+      class Transport < T::Enum
+        enums do
+          BACKEND = new("backend")
+          BROWSER = new("browser")
+          PROVIDER_HOOK = new("provider_hook")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class Website
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class WebsiteUnion
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        def initialize
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/no_response/models/shared.rb

@@ -0,0 +1,92 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      autoload :Assessment, "no_response/models/shared/assessment.rb"
+      autoload :AssessmentList, "no_response/models/shared/assessmentlist.rb"
+      autoload :AssessmentOutcome, "no_response/models/shared/assessmentoutcome.rb"
+      autoload :AssessmentOutcomeRequest, "no_response/models/shared/assessmentoutcomerequest.rb"
+      autoload :AssessmentQuery, "no_response/models/shared/assessmentquery.rb"
+      autoload :AssessmentRequest, "no_response/models/shared/assessmentrequest.rb"
+      autoload :AssessmentRequestClientContext, "no_response/models/shared/assessmentrequestclientcontext.rb"
+      autoload :AssessmentRequestIdentifiers, "no_response/models/shared/assessmentrequestidentifiers.rb"
+      autoload :AssessmentRequestIssuedCredential, "no_response/models/shared/assessmentrequestissuedcredential.rb"
+      autoload :AssessmentRequestPolicyContext, "no_response/models/shared/assessmentrequestpolicycontext.rb"
+      autoload :AssessmentTiming, "no_response/models/shared/assessmenttiming.rb"
+      autoload :AssuranceLevel, "no_response/models/shared/assurancelevel.rb"
+      autoload :AuthContext, "no_response/models/shared/authcontext.rb"
+      autoload :AuthContextMfa, "no_response/models/shared/authcontextmfa.rb"
+      autoload :AuthenticationErrorCode, "no_response/models/shared/authenticationerrorcode.rb"
+      autoload :BadRequestErrorCode, "no_response/models/shared/badrequesterrorcode.rb"
+      autoload :Band, "no_response/models/shared/band.rb"
+      autoload :Breach, "no_response/models/shared/breach.rb"
+      autoload :BreachExposed, "no_response/models/shared/breachexposed.rb"
+      autoload :BreachKind, "no_response/models/shared/breachkind.rb"
+      autoload :BreachSelector, "no_response/models/shared/breachselector.rb"
+      autoload :BreachSummary, "no_response/models/shared/breachsummary.rb"
+      autoload :Confidence, "no_response/models/shared/confidence.rb"
+      autoload :ConflictErrorCode, "no_response/models/shared/conflicterrorcode.rb"
+      autoload :Consistency, "no_response/models/shared/consistency.rb"
+      autoload :ConsistencyValue, "no_response/models/shared/consistencyvalue.rb"
+      autoload :Country, "no_response/models/shared/country.rb"
+      autoload :FailureReason, "no_response/models/shared/failurereason.rb"
+      autoload :Flow, "no_response/models/shared/flow.rb"
+      autoload :Freshness, "no_response/models/shared/freshness.rb"
+      autoload :HookPoint, "no_response/models/shared/hookpoint.rb"
+      autoload :IdentifierKind, "no_response/models/shared/identifierkind.rb"
+      autoload :IncompleteReason, "no_response/models/shared/incompletereason.rb"
+      autoload :IncompleteSource, "no_response/models/shared/incompletesource.rb"
+      autoload :IpSummary, "no_response/models/shared/ipsummary.rb"
+      autoload :IpSummaryType, "no_response/models/shared/ipsummarytype.rb"
+      autoload :KeyRotation, "no_response/models/shared/keyrotation.rb"
+      autoload :KeyRotationRequest, "no_response/models/shared/keyrotationrequest.rb"
+      autoload :Lane, "no_response/models/shared/lane.rb"
+      autoload :LineType, "no_response/models/shared/linetype.rb"
+      autoload :NotFoundErrorCode, "no_response/models/shared/notfounderrorcode.rb"
+      autoload :Outcome, "no_response/models/shared/outcome.rb"
+      autoload :PermissionDeniedErrorCode, "no_response/models/shared/permissiondeniederrorcode.rb"
+      autoload :PhoneEnrichment, "no_response/models/shared/phoneenrichment.rb"
+      autoload :PhoneEnrichmentFields, "no_response/models/shared/phoneenrichmentfields.rb"
+      autoload :Platform, "no_response/models/shared/platform.rb"
+      autoload :ProblemInvalidParam, "no_response/models/shared/probleminvalidparam.rb"
+      autoload :RateLimitErrorCode, "no_response/models/shared/ratelimiterrorcode.rb"
+      autoload :ReasonCode, "no_response/models/shared/reasoncode.rb"
+      autoload :ReasonIdentifier, "no_response/models/shared/reasonidentifier.rb"
+      autoload :Recommendation, "no_response/models/shared/recommendation.rb"
+      autoload :ResponseMode, "no_response/models/shared/responsemode.rb"
+      autoload :Risk, "no_response/models/shared/risk.rb"
+      autoload :RiskConfidence, "no_response/models/shared/riskconfidence.rb"
+      autoload :RiskCoverage, "no_response/models/shared/riskcoverage.rb"
+      autoload :RiskDetails, "no_response/models/shared/riskdetails.rb"
+      autoload :RiskDetailsBreachName, "no_response/models/shared/riskdetailsbreachname.rb"
+      autoload :RiskDetailsPhoneName, "no_response/models/shared/riskdetailsphonename.rb"
+      autoload :RiskReason, "no_response/models/shared/riskreason.rb"
+      autoload :RiskSummary, "no_response/models/shared/risksummary.rb"
+      autoload :RiskSummaryEmail, "no_response/models/shared/risksummaryemail.rb"
+      autoload :RiskSummaryPhone, "no_response/models/shared/risksummaryphone.rb"
+      autoload :RiskSummaryUsername, "no_response/models/shared/risksummaryusername.rb"
+      autoload :Security, "no_response/models/shared/security.rb"
+      autoload :Signal, "no_response/models/shared/signal.rb"
+      autoload :SignalOutcome, "no_response/models/shared/signaloutcome.rb"
+      autoload :Status, "no_response/models/shared/status.rb"
+      autoload :Transport, "no_response/models/shared/transport.rb"
+      autoload :AlternateName, "no_response/models/shared/alternate_name.rb"
+      autoload :AlternateNameUnion, "no_response/models/shared/alternate_name_union.rb"
+      autoload :Email, "no_response/models/shared/email.rb"
+      autoload :EmailUnion, "no_response/models/shared/email_union.rb"
+      autoload :Location, "no_response/models/shared/location.rb"
+      autoload :LocationUnion, "no_response/models/shared/location_union.rb"
+      autoload :NameCandidate, "no_response/models/shared/name_candidate.rb"
+      autoload :NameCandidateUnion, "no_response/models/shared/name_candidate_union.rb"
+      autoload :Scope, "no_response/models/shared/scope.rb"
+      autoload :SocialProfile, "no_response/models/shared/social_profile.rb"
+      autoload :SocialProfileUnion, "no_response/models/shared/social_profile_union.rb"
+      autoload :Timezone, "no_response/models/shared/timezone.rb"
+      autoload :TimezoneUnion, "no_response/models/shared/timezone_union.rb"
+      autoload :Website, "no_response/models/shared/website.rb"
+      autoload :WebsiteUnion, "no_response/models/shared/website_union.rb"
+    end
+  end
+end