noresponse 2.0.17

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Band - low 0-29, medium 30-59, high 60-84, critical 85-100.
+      class Band
+        include ::Crystalline::Enum
+        enums do
+          LOW = new("low")
+          MEDIUM = new("medium")
+          HIGH = new("high")
+          CRITICAL = new("critical")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,108 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One breach table that matched, detailed view only. name is the catalogue's display name for the table's site, not the upstream provider. No member carries a record, value, password or hash.
+      class Breach
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :name, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("name"), required: true}}
+        # Who is in the table: site_breach, a site's own users; credential_list, a combolist or compilation; stealer_log, malware or botnet victims; scrape; hacking_forum, a criminal hacking, cracking or carding community; abuse_service, the customers of DDoS-for-hire, account generators, dump or card shops, darknet markets, stalkerware or breach-lookup services; darkweb_site, an onion site of unknown purpose.
+        field(
+          :kind,
+          Models::Shared::BreachKind,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("kind"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::BreachKind, false)
+            }
+          }
+        )
+        # The submitted identifier a breach table matched on: email or username. Phone and name are not breach selectors.
+        field(
+          :matched_on,
+          Models::Shared::BreachSelector,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("matched_on"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::BreachSelector, false)
+            }
+          }
+        )
+        # The breached site's domain, lower case. Absent when the table has none (a credential list, for example).
+        field(
+          :domain,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("domain")}}
+        )
+        # The table's category from its name, lower case (social, gaming, combolist, ...).
+        field(
+          :category,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("category")}}
+        )
+        # A breach table's date year.
+        field(
+          :year,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("year")}}
+        )
+        # Absent when only the year is known.
+        field(
+          :month,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("month")}}
+        )
+
+        field(
+          :exposed,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::BreachExposed)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("exposed")}}
+        )
+
+        sig {
+          params(
+            name: ::String,
+            kind: Models::Shared::BreachKind,
+            matched_on: Models::Shared::BreachSelector,
+            domain: T.nilable(::String),
+            category: T.nilable(::String),
+            year: T.nilable(::Integer),
+            month: T.nilable(::Integer),
+            exposed: T.nilable(T::Array[Models::Shared::BreachExposed])
+          )
+            .void
+        }
+        def initialize(name:, kind:, matched_on:, domain: nil, category: nil, year: nil, month: nil, exposed: nil)
+          @name = name
+          @kind = kind
+          @matched_on = matched_on
+          @domain = domain
+          @category = category
+          @year = year
+          @month = month
+          @exposed = exposed
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @name == other.name
+          return false unless @kind == other.kind
+          return false unless @matched_on == other.matched_on
+          return false unless @domain == other.domain
+          return false unless @category == other.category
+          return false unless @year == other.year
+          return false unless @month == other.month
+          return false unless @exposed == other.exposed
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Breach
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Breach
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def kind
+  end
+
+  def kind=(str_)
+  end
+
+  def matched_on
+  end
+
+  def matched_on=(str_)
+  end
+
+  def domain
+  end
+
+  def domain=(str_)
+  end
+
+  def category
+  end
+
+  def category=(str_)
+  end
+
+  def year
+  end
+
+  def year=(str_)
+  end
+
+  def month
+  end
+
+  def month=(str_)
+  end
+
+  def exposed
+  end
+
+  def exposed=(str_)
+  end
+end

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

