Skip to content

Commit 526ace9

Browse files
committed
Update risk factor naming in documentation
1 parent feea199 commit 526ace9

2 files changed

Lines changed: 22 additions & 21 deletions

File tree

src/main/java/com/maxmind/minfraud/response/FactorsResponse.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ public FactorsResponse(
3434
}
3535

3636
/**
37-
* @return The {@code Subscores} model object.
37+
* @return The {@code Subscores} model object containing the risk factor
38+
* scores.
3839
*/
3940
@JsonProperty("subscores")
4041
public Subscores getSubscores() {

src/main/java/com/maxmind/minfraud/response/Subscores.java

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
import com.fasterxml.jackson.annotation.JsonProperty;
44

55
/**
6-
* This class contains subscores for many of the individual components that are
7-
* used to calculate the overall risk score.
6+
* This class contains scores for many of the risk factors that are used to
7+
* calculate the overall risk score.
88
*/
99
public final class Subscores {
1010
private final Double avsResult;
@@ -27,24 +27,24 @@ public final class Subscores {
2727
private final Double timeOfDay;
2828

2929
/**
30-
* @param avsResult The AVS result subscore.
31-
* @param billingAddress The billing address subscore.
32-
* @param billingAddressDistanceToIpLocation The billing address distance to the IP location subscore.
33-
* @param browser The browser subscore.
34-
* @param chargeback The chargeback subscore.
35-
* @param country The country subscore.
36-
* @param countryMismatch The country mismatch subscore.
37-
* @param cvvResult The CVV result subscore.
38-
* @param device The device subscore..
39-
* @param emailAddress The email address subscore.
40-
* @param emailDomain The email domain subscore.
41-
* @param emailLocalPart The subscore for the local part of the email.
42-
* @param issuerIdNumber The IIN subscore.
43-
* @param orderAmount The order amount subscore.
44-
* @param phoneNumber The phone number subscore.
45-
* @param shippingAddress The shipping addresss subscore.
46-
* @param shippingAddressDistanceToIpLocation The shipping address distance to IP location subscore.
47-
* @param timeOfDay The time of day subscore.
30+
* @param avsResult The AVS result risk factor score.
31+
* @param billingAddress The billing address risk factor score.
32+
* @param billingAddressDistanceToIpLocation The billing address distance to the IP location risk factor score.
33+
* @param browser The browser risk factor score.
34+
* @param chargeback The chargeback risk factor score.
35+
* @param country The country risk factor score.
36+
* @param countryMismatch The country mismatch risk factor score.
37+
* @param cvvResult The CVV result risk factor score.
38+
* @param device The device risk factor score..
39+
* @param emailAddress The email address risk factor score.
40+
* @param emailDomain The email domain risk factor score.
41+
* @param emailLocalPart The risk factor score for the local part of the email.
42+
* @param issuerIdNumber The IIN risk factor score.
43+
* @param orderAmount The order amount risk factor score.
44+
* @param phoneNumber The phone number risk factor score.
45+
* @param shippingAddress The shipping addresss risk factor score.
46+
* @param shippingAddressDistanceToIpLocation The shipping address distance to IP location risk factor score.
47+
* @param timeOfDay The time of day risk factor score.
4848
*/
4949
public Subscores(
5050
@JsonProperty("avs_result") Double avsResult,

0 commit comments

Comments
 (0)