noresponse 8.3.0 → 8.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9e488e772432bf291e12c927572051286be92d2e7571b8a0d5897d413f1a9f
-  data.tar.gz: 41ce407e0b72b2cb45b757d87ec2f70353cb73f1d563f981865aadd239e3b933
+  metadata.gz: fed83d7d39a77dff5100c108fbc80b8b9914ed517cf7d783e39f198136746eaa
+  data.tar.gz: 65ba39190d307f0889684074936f7aa4446e29deb664027a6d13eb3348819283
 SHA512:
-  metadata.gz: 8244940ad0a13006308c976eecd9a5982144d36059373f18101d69c574fca874e1192c16af296d6e15473125fa668c8b02885795d1b4240c3c84e8e3e1cb8461
-  data.tar.gz: b130ae6e02b8d2db706cd843ff6b2ae9552c4d0ec869a3f96431cc76e75247a833adb0f64624f1c3a53ca9b10572cd7146cd4ec8b6f43d25b47eca77be747935
+  metadata.gz: 1a85f004e3b59338cb22c7db99f15036475c73c2c5d80b6d71bdf0c5c9abe9560f16a0735162a27069b9af2985d2d8479066102f52f4f6dea324e4964c31aea8
+  data.tar.gz: fdc3211e61760164e915e86ba8624aaab5c1b7d7039109b8d512522546eba91c28119698b1077e925418471588cfa38a8c246865fa384d3272a7c2be5c5cdfe6

data/lib/no_response/assessments.rb

@@ -1548,7 +1548,7 @@ module NoResponse
     }
     def aggregate(request:, retries: nil, timeout_ms: nil, http_headers: nil)
       # aggregate - Count assessments by time, decision and reason
-      # Count this environment's assessments created in [from,to) by hour, day or week, grouped by up to two of decision, flow, recommendation, band, reason, lane, country, asn and list_match. Each assessment counts once, by its first answer; late results do not count it again and appear in late_flips. Optional metrics add a score histogram per flow and late account decision changes. from and to start a bucket and cover at most 366 days (31 for hour buckets) inside the retention period. The filters are search's and describe the first answer: send them to search with revision first to list a cell's assessments. Counts hold no identifier, stay when an assessment or account is deleted, and report reasons by code and impact band. No Idempotency-Key.
+      # Count this environment's assessments created in [from,to) by hour, day or week, grouped by up to two of decision, flow, recommendation, band, reason, lane, country, asn and list_match. Each assessment counts once, by its first answer; late results do not count it again and appear in late_flips. Optional metrics add a score histogram per flow, that histogram by the latest reported outcome, and late account decision changes. from and to start a bucket and cover at most 366 days (31 for hour buckets) inside the retention period. The filters are search's and describe the first answer: send them to search with revision first to list a cell's assessments. Counts hold no identifier, stay when an assessment or account is deleted, and report reasons by code and impact band. No Idempotency-Key.
       url, params = @sdk_configuration.get_server_details
       base_url = Utils.template_url(url, params)
       url = "#{base_url}/v1/assessments/aggregate"

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

@@ -32,6 +32,12 @@ module NoResponse
           Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::AggregateScoreCount)),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("score_histogram")}}
         )
+        # With metric score_outcomes: the score_histogram's first answers whose assessment has a reported outcome, by its latest. A bin's count less its score_outcomes is the first answers with none reported.
+        field(
+          :score_outcomes,
+          Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::AggregateScoreOutcome)),
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("score_outcomes")}}
+        )
 
         field(
           :late_flips,
@@ -45,15 +51,17 @@ module NoResponse
             count: T.nilable(::Integer),
             groups: T.nilable(T::Array[Models::Shared::AggregateGroup]),
             score_histogram: T.nilable(T::Array[Models::Shared::AggregateScoreCount]),
+            score_outcomes: T.nilable(T::Array[Models::Shared::AggregateScoreOutcome]),
             late_flips: T.nilable(T::Array[Models::Shared::AggregateLateFlip])
           )
             .void
         }
-        def initialize(start:, count: nil, groups: nil, score_histogram: nil, late_flips: nil)
+        def initialize(start:, count: nil, groups: nil, score_histogram: nil, score_outcomes: nil, late_flips: nil)
           @start = start
           @count = count
           @groups = groups
           @score_histogram = score_histogram
+          @score_outcomes = score_outcomes
           @late_flips = late_flips
         end
 
@@ -64,6 +72,7 @@ module NoResponse
           return false unless @count == other.count
           return false unless @groups == other.groups
           return false unless @score_histogram == other.score_histogram
+          return false unless @score_outcomes == other.score_outcomes
           return false unless @late_flips == other.late_flips
           true
         end

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

@@ -30,6 +30,12 @@ class NoResponse::Models::Shared::AggregateBucket
   def score_histogram=(str_)
   end
 
+  def score_outcomes
+  end
+
+  def score_outcomes=(str_)
+  end
+
   def late_flips
   end
 

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

