noresponse 8.2.0 → 8.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0c991c74c5d3a8b4c657e5734916987e2e39f1599a49553eec08288fdd6380b
-  data.tar.gz: a580b13bbc7b2cc91a14c61831787fe8250e8c3b72100f297b68a36ce33c2627
+  metadata.gz: a2de462c63f05c59d55e926053395a45fa2b45c6e10c45aa66f7ade4fc2e0447
+  data.tar.gz: 77ff7a7d0b1b602b1a22b9644746277940a5793f938f27f83571fb7b5660f6c7
 SHA512:
-  metadata.gz: 54275c1432e5f05dbf9b99f051d53eedcc97263f5c12457cc99d898640f620ee23f0169b90be712fdc3094113051d318678ca4789e5f4ad7a50f4545bc9d9c41
-  data.tar.gz: 3877ee1a41acb9d0f768ca7709e80cd24202127e8640f6afcf6759222ec645d51bab21f0c4a2b61193fc4eedb500eb8cb12bcb0afccdf3550217dc5317b0db7b
+  metadata.gz: 3050ce89c6a1388e1f1419752a8cd954a608d02757b22f7d941561d996d3b49dec7a2a4409233e20fa96101ab43d59774b93d9ff9200f29ffaec725ccb29237e
+  data.tar.gz: e8fc417da076ca6bbef8679ca7671392555ed6c89b31dc5ac7164fb2b46af80a46050796101b3b77da5a43ae4e7d1c6cae2e4693bfcb706ea13ce241ad328d9f

data/lib/no_response/accounts.rb

@@ -925,7 +925,7 @@ module NoResponse
       http_headers: nil
     )
       # list_assessments - Page through one account's unexpired assessments.
