noresponse 9.4.3 → 9.5.0

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

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class IdentifierExpressionNodeLevelOne
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # One customer-submitted identifier. Defaults to exact comparison of the original submitted value. canonical uses the supported identifier normalisation without an ownership claim: email preserves local-part case, NFC-normalises it and lowercases the domain without removing dots or tags; phone uses international E.164 without extensions or an inferred region; username uses NFC and Unicode case folding within the customer namespace. mailbox is email-only and explicitly selects existing list rules: case-insensitive, remove +tag, and ignore local-part dots at gmail.com and googlemail.com; googlemail.com maps to gmail.com. Username requires namespace customer. Email and phone forbid namespace. Source-discovered identifiers and platform handles are not searched. Unsupported kinds, namespaces, modes and invalid values return 400. Search equality does not establish verified ownership or merge accounts.
+        field(
+          :term,
+          Crystalline::Nilable.new(Models::Shared::IdentifierSearch),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("term")}}
+        )
+
+        field(
+          :and_,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::IdentifierExpressionLeaf)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("and")}}
+        )
+
+        field(
+          :or_,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::IdentifierExpressionLeaf)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("or")}}
+        )
+
+        sig {
+          params(
+            term: T.nilable(Models::Shared::IdentifierSearch),
+            and_: T.nilable(T::Array[Models::Shared::IdentifierExpressionLeaf]),
+            or_: T.nilable(T::Array[Models::Shared::IdentifierExpressionLeaf])
+          )
+            .void
+        }
+        def initialize(term: nil, and_: nil, or_: nil)
+          @term = term
+          @and_ = and_
+          @or_ = or_
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @term == other.term
+          return false unless @and_ == other.and_
+          return false unless @or_ == other.or_
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::IdentifierExpressionNodeLevelOne
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::IdentifierExpressionNodeLevelOne
+  def term
+  end
+
+  def term=(str_)
+  end
+
+  def and_
+  end
+
+  def and_=(str_)
+  end
+
+  def or_
+  end
+
+  def or_=(str_)
+  end
+end

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

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class IdentifierExpressionNodeLevelTwo
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # One customer-submitted identifier. Defaults to exact comparison of the original submitted value. canonical uses the supported identifier normalisation without an ownership claim: email preserves local-part case, NFC-normalises it and lowercases the domain without removing dots or tags; phone uses international E.164 without extensions or an inferred region; username uses NFC and Unicode case folding within the customer namespace. mailbox is email-only and explicitly selects existing list rules: case-insensitive, remove +tag, and ignore local-part dots at gmail.com and googlemail.com; googlemail.com maps to gmail.com. Username requires namespace customer. Email and phone forbid namespace. Source-discovered identifiers and platform handles are not searched. Unsupported kinds, namespaces, modes and invalid values return 400. Search equality does not establish verified ownership or merge accounts.
+        field(
+          :term,
+          Crystalline::Nilable.new(Models::Shared::IdentifierSearch),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("term")}}
+        )
+
+        field(
+          :and_,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::IdentifierExpressionNodeLevelOne)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("and")}}
+        )
+
+        field(
+          :or_,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::IdentifierExpressionNodeLevelOne)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("or")}}
+        )
+
+        sig {
+          params(
+            term: T.nilable(Models::Shared::IdentifierSearch),
+            and_: T.nilable(T::Array[Models::Shared::IdentifierExpressionNodeLevelOne]),
+            or_: T.nilable(T::Array[Models::Shared::IdentifierExpressionNodeLevelOne])
+          )
+            .void
+        }
+        def initialize(term: nil, and_: nil, or_: nil)
+          @term = term
+          @and_ = and_
+          @or_ = or_
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @term == other.term
+          return false unless @and_ == other.and_
+          return false unless @or_ == other.or_
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::IdentifierExpressionNodeLevelTwo
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::IdentifierExpressionNodeLevelTwo
+  def term
+  end
+
+  def term=(str_)
+  end
+
+  def and_
+  end
+
+  def and_=(str_)
+  end
+
+  def or_
+  end
+
+  def or_=(str_)
+  end
+end

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

