noresponse 8.4.1 → 9.1.0

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

@@ -0,0 +1,119 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Reviews created in [from,to) whose review and current account assessment remain retained. Status and assignment are current at as_of, not a transition history. label_coverage numerator is resolved reviews labeled benign or abuse; denominator is resolved reviews. Inconclusive is not a known outcome. Review conclusions do not change account feedback or enforcement.
+      class Reviews
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :denominator,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("denominator"), required: true}}
+        )
+
+        field :open, ::Integer, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("open"), required: true}}
+
+        field(
+          :in_progress,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("in_progress"), required: true}}
+        )
+
+        field(
+          :resolved,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("resolved"), required: true}}
+        )
+
+        field(
+          :assigned,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assigned"), required: true}}
+        )
+
+        field(
+          :unassigned,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("unassigned"), required: true}}
+        )
+        # Counts only; a zero denominator means no eligible retained records and does not imply a zero rate.
+        field(
+          :label_coverage,
+          Models::Shared::Coverage,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("label_coverage"), required: true}}
+        )
+        # Current resolution of each resolved retained review; prior resolutions and reopened reviews do not count. Missing keys mean zero. These investigation conclusions are independent of account feedback.
+        field(
+          :conclusions,
+          Models::Shared::ReviewsConclusions,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("conclusions"), required: true}}
+        )
+
+        field(
+          :population,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("population"), required: true}}
+        )
+
+        sig {
+          params(
+            denominator: ::Integer,
+            open: ::Integer,
+            in_progress: ::Integer,
+            resolved: ::Integer,
+            assigned: ::Integer,
+            unassigned: ::Integer,
+            label_coverage: Models::Shared::Coverage,
+            conclusions: Models::Shared::ReviewsConclusions,
+            population: ::String
+          )
+            .void
+        }
+        def initialize(
+          denominator:,
+          open:,
+          in_progress:,
+          resolved:,
+          assigned:,
+          unassigned:,
+          label_coverage:,
+          conclusions:,
+          population: "retained_reviews_by_created_at"
+        )
+          @denominator = denominator
+          @open = open
+          @in_progress = in_progress
+          @resolved = resolved
+          @assigned = assigned
+          @unassigned = unassigned
+          @label_coverage = label_coverage
+          @conclusions = conclusions
+          unless population == "retained_reviews_by_created_at"
+            raise ArgumentError, "Invalid value for population"
+          end
+
+          @population = "retained_reviews_by_created_at"
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @denominator == other.denominator
+          return false unless @open == other.open
+          return false unless @in_progress == other.in_progress
+          return false unless @resolved == other.resolved
+          return false unless @assigned == other.assigned
+          return false unless @unassigned == other.unassigned
+          return false unless @label_coverage == other.label_coverage
+          return false unless @conclusions == other.conclusions
+          return false unless @population == other.population
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::Reviews
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::Reviews
+  def denominator
+  end
+
+  def denominator=(str_)
+  end
+
+  def open
+  end
+
+  def open=(str_)
+  end
+
+  def in_progress
+  end
+
+  def in_progress=(str_)
+  end
+
+  def resolved
+  end
+
+  def resolved=(str_)
+  end
+
+  def assigned
+  end
+
+  def assigned=(str_)
+  end
+
+  def unassigned
+  end
+
+  def unassigned=(str_)
+  end
+
+  def label_coverage
+  end
+
+  def label_coverage=(str_)
+  end
+
+  def conclusions
+  end
+
+  def conclusions=(str_)
+  end
+
+  def population
+  end
+
+  def population=(str_)
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Current resolution of each resolved retained review; prior resolutions and reopened reviews do not count. Missing keys mean zero. These investigation conclusions are independent of account feedback.
+      class ReviewsConclusions
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :benign,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("benign")}}
+        )
+
+        field(
+          :abuse,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("abuse")}}
+        )
+
+        field(
+          :inconclusive,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("inconclusive")}}
+        )
+
+        sig {
+          params(benign: T.nilable(::Integer), abuse: T.nilable(::Integer), inconclusive: T.nilable(::Integer)).void
+        }
+        def initialize(benign: nil, abuse: nil, inconclusive: nil)
+          @benign = benign
+          @abuse = abuse
+          @inconclusive = inconclusive
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @benign == other.benign
+          return false unless @abuse == other.abuse
+          return false unless @inconclusive == other.inconclusive
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ReviewsConclusions
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ReviewsConclusions
+  def benign
+  end
+
+  def benign=(str_)
+  end
+
+  def abuse
+  end
+
+  def abuse=(str_)
+  end
+
+  def inconclusive
+  end
+
+  def inconclusive=(str_)
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class ReviewStatus
+        include ::Crystalline::Enum
+        enums do
+          OPEN = new("open")
+          IN_PROGRESS = new("in_progress")
+          RESOLVED = new("resolved")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,131 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # A tenant-local investigation link. risk_version is the account risk version captured when the link was added. It does not assert a relationship or change feedback or enforcement.
+      class ReviewSubject
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+
+        field(
+          :kind,
+          Models::Shared::ReviewSubjectKind,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("kind"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::ReviewSubjectKind, false)
+            }
+          }
+        )
+
+        field(
+          :account_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("account_id"), required: true}}
+        )
+
+        field(
+          :risk_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("risk_version"), required: true}}
+        )
+
+        field(
+          :reason,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("reason"), required: true}}
+        )
+
+        field(
+          :created_by,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_by"), required: true}}
+        )
+
+        field(
+          :created_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("created_at"), required: true}}
+        )
+
+        field(
+          :assessment_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assessment_id")}}
+        )
+
+        field(
+          :assessment_version,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assessment_version")}}
+        )
+
+        field(
+          :credential_id,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("credential_id")}}
+        )
+
+        sig {
+          params(
+            id: ::String,
+            kind: Models::Shared::ReviewSubjectKind,
+            account_id: ::String,
+            risk_version: ::Integer,
+            reason: ::String,
+            created_by: ::String,
+            created_at: ::String,
+            assessment_id: T.nilable(::String),
+            assessment_version: T.nilable(::Integer),
+            credential_id: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          id:,
+          kind:,
+          account_id:,
+          risk_version:,
+          reason:,
+          created_by:,
+          created_at:,
+          assessment_id: nil,
+          assessment_version: nil,
+          credential_id: nil
+        )
+          @id = id
+          @kind = kind
+          @account_id = account_id
+          @risk_version = risk_version
+          @reason = reason
+          @created_by = created_by
+          @created_at = created_at
+          @assessment_id = assessment_id
+          @assessment_version = assessment_version
+          @credential_id = credential_id
+        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 @kind == other.kind
+          return false unless @account_id == other.account_id
+          return false unless @risk_version == other.risk_version
+          return false unless @reason == other.reason
+          return false unless @created_by == other.created_by
+          return false unless @created_at == other.created_at
+          return false unless @assessment_id == other.assessment_id
+          return false unless @assessment_version == other.assessment_version
+          return false unless @credential_id == other.credential_id
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ReviewSubject
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ReviewSubject
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def kind
+  end
+
+  def kind=(str_)
+  end
+
+  def account_id
+  end
+
+  def account_id=(str_)
+  end
+
+  def risk_version
+  end
+
+  def risk_version=(str_)
+  end
+
+  def reason
+  end
+
+  def reason=(str_)
+  end
+
+  def created_by
+  end
+
+  def created_by=(str_)
+  end
+
+  def created_at
+  end
+
+  def created_at=(str_)
+  end
+
+  def assessment_id
+  end
+
+  def assessment_id=(str_)
+  end
+
+  def assessment_version
+  end
+
+  def assessment_version=(str_)
+  end
+
+  def credential_id
+  end
+
+  def credential_id=(str_)
+  end
+end

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

@@ -0,0 +1,40 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The link and resulting review version.
+      class ReviewSubjectChange
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :review_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("review_version"), required: true}}
+        )
+        # A tenant-local investigation link. risk_version is the account risk version captured when the link was added. It does not assert a relationship or change feedback or enforcement.
+        field(
+          :subject,
+          Models::Shared::ReviewSubject,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("subject"), required: true}}
+        )
+
+        sig { params(review_version: ::Integer, subject: Models::Shared::ReviewSubject).void }
+        def initialize(review_version:, subject:)
+          @review_version = review_version
+          @subject = subject
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @review_version == other.review_version
+          return false unless @subject == other.subject
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ReviewSubjectChange
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ReviewSubjectChange
+  def review_version
+  end
+
+  def review_version=(str_)
+  end
+
+  def subject
+  end
+
+  def subject=(str_)
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class ReviewSubjectKind
+        include ::Crystalline::Enum
+        enums do
+          ACCOUNT = new("account")
+          ASSESSMENT = new("assessment")
+          ISSUED_CREDENTIAL = new("issued_credential")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Retained tenant-local subject links and the current review version.
+      class ReviewSubjectList
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :review_version,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("review_version"), required: true}}
+        )
+
+        field(
+          :items,
+          Crystalline::Array.new(Models::Shared::ReviewSubject),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
+        )
+
+        sig { params(review_version: ::Integer, items: T::Array[Models::Shared::ReviewSubject]).void }
+        def initialize(review_version:, items:)
+          @review_version = review_version
+          @items = items
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @review_version == other.review_version
+          return false unless @items == other.items
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ReviewSubjectList
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ReviewSubjectList
+  def review_version
+  end
+
+  def review_version=(str_)
+  end
+
+  def items
+  end
+
+  def items=(str_)
+  end
+end