-      # The account's history: the same page as POST /v1/assessments/query for this account_id, newest first, each at its latest assessment_version. Requires the history scope. Read-only and safe to retry. An account with no assessments answers 200 with empty items. The cursor is opaque and bound to your workspace and the account; a tampered or expired cursor answers 400 invalid_cursor. response_mode=detailed needs the detailed scope. The account_id travels in the URL; use POST /v1/assessments/query to keep it out of access logs.
+      # The account's history: the same page as POST /v1/assessments/query for this account_id, newest first, each at its latest assessment_version. Requires the history scope. Read-only and safe to retry. An account with no assessments answers 200 with empty items. The cursor is opaque and bound to your workspace and the account; a tampered or expired cursor answers 400 invalid_cursor. response_mode=detailed needs the detailed scope. Each item's identifiers holds the identifiers its assessment was sent, exactly as received. The account_id travels in the URL; use POST /v1/assessments/query to keep it out of access logs.
       request = Models::Operations::ListAccountAssessmentsRequest.new(
         account_id: account_id,
         limit: limit,
@@ -3319,7 +3319,7 @@ module NoResponse
     }
     def export(account_id:, response_mode: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # export - Export an account
-      # Retrieve one consistent snapshot of retained customer-accessible records, including assessment revisions, account decisions, feedback, key associations, enforcements and request diagnostics. Secrets, restricted source information, other customers' data and legacy free-text notes are excluded. The same standard/detailed permissions apply. An export exceeding 10000 records or 8 MiB returns export_too_large without a partial result. Historical decisions that were not captured are identified as an exclusion.
+      # Retrieve one consistent snapshot of retained customer-accessible records, including assessment revisions, account decisions, feedback, key associations, enforcements and request diagnostics. Each assessment revision's detail.identifiers holds the identifiers that assessment was sent, exactly as received. Secrets, restricted source information, other customers' data and legacy free-text notes are excluded. The same standard/detailed permissions apply. An export exceeding 10000 records or 8 MiB returns export_too_large without a partial result. Historical decisions that were not captured are identified as an exclusion.
       request = Models::Operations::ExportAccountRequest.new(
         account_id: account_id,
         response_mode: response_mode

data/lib/no_response/assessments.rb

@@ -50,7 +50,7 @@ module NoResponse
     }
     def create(body:, idempotency_key: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # create - Assess identifiers for a signup or gateway decision.
-      # Assesses one account creation, login or purchase (flow) and answers with the account's one current risk: account.risk.decision is the decision for this flow (allow, step_up, review or block, where block means your block threshold was reached), and detail holds this assessment's own facts. depth sets how long the answer waits for sources: quick waits only for the fast ones (500 ms), full for the whole budget (3000 ms at most); it defaults to full for account_creation and purchase and quick for login. 200 carries complete or partial, 202 carries pending with Location and Retry-After. While the account's first assessment is pending, account is absent: apply your own fallback for that, 429, 503 or a timeout. NoResponse blocks nothing itself; you decide. Requires the assess scope. Idempotency-Key is optional in the SDK and is bound to the body for 24 hours: the same key with the same body replays the latest assessment with Idempotent-Replayed: true and starts no new work; the same key with a different body answers 409 idempotency_key_reused. response_mode defaults to standard; detailed needs the detailed scope.
+      # Assesses one account creation, login or purchase (flow) and answers with the account's one current risk: account.risk.decision is the decision for this flow (allow, step_up, review or block, where block means your block threshold was reached), and detail holds this assessment's own facts. depth sets how long the answer waits for sources: quick waits only for the fast ones (500 ms), full for the whole budget (3000 ms at most); it defaults to full for account_creation and purchase and quick for login. 200 carries complete or partial, 202 carries pending with Location and Retry-After. While the account's first assessment is pending, account is absent: apply your own fallback for that, 429, 503 or a timeout. NoResponse blocks nothing itself; you decide. Requires the assess scope. Idempotency-Key is optional in the SDK and is bound to the body for 24 hours: the same key with the same body replays the latest assessment with Idempotent-Replayed: true and starts no new work; the same key with a different body answers 409 idempotency_key_reused. response_mode defaults to standard; detailed needs the detailed scope. The answer leaves out detail.identifiers: you hold what you sent, and a key with the history scope gets them back with GET.
       request = Models::Operations::CreateAssessmentRequest.new(
         body: body,
         idempotency_key: idempotency_key
@@ -348,7 +348,7 @@ module NoResponse
     }
     def get(assessment_id:, response_mode: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # get - Poll the authoritative assessment of one assessment.
-      # Returns the highest assessment_version, with the account's current risk. Requires the assess or history scope. While status is pending, or partial with a source still running, the response carries Retry-After; poll no faster than it says. Another workspace's assessment, an unknown or expired assessment and a malformed assessment_id all answer 404 not_found. response_mode=detailed needs the detailed scope.
+      # Returns the highest assessment_version, with the account's current risk. Requires the assess or history scope. While status is pending, or partial with a source still running, the response carries Retry-After; poll no faster than it says. Another workspace's assessment, an unknown or expired assessment and a malformed assessment_id all answer 404 not_found. response_mode=detailed needs the detailed scope. A key with the history scope also gets detail.identifiers, the identifiers the assessment was sent, exactly as received.
       request = Models::Operations::GetAssessmentRequest.new(
         assessment_id: assessment_id,
         response_mode: response_mode
@@ -1232,7 +1232,7 @@ module NoResponse
     }
     def query(request:, retries: nil, timeout_ms: nil, http_headers: nil)
       # query - Page through one account's unexpired assessments.
-      # History is a POST with account_id in the body so an account identifier stays out of URLs and access logs. Requires the history scope. Read-only and safe to retry. Newest first, each at its latest assessment_version. An account with no assessments answers 200 with empty items. The cursor is opaque and bound to your workspace and the account; a tampered or expired cursor answers 400 invalid_cursor. response_mode=detailed needs the detailed scope.
+      # History is a POST with account_id in the body so an account identifier stays out of URLs and access logs. Requires the history scope. Read-only and safe to retry. Newest first, each at its latest assessment_version. An account with no assessments answers 200 with empty items. The cursor is opaque and bound to your workspace and the account; a tampered or expired cursor answers 400 invalid_cursor. response_mode=detailed needs the detailed scope. Each item's identifiers holds the identifiers its assessment was sent, exactly as received.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/v1/assessments/query"
@@ -1548,7 +1548,7 @@ module NoResponse
     }
     def search(request:, retries: nil, timeout_ms: nil, http_headers: nil)
       # search - Search assessments across this environment
-      # Search retained assessments created in [from,to), over at most 366 days. Filters use each assessment decision, rather than the current account decision. Results can change between pages. Keep the assessment version to retrieve the exact decision later. This read does not require an idempotency key.
+      # Search retained assessments created in [from,to), over at most 366 days. Filters use each assessment decision, rather than the current account decision. Results can change between pages. Keep the assessment version to retrieve the exact decision later. Each item's detail.identifiers holds the identifiers its assessment was sent, exactly as received. This read does not require an idempotency key.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/v1/assessments/search"
@@ -1843,7 +1843,7 @@ module NoResponse
     }
     def retrieve_version(assessment_id:, version:, response_mode: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # retrieve_version - Retrieve an exact assessment revision
-      # Retrieve a retained assessment version with its original decision, policy, flow and depth. This response excludes the current account decision. Current retention and response-mode permissions still apply.
+      # Retrieve a retained assessment version with its original decision, policy, flow and depth. This response excludes the current account decision. Current retention and response-mode permissions still apply. detail.identifiers holds the identifiers the assessment was sent, exactly as received.
       request = Models::Operations::GetAssessmentVersionRequest.new(
         assessment_id: assessment_id,
         version: version,

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

@@ -93,6 +93,12 @@ module NoResponse
           ::String,
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("schema_version"), required: true}}
         )