@@ -0,0 +1,105 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Why this result matched a typed identifier search. value is the original value submitted in assessment_id. Provenance records a customer submission, not a source discovery or verified ownership. Equality is deterministic and has no inferred confidence score. An account result names its newest retained matching assessment, which can differ from latest.
+      class IdentifierMatch
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :kind,
+          Models::Shared::IdentifierSearchKind,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("kind"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::IdentifierSearchKind, false)
+            }
+          }
+        )
+
+        field(
+          :value,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("value"), required: true}}
+        )
+        # exact compares the original submitted value; canonical uses identifier-specific normalisation; mailbox explicitly selects the email alias rules used by lists.
+        field(
+          :match_basis,
+          Models::Shared::Match,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("match_basis"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Match, false)
+            }
+          }
+        )
+        # Customer-submitted input. It does not mean the customer or NoResponse verified ownership.
+        field(
+          :provenance,
+          Models::Shared::Provenance,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("provenance"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Provenance, false)
+            }
+          }
+        )
+        # Opaque, server-assigned assessment id: 'asm_' and a 26-character Crockford base32 ULID. Unique within the workspace; another workspace's assessment id answers 404.
+        field(
+          :assessment_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assessment_id"), required: true}}
+        )
+        # Required for username: the username submitted by this customer in this workspace/environment. It does not name or join a source platform. Omit for email and phone.
+        field(
+          :namespace,
+          Crystalline::Nilable.new(Models::Shared::Namespace),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("namespace"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Namespace, true)
+            }
+          }
+        )
+
+        sig {
+          params(
+            kind: Models::Shared::IdentifierSearchKind,
+            value: ::String,
+            match_basis: Models::Shared::Match,
+            provenance: Models::Shared::Provenance,
+            assessment_id: ::String,
+            namespace: T.nilable(Models::Shared::Namespace)
+          )
+            .void
+        }
+        def initialize(kind:, value:, match_basis:, provenance:, assessment_id:, namespace: nil)
+          @kind = kind
+          @value = value
+          @match_basis = match_basis
+          @provenance = provenance
+          @assessment_id = assessment_id
+          @namespace = namespace
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @kind == other.kind
+          return false unless @value == other.value
+          return false unless @match_basis == other.match_basis
+          return false unless @provenance == other.provenance
+          return false unless @assessment_id == other.assessment_id
+          return false unless @namespace == other.namespace
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::IdentifierMatch
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::IdentifierMatch
+  def kind
+  end
+
+  def kind=(str_)
+  end
+
+  def value
+  end
+
+  def value=(str_)
+  end
+
+  def match_basis
+  end
+
+  def match_basis=(str_)
+  end
+
+  def provenance
+  end
+
+  def provenance=(str_)
+  end
+
+  def assessment_id
+  end
+
+  def assessment_id=(str_)
+  end
+
+  def namespace
+  end
+
+  def namespace=(str_)
+  end
+end

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

