noresponse 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2683501bd085a9d906920785f0b05c5e64f700a52e5948cf99784c09a10842a2
-  data.tar.gz: dcf5904871ec73529d76a406e83502d555aeca8032c6d698509448690a4b4e8c
+  metadata.gz: 8953e9efde2a1afc67354b14a01cbe5839454a6920f6603d2f072aaf5649d777
+  data.tar.gz: 9bc93c249f17aaecf7eaff58c6fa7ffdb4c472b04d45856c8c09260269144acd
 SHA512:
-  metadata.gz: c91b613a10f29a16f273474ce11124a531b1c470da9ebad9497409c647b02ede74509e5528f9eb4e5b697bedda6dbe959438548e3e77e3ba3740bfcc201ce626
-  data.tar.gz: d1ef68c0d2bb919fd0e0cd4071a1ff5da3b0959d2febda4ca594f32f5ad09c17e8ddbd02691383acbb2875bef6ef88f1c2ab5f350bc76dd328490f53376d262c
+  metadata.gz: 61d8e3318514097c2d3ccd782403c75facdefd90ecc81ab90c193f001feb610c3badcf766da50b7ddc9b09982b876a81e21386e2d68e027dae0860e3ef0b5361
+  data.tar.gz: 0f0778475a4f26e754af8139f13cae8d08a9e596aea104bc21b0ac0d252d5b03e43b92fa0985e38010bf0c4049402ab5ee1acbfbd51f997d5a032c89684ff9f0

data/lib/no_response/assessments.rb

@@ -1841,7 +1841,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. Each item's detail.identifiers holds the identifiers its assessment was sent, exactly as received. 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, and first_decision holds the decision of its first answer. email finds every assessment of the accounts that sent a mailbox, matched as lists match it. changed keeps the assessments a later revision changed. total counts every match, exactly up to 10000. 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"

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

@@ -0,0 +1,115 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # One stored assessment revision, exactly as GET /v1/assessments/{assessment_id}/versions/{version} returns it, with the decision of the assessment's first answer. It is not re-scored and carries no current account risk.
+      class AssessmentSearchItem
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # This assessment's id, equal to detail.assessment_id.
+        field :id, ::String, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("id"), required: true}}
+        # 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.
+        field(
+          :status,
+          Models::Shared::Status,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("status"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Status, false)
+            }
+          }
+        )
+        # The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
+        field(
+          :flow,
+          Models::Shared::Flow,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("flow"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Flow, false)
+            }
+          }
+        )
+        # How long the synchronous answer waits for sources. quick waits only for the fast sources, those that answer within 500 ms of ingress (or deadline_ms when lower); full waits for the whole budget, up to 3000 ms. Sources still running at the cut continue asynchronously and update the assessment either way.
+        field(
+          :depth,
+          Models::Shared::Depth,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("depth"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Depth, false)
+            }
+          }
+        )
+        # One assessment's own facts: its score and recommendation, the signals behind them, the lanes still running and its timing. risk here is this assessment's own score; the account's current risk is the account member of the assessment. risk and recommendation are present for complete and partial; assessment_url is present for pending.
+        field(
+          :detail,
+          Models::Shared::AssessmentDetail,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("detail"), required: true}}
+        )
+        # Version of the body shape.
+        field(
+          :schema_version,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("schema_version"), required: true}}
+        )
+        # An assessment's own decision: block when its stored risk.block is true, otherwise its recommendation. It is not the account's decision or held-admission state.
+        field(
+          :first_decision,
+          Crystalline::Nilable.new(Models::Shared::Decision),
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("first_decision"),
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Decision, true)
+            }
+          }
+        )
+
+        sig {
+          params(
+            id: ::String,
+            status: Models::Shared::Status,
+            flow: Models::Shared::Flow,
+            depth: Models::Shared::Depth,
+            detail: Models::Shared::AssessmentDetail,
+            schema_version: ::String,
+            first_decision: T.nilable(Models::Shared::Decision)
+          )
+            .void
+        }
+        def initialize(id:, status:, flow:, depth:, detail:, schema_version: "1", first_decision: nil)
+          @id = id
+          @status = status
+          @flow = flow
+          @depth = depth
+          @detail = detail
+          unless schema_version == "1"
+            raise ArgumentError, "Invalid value for schema_version"
+          end
+
+          @schema_version = "1"
+          @first_decision = first_decision
+        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 @status == other.status
+          return false unless @flow == other.flow
+          return false unless @depth == other.depth
+          return false unless @detail == other.detail
+          return false unless @schema_version == other.schema_version
+          return false unless @first_decision == other.first_decision
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AssessmentSearchItem
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AssessmentSearchItem
+  def id
+  end
+
+  def id=(str_)
+  end
+
+  def status
+  end
+
+  def status=(str_)
+  end
+
+  def flow
+  end
+
+  def flow=(str_)
+  end
+
+  def depth
+  end
+
+  def depth=(str_)
+  end
+
+  def detail
+  end
+
+  def detail=(str_)
+  end
+
+  def schema_version
+  end
+
+  def schema_version=(str_)
+  end
+
+  def first_decision
+  end
+
+  def first_decision=(str_)
+  end
+end

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

