Merge pull request #182 from maxmind/greg/deprecate-subscores

Deprecate Factors subscores
maxmind · Oct 24, 2024 · 3e144bd · 3e144bd
2 parents 2da7473 + 8e2bb27
commit 3e144bd
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+3.2.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.
+
 3.2.0-beta.1 (2024-09-06)
 -------------------------
 

diff --git a/src/MinFraud/Model/Factors.php b/src/MinFraud/Model/Factors.php
@@ -23,6 +23,8 @@ class Factors extends Insights
      * @var Subscores an object containing scores for many of the individual
      *                risk factors that are used to calculate the overall risk
      *                score
+     *
+     * @deprecated use riskScoreReasons instead
      */
     public readonly Subscores $subscores;
 

diff --git a/src/MinFraud/Model/Subscores.php b/src/MinFraud/Model/Subscores.php
@@ -6,6 +6,8 @@
 
 /**
  * The scores for risk factors that are used in calculating the riskScore.
+ *
+ * @deprecated use RiskScoreReason instead
  */
 class Subscores implements \JsonSerializable
 {