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

oschwald · web-flow · commit b1c4e28d77cd · 2024-10-24T07:24:59.000-07:00
Deprecate Factors subscores
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+7.1.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.
+
 7.1.0-beta.1 (2024-09-06)
 -------------------------
 
diff --git a/src/response/models/factors.ts b/src/response/models/factors.ts
@@ -13,6 +13,8 @@ export default class Factors extends Insights {
   /**
    * An object containing GeoIP2 and minFraud Insights information about the IP
    * address.
+   *
+   * @deprecated replaced by {@link riskScoreReasons}.
    */
   public readonly subscores: records.Subscores;
 
diff --git a/src/response/records.ts b/src/response/records.ts
@@ -464,6 +464,8 @@ export interface RiskScoreReason {
 /**
  * This object contains scores for many of the individual risk factors that
  * are used to calculate the overall risk score.
+ *
+ * @deprecated replaced by {@link RiskScoreReason}.
  */
 export interface Subscores {
   /**