@@ -4,16 +4,28 @@
 module NoResponse
   module Models
     module Shared
-      # A bounded page of latest assessment revisions, newest creation first. Each revision identifies the exact result found; no current account risk is attached.
+      # A bounded page of latest assessment revisions, newest creation first, with how many assessments match the filters. Each item is the revision found and its first answer's decision; no current account risk is attached.
       class AssessmentSearchPage
         extend T::Sig
         include Crystalline::MetadataFields
 
         field(
           :items,
-          Crystalline::Array.new(Models::Shared::AssessmentRevision),
+          Crystalline::Array.new(Models::Shared::AssessmentSearchItem),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
         )
+        # How many assessments match the filters over every page, counted when this page was read: exact up to 10000. At 10000 or more it is 10000 and total_capped is true. The cursor does not change it; a later page can count differently, as results are live.
+        field(
+          :total,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("total"), required: true}}
+        )
+        # True when at least 10000 assessments match, so total is 10000 and not the exact count.
+        field(
+          :total_capped,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("total_capped"), required: true}}
+        )
         # Version of the body shape.
         field(
           :schema_version,
@@ -35,15 +47,19 @@ module NoResponse
 
         sig {
           params(
-            items: T::Array[Models::Shared::AssessmentRevision],
+            items: T::Array[Models::Shared::AssessmentSearchItem],
+            total: ::Integer,
+            total_capped: T::Boolean,
             schema_version: ::String,
             next_cursor: T.nilable(::String),
             retention_days: T.nilable(::Integer)
           )
             .void
         }
-        def initialize(items:, schema_version: "1", next_cursor: nil, retention_days: 365)
+        def initialize(items:, total:, total_capped:, schema_version: "1", next_cursor: nil, retention_days: 365)
           @items = items
+          @total = total
+          @total_capped = total_capped
           unless schema_version == "1"
             raise ArgumentError, "Invalid value for schema_version"
           end
@@ -57,6 +73,8 @@ module NoResponse
         def ==(other)
           return false unless other.is_a?(self.class)
           return false unless @items == other.items
+          return false unless @total == other.total
+          return false unless @total_capped == other.total_capped
           return false unless @schema_version == other.schema_version
           return false unless @next_cursor == other.next_cursor
           return false unless @retention_days == other.retention_days

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

@@ -12,6 +12,18 @@ class NoResponse::Models::Shared::AssessmentSearchPage
   def items=(str_)
   end
 
+  def total
+  end
+
+  def total=(str_)
+  end
+
+  def total_capped
+  end
+
+  def total_capped=(str_)
+  end
+
   def schema_version
   end
 

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

@@ -18,6 +18,12 @@ module NoResponse
           Crystalline::Nilable.new(::String),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("account_id")}}
         )
+        # Assessments of every account that one of its retained admitted assessments sent this mailbox as identifiers.email, matched as lists match an email entry: case-insensitive, a +tag removed and, at gmail.com and googlemail.com, the dots of the local part ignored. Only assessments stored since email list matching began carry the mailbox. An address that is not a valid mailbox is refused with 400.
+        field(
+          :email,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("email")}}
+        )
         # The event an assessment is made for: account_creation (a user creates an account), login (a user returns to an existing account) or purchase (a payment or a credit grant). The account's risk is reported with the decision for this flow.
         field(
           :flow,
@@ -169,6 +175,12 @@ module NoResponse
             }
           }
         )
+        # true returns only assessments whose latest stored revision's decision differs from their first answer's decision (see decision); false only the others. An assessment whose first answer or latest revision has no decision yet is not changed. Cannot be combined with revision first.
+        field(
+          :changed,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("changed")}}
+        )
 
         field(
           :limit,
@@ -181,6 +193,7 @@ module NoResponse
             from: ::String,
             to: ::String,
             account_id: T.nilable(::String),
+            email: T.nilable(::String),
             flow: T.nilable(Models::Shared::Flow),
             status: T.nilable(Models::Shared::Status),
             recommendation: T.nilable(Models::Shared::Recommendation),
@@ -197,6 +210,7 @@ module NoResponse
             score_min: T.nilable(::Integer),
             score_max: T.nilable(::Integer),
             list_match: T.nilable(Models::Shared::ListMatch),
+            changed: T.nilable(T::Boolean),
             limit: T.nilable(::Integer)
           )
             .void