+        # The identifiers an assessment was sent: each member of the request's identifiers object exactly as received, before the server normalised it (the email domain keeps its case, the name its Unicode form). A member the request did not send is absent. NoResponse keeps them encrypted under the workspace's own key, does not index or log them, and deletes them with the assessment: on DELETE of the assessment or its account, at its expires_at, and with the workspace.
+        field(
+          :identifiers,
+          Crystalline::Nilable.new(Models::Shared::SentIdentifiers),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("identifiers")}}
+        )
         # An optional provider correlation id, echoed back. It is not an idempotency key. Refuses an exact-shape JWT or a bare 40, 64 or 128 character hex digest; a UUID is accepted.
         field(
           :request_id,
@@ -155,6 +161,7 @@ module NoResponse
             expires_at: ::String,
             timing: Models::Shared::AssessmentDetailTiming,
             schema_version: ::String,
+            identifiers: T.nilable(Models::Shared::SentIdentifiers),
             request_id: T.nilable(::String),
             recommendation: T.nilable(Models::Shared::Recommendation),
             risk: T.nilable(Models::Shared::Risk),
@@ -178,6 +185,7 @@ module NoResponse
           expires_at:,
           timing:,
           schema_version: "1",
+          identifiers: nil,
           request_id: nil,
           recommendation: nil,
           risk: nil,
@@ -202,6 +210,7 @@ module NoResponse
           end
 
           @schema_version = "1"
+          @identifiers = identifiers
           @request_id = request_id
           @recommendation = recommendation
           @risk = risk
@@ -230,6 +239,7 @@ module NoResponse
           return false unless @expires_at == other.expires_at
           return false unless @timing == other.timing
           return false unless @schema_version == other.schema_version
+          return false unless @identifiers == other.identifiers
           return false unless @request_id == other.request_id
           return false unless @recommendation == other.recommendation
           return false unless @risk == other.risk

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

@@ -78,6 +78,12 @@ class NoResponse::Models::Shared::AssessmentDetail
   def schema_version=(str_)
   end
 
+  def identifiers
+  end
+
+  def identifiers=(str_)
+  end
+
   def request_id
   end
 

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

@@ -0,0 +1,74 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The identifiers an assessment was sent: each member of the request's identifiers object exactly as received, before the server normalised it (the email domain keeps its case, the name its Unicode form). A member the request did not send is absent. NoResponse keeps them encrypted under the workspace's own key, does not index or log them, and deletes them with the assessment: on DELETE of the assessment or its account, at its expires_at, and with the workspace.
+      class SentIdentifiers
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # identifiers.email as the request sent it.
+        field(
+          :email,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("email")}}
+        )
+        # identifiers.username as the request sent it.
+        field(
+          :username,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("username")}}
+        )
+        # identifiers.phone as the request sent it.
+        field(
+          :phone,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("phone")}}
+        )
+        # identifiers.name as the request sent it, before NFC normalisation.
+        field(
+          :name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("name")}}
+        )
+        # identifiers.ip as the request sent it.
+        field(
+          :ip,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("ip")}}
+        )
+
+        sig {
+          params(
+            email: T.nilable(::String),
+            username: T.nilable(::String),
+            phone: T.nilable(::String),
+            name: T.nilable(::String),
+            ip: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(email: nil, username: nil, phone: nil, name: nil, ip: nil)
+          @email = email
+          @username = username
+          @phone = phone
+          @name = name
+          @ip = ip
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @email == other.email
+          return false unless @username == other.username
+          return false unless @phone == other.phone
+          return false unless @name == other.name
+          return false unless @ip == other.ip
+          true
+        end
+      end
+    end
+  end
+end

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

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

data/lib/no_response/models/shared.rb

@@ -157,6 +157,7 @@ module NoResponse
       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 :SentIdentifiers, "no_response/models/shared/sentidentifiers.rb"
       autoload :Settings, "no_response/models/shared/settings.rb"
       autoload :SettingsFlows, "no_response/models/shared/settingsflows.rb"
       autoload :SettingsRequest, "no_response/models/shared/settingsrequest.rb"

data/lib/no_response/sdkconfiguration.rb

@@ -95,9 +95,9 @@ module NoResponse
 
       @language = "ruby"
       @openapi_doc_version = "1"
-      @sdk_version = "8.2.0"
+      @sdk_version = "8.2.1"
       @gen_version = "internal"
-      @user_agent = "noresponse-sdk/ruby 8.2.0 internal 1 noresponse"
+      @user_agent = "noresponse-sdk/ruby 8.2.1 internal 1 noresponse"
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noresponse
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.2.1
 platform: ruby
 authors:
 - NoResponse
@@ -757,6 +757,8 @@ files:
 - lib/no_response/models/shared/risksummaryusername.rbi
 - lib/no_response/models/shared/security.rb
 - lib/no_response/models/shared/security.rbi
+- lib/no_response/models/shared/sentidentifiers.rb
+- lib/no_response/models/shared/sentidentifiers.rbi
 - lib/no_response/models/shared/settings.rb
 - lib/no_response/models/shared/settings.rbi
 - lib/no_response/models/shared/settingsflows.rb