Deprecate Factors subscores

maxmind · Oct 23, 2024 · 33329ac · 33329ac
1 parent 9287b1b
commit 33329ac
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v2.7.0
+
+* The minFraud Factors subscores have been deprecated. They will be removed
+  in March 2025. Please see [our release notes](https://dev.maxmind.com/minfraud/release-notes/2024/#deprecation-of-risk-factor-scoressubscores)
+  for more information.
+
 ## v2.7.0.beta1 (2024-09-06)
 
 * Added support for the new risk reasons outputs in minFraud Factors. The risk

diff --git a/lib/minfraud/model/factors.rb b/lib/minfraud/model/factors.rb
@@ -21,6 +21,7 @@ class Factors < Insights
       # that are used to calculate the overall risk score.
       #
       # @return [Minfraud::Model::Subscores]
+      # @deprecated Use {::risk_score_reasons} instead.
       attr_reader :subscores
 
       # @!visibility private

diff --git a/lib/minfraud/model/subscores.rb b/lib/minfraud/model/subscores.rb
@@ -5,6 +5,8 @@
 module Minfraud
   module Model
     # Score for risk factors that are used in calculating the riskScore.
+    #
+    # @deprecated Use {RiskScoreReason} instead.
     class Subscores < Abstract
       # The risk associated with the AVS result. If present, this is a value in
       # the range 0.01 to 99.