@@ -0,0 +1,28 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # BreachExposed - The kind of data a breach table held beside the identifier. password means a plaintext password was present and password_hash means a hash, salt or token was present. The value itself is not stored or returned; the schema has no member for one.
+      class BreachExposed
+        include ::Crystalline::Enum
+        enums do
+          EMAIL = new("email")
+          USERNAME = new("username")
+          NAME = new("name")
+          PASSWORD = new("password")
+          PASSWORD_HASH = new("password_hash")
+          PHONE = new("phone")
+          ADDRESS = new("address")
+          DOB = new("dob")
+          IP = new("ip")
+          PAYMENT = new("payment")
+          SECURITY_QA = new("security_qa")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # BreachKind - Who is in the table: site_breach, a site's own users; credential_list, a combolist or compilation; stealer_log, malware or botnet victims; scrape; hacking_forum, a criminal hacking, cracking or carding community; abuse_service, the customers of DDoS-for-hire, account generators, dump or card shops, darknet markets, stalkerware or breach-lookup services; darkweb_site, an onion site of unknown purpose.
+      class BreachKind
+        include ::Crystalline::Enum
+        enums do
+          SITE_BREACH = new("site_breach")
+          CREDENTIAL_LIST = new("credential_list")
+          STEALER_LOG = new("stealer_log")
+          SCRAPE = new("scrape")
+          HACKING_FORUM = new("hacking_forum")
+          ABUSE_SERVICE = new("abuse_service")
+          DARKWEB_SITE = new("darkweb_site")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # BreachSelector - The submitted identifier a breach table matched on: email or username. Phone and name are not breach selectors.
+      class BreachSelector
+        include ::Crystalline::Enum
+        enums do
+          EMAIL = new("email")
+          USERNAME = new("username")
+          IP = new("ip")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,109 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Breach facts for one selector. found is the one required member: false is a definite 'in no breach table'. Every other member is optional, and absent makes no claim. No member carries a breach value, password or hash, and unknown members are refused. truncated means the value matched more tables or records than the lookup keeps, so absence-based claims (a missing name match, for example) are withheld; a truncated result is always found.
+      class BreachSummary
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :found,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("found"), required: true}}
+        )
+        # Distinct breach tables the value appears in.
+        field(
+          :breach_count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("breach_count")}}
+        )
+        # Year of the oldest dated table.
+        field(
+          :first_year,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("first_year")}}
+        )
+        # Year of the newest dated table.
+        field(
+          :last_year,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("last_year")}}
+        )
+        # The union of data kinds the matching tables held, without the values.
+        field(
+          :exposed,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::BreachExposed)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("exposed")}}
+        )
+        # The value is in a credential_list or stealer_log table.
+        field(
+          :in_credential_lists,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("in_credential_lists")}}
+        )
+        # A plaintext password sat next to the value in a table dated two years ago or less, or the value is in a stealer_log table.
+        field(
+          :recent_password_exposure,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("recent_password_exposure")}}
+        )
+
+        field(
+          :truncated,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("truncated")}}
+        )
+
+        sig {
+          params(
+            found: T::Boolean,
+            breach_count: T.nilable(::Integer),
+            first_year: T.nilable(::Integer),
+            last_year: T.nilable(::Integer),
+            exposed: T.nilable(T::Array[Models::Shared::BreachExposed]),
+            in_credential_lists: T.nilable(T::Boolean),
+            recent_password_exposure: T.nilable(T::Boolean),
+            truncated: T.nilable(T::Boolean)
+          )
+            .void
+        }
+        def initialize(
+          found:,
+          breach_count: nil,
+          first_year: nil,
+          last_year: nil,
+          exposed: nil,
+          in_credential_lists: nil,
+          recent_password_exposure: nil,
+          truncated: nil
+        )
+          @found = found
+          @breach_count = breach_count
+          @first_year = first_year
+          @last_year = last_year
+          @exposed = exposed
+          @in_credential_lists = in_credential_lists
+          @recent_password_exposure = recent_password_exposure
+          @truncated = truncated
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @found == other.found
+          return false unless @breach_count == other.breach_count
+          return false unless @first_year == other.first_year
+          return false unless @last_year == other.last_year
+          return false unless @exposed == other.exposed
+          return false unless @in_credential_lists == other.in_credential_lists
+          return false unless @recent_password_exposure == other.recent_password_exposure
+          return false unless @truncated == other.truncated
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::BreachSummary
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::BreachSummary
+  def found
+  end
+
+  def found=(str_)
+  end
+
+  def breach_count
+  end
+
+  def breach_count=(str_)
+  end
+
+  def first_year
+  end
+
+  def first_year=(str_)
+  end
+
+  def last_year
+  end
+
+  def last_year=(str_)
+  end
+
+  def exposed
+  end
+
+  def exposed=(str_)
+  end
+
+  def in_credential_lists
+  end
+
+  def in_credential_lists=(str_)
+  end
+
+  def recent_password_exposure
+  end
+
+  def recent_password_exposure=(str_)
+  end
+
+  def truncated
+  end
+
+  def truncated=(str_)
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Confidence - Ordinal confidence in the recommendation under the current policy: low, medium, high or unavailable.
+      class Confidence
+        include ::Crystalline::Enum
+        enums do
+          LOW = new("low")
+          MEDIUM = new("medium")
+          HIGH = new("high")
+          UNAVAILABLE = new("unavailable")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # ConflictErrorCode - Machine codes an HTTP 409 answer can carry.
+      class ConflictErrorCode
+        include ::Crystalline::Enum
+        enums do
+          IDEMPOTENCY_KEY_REUSED = new("idempotency_key_reused")
+          KEY_ROTATION_IN_PROGRESS = new("key_rotation_in_progress")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,85 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Cross-identifier agreement, computed from facts only. Every member is optional; absent makes no claim.
+      class Consistency
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # How a submitted identifier agrees with what the evidence holds for the other identifiers. unknown is a definite 'cannot tell' (for example a truncated or too-common breach result); absent means the comparison was not made.
+        field(
+          :name,
+          Crystalline::Nilable.new(Models::Shared::ConsistencyValue),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("name"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::ConsistencyValue, true)
+            }
+          }
+        )
+        # How a submitted identifier agrees with what the evidence holds for the other identifiers. unknown is a definite 'cannot tell' (for example a truncated or too-common breach result); absent means the comparison was not made.
+        field(
+          :phone,
+          Crystalline::Nilable.new(Models::Shared::ConsistencyValue),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("phone"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::ConsistencyValue, true)
+            }
+          }
+        )
+        # How a submitted identifier agrees with what the evidence holds for the other identifiers. unknown is a definite 'cannot tell' (for example a truncated or too-common breach result); absent means the comparison was not made.
+        field(
+          :ip,
+          Crystalline::Nilable.new(Models::Shared::ConsistencyValue),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("ip"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::ConsistencyValue, true)
+            }
+          }
+        )
+        # IP country, phone country, breach countries and policy_context.region together.
+        field(
+          :country,
+          Crystalline::Nilable.new(Models::Shared::Country),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("country"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Country, true)
+            }
+          }
+        )
+
+        sig {
+          params(
+            name: T.nilable(Models::Shared::ConsistencyValue),
+            phone: T.nilable(Models::Shared::ConsistencyValue),
+            ip: T.nilable(Models::Shared::ConsistencyValue),
+            country: T.nilable(Models::Shared::Country)
+          )
+            .void
+        }
+        def initialize(name: nil, phone: nil, ip: nil, country: nil)
+          @name = name
+          @phone = phone
+          @ip = ip
+          @country = country
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @name == other.name
+          return false unless @phone == other.phone
+          return false unless @ip == other.ip
+          return false unless @country == other.country
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Consistency
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Consistency
+  def name
+  end
+
+  def name=(str_)
+  end
+
+  def phone
+  end
+
+  def phone=(str_)
+  end
+
+  def ip
+  end
+
+  def ip=(str_)
+  end
+
+  def country
+  end
+
+  def country=(str_)
+  end
+end

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

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # ConsistencyValue - How a submitted identifier agrees with what the evidence holds for the other identifiers. unknown is a definite 'cannot tell' (for example a truncated or too-common breach result); absent means the comparison was not made.
+      class ConsistencyValue
+        include ::Crystalline::Enum
+        enums do
+          MATCH = new("match")
+          PARTIAL = new("partial")
+          MISMATCH = new("mismatch")
+          UNKNOWN = new("unknown")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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