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

Deprecate Factors subscores
maxmind · Oct 24, 2024 · 3d604b1 · 3d604b1
2 parents 878fdb1 + 1f666d2
commit 3d604b1
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -3,6 +3,13 @@
 History
 -------
 
+2.12.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.
+
 2.12.0b1 (2024-09-06)
 +++++++++++++++++++++
 

diff --git a/minfraud/models.py b/minfraud/models.py
@@ -863,6 +863,9 @@ def _create_warnings(warnings: List[Dict[str, str]]) -> Tuple[ServiceWarning, ..
 class Subscores:
     """Risk factor scores used in calculating the overall risk score.
 
+    .. deprecated:: 2.12.0
+      Use RiskScoreReason instead.
+
     .. attribute:: avs_result
 
       The risk associated with the AVS result. If present, this is a value
@@ -1329,6 +1332,9 @@ class Factors:
       individual risk factors that are used to calculate the overall risk
       score.
 
+      .. deprecated:: 2.12.0
+        Use RiskScoreReason instead.
+
     .. attribute:: risk_score_reasons
 
       This tuple contains :class:`.RiskScoreReason` objects that describe