@@ -205,6 +219,7 @@ module NoResponse
           from:,
           to:,
           account_id: nil,
+          email: nil,
           flow: nil,
           status: nil,
           recommendation: nil,
@@ -221,11 +236,13 @@ module NoResponse
           score_min: nil,
           score_max: nil,
           list_match: nil,
+          changed: nil,
           limit: 20
         )
           @from = from
           @to = to
           @account_id = account_id
+          @email = email
           @flow = flow
           @status = status
           @recommendation = recommendation
@@ -242,6 +259,7 @@ module NoResponse
           @score_min = score_min
           @score_max = score_max
           @list_match = list_match
+          @changed = changed
           @limit = limit
         end
 
@@ -251,6 +269,7 @@ module NoResponse
           return false unless @from == other.from
           return false unless @to == other.to
           return false unless @account_id == other.account_id
+          return false unless @email == other.email
           return false unless @flow == other.flow
           return false unless @status == other.status
           return false unless @recommendation == other.recommendation
@@ -267,6 +286,7 @@ module NoResponse
           return false unless @score_min == other.score_min
           return false unless @score_max == other.score_max
           return false unless @list_match == other.list_match
+          return false unless @changed == other.changed
           return false unless @limit == other.limit
           true
         end

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

@@ -24,6 +24,12 @@ class NoResponse::Models::Shared::AssessmentSearchRequest
   def account_id=(str_)
   end
 
+  def email
+  end
+
+  def email=(str_)
+  end
+
   def flow
   end
 
@@ -120,6 +126,12 @@ class NoResponse::Models::Shared::AssessmentSearchRequest
   def list_match=(str_)
   end
 
+  def changed
+  end
+
+  def changed=(str_)
+  end
+
   def limit
   end
 

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

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # The live environment's daily cap on assessments members make through the console (the playground), as spent on the current UTC day. Each console submission with a new Idempotency-Key spends one lookup; a replay spends nothing, and API keys and the test environment spend none. When used reaches limit, the next lookup answers 429 lookup_limit_reached until resets_at. The count is the one the cap enforces.
+      class ConsoleLookups
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Lookups spent since the last reset.
+        field :used, ::Integer, {'format_json': {'letter_case': ::NoResponse::Utils.field_name("used"), required: true}}
+        # Lookups allowed per UTC day.
+        field(
+          :limit,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("limit"), required: true}}
+        )
+        # The next reset: the coming midnight UTC, when used returns to 0.
+        field(
+          :resets_at,
+          ::String,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("resets_at"), required: true}}
+        )
+
+        sig { params(used: ::Integer, limit: ::Integer, resets_at: ::String).void }
+        def initialize(used:, limit:, resets_at:)
+          @used = used
+          @limit = limit
+          @resets_at = resets_at
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @used == other.used
+          return false unless @limit == other.limit
+          return false unless @resets_at == other.resets_at
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::ConsoleLookups
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::ConsoleLookups
+  def used
+  end
+
+  def used=(str_)
+  end
+
+  def limit
+  end
+
+  def limit=(str_)
+  end
+
+  def resets_at
+  end
+
+  def resets_at=(str_)
+  end
+end

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

@@ -4,7 +4,7 @@
 module NoResponse
   module Models
     module Shared
-      # Body of the 200 answer to GET /v1/workspaces/{workspace_id}/usage: what the workspace's environments were metered for on each UTC day from from through to. Each billable unit is counted once, where it becomes final: an assessment when it is admitted (by flow and depth), a webhook delivery once per event per endpoint (retries and replays add nothing), and a key-usage event once when the ingest accepts it. A count does not change when the assessment, account or workspace is later deleted. A day, environment or metric with nothing counted has no item. No prices, limits or billing.
+      # Body of the 200 answer to GET /v1/workspaces/{workspace_id}/usage: what the workspace's environments were metered for on each UTC day from from through to. Each billable unit is counted once, where it becomes final: an assessment when it is admitted (by flow and depth), a webhook delivery once per event per endpoint (retries and replays add nothing), and a key-usage event once when the ingest accepts it. A count does not change when the assessment, account or workspace is later deleted. A day, environment or metric with nothing counted has no item. No prices or billing. console_lookups is the one limit: the live environment's daily cap on console lookups, as spent today.
       class Usage
         extend T::Sig
         include Crystalline::MetadataFields
@@ -25,15 +25,29 @@ module NoResponse
           Crystalline::Array.new(Models::Shared::UsageCount),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("items"), required: true}}
         )