@@ -0,0 +1,86 @@
+# typed: true
+# frozen_string_literal: true
+
+module NoResponse
+  module Models
+    module Shared
+      # First answers of one flow whose risk.score is in [score_min, score_max] and whose assessment's latest reported outcome (the latest received) is outcome. Counted when the first answer is counted and moved when a later outcome wins; outcomes reported before the first answer was counted are counted with it. An outcome reported before this count existed is counted only once another outcome is reported for the assessment.
+      class AggregateScoreOutcome
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # 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)
+            }
+          }
+        )
+        # A multiple of 5.
+        field(
+          :score_min,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("score_min"), required: true}}
+        )
+
+        field(
+          :score_max,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("score_max"), required: true}}
+        )
+        # What the provider later learned about the assessed account. confirmed_abuse, account_takeover and chargeback report abuse; false_positive and legitimate withdraw an earlier abuse report of this workspace for the assessment; unknown is recorded only. Outcomes are append-only and the latest one recorded for an assessment wins.
+        field(
+          :outcome,
+          Models::Shared::Outcome,
+          {
+            'format_json': {
+              'letter_case': ::NoResponse::Utils.field_name("outcome"),
+              required: true,
+              'decoder': ::NoResponse::Utils.open_enum_from_string(Models::Shared::Outcome, false)
+            }
+          }
+        )
+
+        field(
+          :count,
+          ::Integer,
+          {'format_json': {'letter_case': ::NoResponse::Utils.field_name("count"), required: true}}
+        )
+
+        sig {
+          params(
+            flow: Models::Shared::Flow,
+            score_min: ::Integer,
+            score_max: ::Integer,
+            outcome: Models::Shared::Outcome,
+            count: ::Integer
+          )
+            .void
+        }
+        def initialize(flow:, score_min:, score_max:, outcome:, count:)
+          @flow = flow
+          @score_min = score_min
+          @score_max = score_max
+          @outcome = outcome
+          @count = count
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @flow == other.flow
+          return false unless @score_min == other.score_min
+          return false unless @score_max == other.score_max
+          return false unless @outcome == other.outcome
+          return false unless @count == other.count
+          true
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# typed: true
+# frozen_string_literal: true
+
+class NoResponse::Models::Shared::AggregateScoreOutcome
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class NoResponse::Models::Shared::AggregateScoreOutcome
+  def flow
+  end
+
+  def flow=(str_)
+  end
+
+  def score_min
+  end
+
+  def score_min=(str_)
+  end
+
+  def score_max
+  end
+
+  def score_max=(str_)
+  end
+
+  def outcome
+  end
+
+  def outcome=(str_)
+  end
+
+  def count
+  end
+
+  def count=(str_)
+  end
+end

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

@@ -10,6 +10,7 @@ module NoResponse
         enums do
           COUNT = new("count")
           SCORE_HISTOGRAM = new("score_histogram")
+          SCORE_OUTCOMES = new("score_outcomes")
           LATE_FLIPS = new("late_flips")
         end
 

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

@@ -31,7 +31,7 @@ module NoResponse
           Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::AggregateDimension)),
           {'format_json': {'letter_case': ::NoResponse::Utils.field_name("group_by")}}
         )
-        # count: each bucket's count and groups. score_histogram: first answers by flow and 5-point score bucket. late_flips: changes of an assessment's account decision for its flow after its first answer, by from, to and delay.
+        # count: each bucket's count and groups. score_histogram: first answers by flow and 5-point score bucket. score_outcomes: the histogram's first answers that have a reported outcome, by flow, 5-point score bucket and the latest outcome reported for the assessment (POST /v1/assessments/{assessment_id}/outcomes); the rest of a bin has none reported. late_flips: changes of an assessment's account decision for its flow after its first answer, by from, to and delay.
         field(
           :metrics,
           Crystalline::Nilable.new(Crystalline::Array.new(Models::Shared::AssessmentAggregateRequestMetric)),

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

@@ -9,6 +9,7 @@ module NoResponse
         enums do
           COUNT = new("count")
           SCORE_HISTOGRAM = new("score_histogram")
+          SCORE_OUTCOMES = new("score_outcomes")
           LATE_FLIPS = new("late_flips")
         end
       end

data/lib/no_response/models/shared.rb

@@ -30,6 +30,7 @@ module NoResponse
       autoload :AggregateGroup, "no_response/models/shared/aggregategroup.rb"
       autoload :AggregateLateFlip, "no_response/models/shared/aggregatelateflip.rb"
       autoload :AggregateScoreCount, "no_response/models/shared/aggregatescorecount.rb"
+      autoload :AggregateScoreOutcome, "no_response/models/shared/aggregatescoreoutcome.rb"
       autoload :Agreement, "no_response/models/shared/agreement.rb"
       autoload :AnswerRevision, "no_response/models/shared/answerrevision.rb"
       autoload :Assessment, "no_response/models/shared/assessment.rb"

data/lib/no_response/sdkconfiguration.rb

@@ -95,9 +95,9 @@ module NoResponse
 
       @language = "ruby"
       @openapi_doc_version = "1"
-      @sdk_version = "8.3.0"
+      @sdk_version = "8.4.0"
       @gen_version = "internal"
-      @user_agent = "noresponse-sdk/ruby 8.3.0 internal 1 noresponse"
+      @user_agent = "noresponse-sdk/ruby 8.4.0 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.3.0
+  version: 8.4.0
 platform: ruby
 authors:
 - NoResponse
@@ -487,6 +487,8 @@ files:
 - lib/no_response/models/shared/aggregatelateflip.rbi
 - lib/no_response/models/shared/aggregatescorecount.rb
 - lib/no_response/models/shared/aggregatescorecount.rbi
+- lib/no_response/models/shared/aggregatescoreoutcome.rb
+- lib/no_response/models/shared/aggregatescoreoutcome.rbi
 - lib/no_response/models/shared/agreement.rb
 - lib/no_response/models/shared/agreement.rbi
 - lib/no_response/models/shared/alternate_name.rb