@@ -0,0 +1,80 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One customer-submitted identifier. Defaults to exact comparison of the original submitted value. canonical uses the supported identifier normalisation without an ownership claim: email preserves local-part case, NFC-normalises it and lowercases the domain without removing dots or tags; phone uses international E.164 without extensions or an inferred region; username uses NFC and Unicode case folding within the customer namespace. mailbox is email-only and explicitly selects existing list rules: case-insensitive, remove +tag, and ignore local-part dots at gmail.com and googlemail.com; googlemail.com maps to gmail.com. Username requires namespace customer. Email and phone forbid namespace. Source-discovered identifiers and platform handles are not searched. Unsupported kinds, namespaces, modes and invalid values return 400. Search equality does not establish verified ownership or merge accounts.
+      class IdentifierSearch
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :kind,
+          Models::Shared::IdentifierSearchKind,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("kind"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::IdentifierSearchKind, false)
+            }
+          }
+        )
+        # The comparison value. Stored original identifiers remain unchanged. An invalid identifier is refused instead of returning an empty result.
+        field(
+          :value,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("value"), required: true}}
+        )
+        # exact compares the original submitted value; canonical uses identifier-specific normalisation; mailbox explicitly selects the email alias rules used by lists.
+        field(
+          :match,
+          Crystalline::Nilable.new(Models::Shared::Match),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("match"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Match, true)
+            }
+          }
+        )
+        # Required for username: the username submitted by this customer in this workspace/environment. It does not name or join a source platform. Omit for email and phone.
+        field(
+          :namespace,
+          Crystalline::Nilable.new(Models::Shared::Namespace),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("namespace"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Namespace, true)
+            }
+          }
+        )
+
+        sig {
+          params(
+            kind: Models::Shared::IdentifierSearchKind,
+            value: ::String,
+            match: T.nilable(Models::Shared::Match),
+            namespace: T.nilable(Models::Shared::Namespace)
+          )
+            .void
+        }
+        def initialize(kind:, value:, match: nil, namespace: nil)
+          @kind = kind
+          @value = value
+          @match = match
+          @namespace = namespace
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @kind == other.kind
+          return false unless @value == other.value
+          return false unless @match == other.match
+          return false unless @namespace == other.namespace
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::IdentifierSearch
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::IdentifierSearch
+  def kind
+  end
+
+  def kind=(str_)
+  end
+
+  def value
+  end
+
+  def value=(str_)
+  end
+
+  def match
+  end
+
+  def match=(str_)
+  end
+
+  def namespace
+  end
+
+  def namespace=(str_)
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+
+      class IdentifierSearchKind
+        include ::Crystalline::Enum
+        enums do
+          EMAIL = new("email")
+          PHONE = new("phone")
+          USERNAME = new("username")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,114 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One satisfied unique term in an identifier expression. term_index is the zero-based depth-first raw leaf position of its first occurrence. Duplicate normalized terms produce one witness. All satisfied unique terms are returned, ordered by term_index, including satisfied terms in an OR branch that was not needed. value preserves the original submitted value in assessment_id. In assessment scope all witnesses belong to the same matching assessment; account search chooses the newest such assessment. In account scope each term uses its newest retained matching assessment, so witnesses may have different assessment IDs. This evidence does not assert ownership or equality between accounts.
+      class IdentifierTermMatch
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        field(
+          :kind,
+          Models::Shared::IdentifierSearchKind,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("kind"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::IdentifierSearchKind, false)
+            }
+          }
+        )
+
+        field(
+          :value,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("value"), required: true}}
+        )
+        # exact compares the original submitted value; canonical uses identifier-specific normalisation; mailbox explicitly selects the email alias rules used by lists.
+        field(
+          :match_basis,
+          Models::Shared::Match,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("match_basis"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Match, false)
+            }
+          }
+        )
+        # Customer-submitted input. It does not mean the customer or NoResponse verified ownership.
+        field(
+          :provenance,
+          Models::Shared::Provenance,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("provenance"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Provenance, false)
+            }
+          }
+        )
+        # Opaque, server-assigned assessment id: 'asm_' and a 26-character Crockford base32 ULID. Unique within the workspace; another workspace's assessment id answers 404.
+        field(
+          :assessment_id,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("assessment_id"), required: true}}
+        )
+        # Zero-based depth-first position of the first occurrence of this normalized term in the submitted expression.
+        field(
+          :term_index,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("term_index"), required: true}}
+        )
+        # Required for username: the username submitted by this customer in this workspace/environment. It does not name or join a source platform. Omit for email and phone.
+        field(
+          :namespace,
+          Crystalline::Nilable.new(Models::Shared::Namespace),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("namespace"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Namespace, true)
+            }
+          }
+        )
+
+        sig {
+          params(
+            kind: Models::Shared::IdentifierSearchKind,
+            value: ::String,
+            match_basis: Models::Shared::Match,
+            provenance: Models::Shared::Provenance,
+            assessment_id: ::String,
+            term_index: ::Integer,
+            namespace: T.nilable(Models::Shared::Namespace)
+          )
+            .void
+        }
+        def initialize(kind:, value:, match_basis:, provenance:, assessment_id:, term_index:, namespace: nil)
+          @kind = kind
+          @value = value
+          @match_basis = match_basis
+          @provenance = provenance
+          @assessment_id = assessment_id
+          @term_index = term_index
+          @namespace = namespace
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @kind == other.kind
+          return false unless @value == other.value
+          return false unless @match_basis == other.match_basis
+          return false unless @provenance == other.provenance
+          return false unless @assessment_id == other.assessment_id
+          return false unless @term_index == other.term_index
+          return false unless @namespace == other.namespace
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::IdentifierTermMatch
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::IdentifierTermMatch
+  def kind
+  end
+
+  def kind=(str_)
+  end
+
+  def value
+  end
+
+  def value=(str_)
+  end
+
+  def match_basis
+  end
+
+  def match_basis=(str_)
+  end
+
+  def provenance
+  end
+
+  def provenance=(str_)
+  end
+
+  def assessment_id
+  end
+
+  def assessment_id=(str_)
+  end
+
+  def term_index
+  end
+
+  def term_index=(str_)
+  end
+
+  def namespace
+  end
+
+  def namespace=(str_)
+  end
+end

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

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Match - exact compares the original submitted value; canonical uses identifier-specific normalisation; mailbox explicitly selects the email alias rules used by lists.
+      class Match
+        include ::Crystalline::Enum
+        enums do
+          EXACT = new("exact")
+          CANONICAL = new("canonical")
+          MAILBOX = new("mailbox")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # Namespace - Required for username: the username submitted by this customer in this workspace/environment. It does not name or join a source platform. Omit for email and phone.
+      class Namespace
+        include ::Crystalline::Enum
+        enums do
+          CUSTOMER = new("customer")
+        end
+
+        open!
+      end
+    end
+  end
+end

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

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