+        # The live environment's daily cap on assessments members make through the console (the playground), as spent on the current UTC day. Each console submission with a new Idempotency-Key spends one lookup; a replay spends nothing, and API keys and the test environment spend none. When used reaches limit, the next lookup answers 429 lookup_limit_reached until resets_at. The count is the one the cap enforces.
+        field(
+          :console_lookups,
+          Crystalline::Nilable.new(Models::Shared::ConsoleLookups),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("console_lookups")}}
+        )
 
         sig {
-          params(workspace_id: ::String, from: ::String, to: ::String, items: T::Array[Models::Shared::UsageCount]).void
+          params(
+            workspace_id: ::String,
+            from: ::String,
+            to: ::String,
+            items: T::Array[Models::Shared::UsageCount],
+            console_lookups: T.nilable(Models::Shared::ConsoleLookups)
+          )
+            .void
         }
-        def initialize(workspace_id:, from:, to:, items:)
+        def initialize(workspace_id:, from:, to:, items:, console_lookups: nil)
           @workspace_id = workspace_id
           @from = from
           @to = to
           @items = items
+          @console_lookups = console_lookups
         end
 
         sig { params(other: T.untyped).returns(T::Boolean) }
@@ -43,6 +57,7 @@ module NoResponse
           return false unless @from == other.from
           return false unless @to == other.to
           return false unless @items == other.items
+          return false unless @console_lookups == other.console_lookups
           true
         end
       end

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

@@ -29,4 +29,10 @@ class NoResponse::Models::Shared::Usage
 
   def items=(str_)
   end
+
+  def console_lookups
+  end
+
+  def console_lookups=(str_)
+  end
 end

data/lib/no_response/models/shared.rb

@@ -60,6 +60,7 @@ module NoResponse
       autoload :AssessmentRequestIssuedCredential, "no_response/models/shared/assessmentrequestissuedcredential.rb"
       autoload :AssessmentRequestPolicyContext, "no_response/models/shared/assessmentrequestpolicycontext.rb"
       autoload :AssessmentRevision, "no_response/models/shared/assessmentrevision.rb"
+      autoload :AssessmentSearchItem, "no_response/models/shared/assessmentsearchitem.rb"
       autoload :AssessmentSearchPage, "no_response/models/shared/assessmentsearchpage.rb"
       autoload :AssessmentSearchRequest, "no_response/models/shared/assessmentsearchrequest.rb"
       autoload :AssessmentUpdatedData, "no_response/models/shared/assessmentupdateddata.rb"
@@ -94,6 +95,7 @@ module NoResponse
       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 :ConsoleLookups, "no_response/models/shared/consolelookups.rb"
       autoload :Cost, "no_response/models/shared/cost.rb"
       autoload :Country, "no_response/models/shared/country.rb"
       autoload :Coverage, "no_response/models/shared/coverage.rb"

data/lib/no_response/sdkconfiguration.rb

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

data/lib/no_response/usage.rb

@@ -50,7 +50,7 @@ module NoResponse
     }
     def get(workspace_id:, from: nil, to: nil, retries: nil, timeout_ms: nil, http_headers: nil)
       # get - Read a workspace's usage.
-      # Read daily usage units for the environments you can access. These counts are unpriced.
+      # Read daily usage units for the environments you can access. These counts are unpriced. With live access it also returns the daily console lookup cap: used, limit and resets_at.
       request = Models::Operations::GetUsageRequest.new(
         workspace_id: workspace_id,
         from: from,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noresponse
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - NoResponse
@@ -777,6 +777,8 @@ files:
 - lib/no_response/models/shared/assessmentrequestpolicycontext.rbi
 - lib/no_response/models/shared/assessmentrevision.rb
 - lib/no_response/models/shared/assessmentrevision.rbi
+- lib/no_response/models/shared/assessmentsearchitem.rb
+- lib/no_response/models/shared/assessmentsearchitem.rbi
 - lib/no_response/models/shared/assessmentsearchpage.rb
 - lib/no_response/models/shared/assessmentsearchpage.rbi
 - lib/no_response/models/shared/assessmentsearchrequest.rb
@@ -845,6 +847,8 @@ files:
 - lib/no_response/models/shared/consistency.rbi
 - lib/no_response/models/shared/consistencyvalue.rb
 - lib/no_response/models/shared/consistencyvalue.rbi
+- lib/no_response/models/shared/consolelookups.rb
+- lib/no_response/models/shared/consolelookups.rbi
 - lib/no_response/models/shared/cost.rb
 - lib/no_response/models/shared/cost.rbi
 - lib/no_response/models/shared/country.rb