Record Class InsightsResponse

java.lang.Object

java.lang.Record

com.maxmind.minfraud.response.InsightsResponse

Record Components:

billingAddress - The BillingAddress model object.

billingPhone - The Phone model object for the billing phone number.

creditCard - The CreditCard model object.

device - The Device model object.

disposition - The disposition set by your custom rules.

email - The Email model object.

fundsRemaining - The approximate US dollar value of the funds remaining on your MaxMind account.

id - This is a UUID that identifies the minFraud request.

ipAddress - The IpAddress model object.

queriesRemaining - The approximate number of queries remaining for this service before your account runs out of funds.

riskScore - This returns the risk score, from 0.01 to 99. A higher score indicates a higher risk of fraud. For example, a score of 20 indicates a 20% chance that a transaction is fraudulent. We never return a risk score of 0, since all transactions have the possibility of being fraudulent. Likewise, we never return a risk score of 100.

shippingAddress - The ShippingAddress model object.

shippingPhone - The Phone model object for the shipping phone number.

warnings - An unmodifiable list containing warning objects that detail issues with the request such as invalid or unknown inputs. It is highly recommended that you check this list for issues when integrating the web service.

All Implemented Interfaces:

JsonSerializable

public record InsightsResponse(BillingAddress billingAddress, Phone billingPhone, CreditCard creditCard, Device device, Disposition disposition, Email email, Double fundsRemaining, UUID id, IpAddress ipAddress, Integer queriesRemaining, Double riskScore, ShippingAddress shippingAddress, Phone shippingPhone, List<Warning> warnings)
extends Record
implements JsonSerializable

This class provides a model for the minFraud Insights response.

Constructor Summary

Constructors

Constructor	Description
InsightsResponse()	Constructs an instance of InsightsResponse with no data.
InsightsResponse(BillingAddress billingAddress, Phone billingPhone, CreditCard creditCard, Device device, Disposition disposition, Email email, Double fundsRemaining, UUID id, IpAddress ipAddress, Integer queriesRemaining, Double riskScore, ShippingAddress shippingAddress, Phone shippingPhone, List<Warning> warnings)	Compact canonical constructor that sets defaults for null values.

Method Summary

Modifier and Type	Method	Description
BillingAddress	billingAddress()	Returns the value of the billingAddress record component.
Phone	billingPhone()	Returns the value of the billingPhone record component.
CreditCard	creditCard()	Returns the value of the creditCard record component.
Device	device()	Returns the value of the device record component.
Disposition	disposition()	Returns the value of the disposition record component.
Email	email()	Returns the value of the email record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Double	fundsRemaining()	Returns the value of the fundsRemaining record component.
BillingAddress	getBillingAddress()	Deprecated, for removal: This API element is subject to removal in a future version. Use billingAddress() instead.
Phone	getBillingPhone()	Deprecated, for removal: This API element is subject to removal in a future version. Use billingPhone() instead.
CreditCard	getCreditCard()	Deprecated, for removal: This API element is subject to removal in a future version. Use creditCard() instead.
Device	getDevice()	Deprecated, for removal: This API element is subject to removal in a future version. Use device() instead.
Disposition	getDisposition()	Deprecated, for removal: This API element is subject to removal in a future version. Use disposition() instead.
Email	getEmail()	Deprecated, for removal: This API element is subject to removal in a future version. Use email() instead.
Double	getFundsRemaining()	Deprecated, for removal: This API element is subject to removal in a future version. Use fundsRemaining() instead.
UUID	getId()	Deprecated, for removal: This API element is subject to removal in a future version. Use id() instead.
IpAddress	getIpAddress()	Deprecated, for removal: This API element is subject to removal in a future version. Use ipAddress() instead.
Integer	getQueriesRemaining()	Deprecated, for removal: This API element is subject to removal in a future version. Use queriesRemaining() instead.
Double	getRiskScore()	Deprecated, for removal: This API element is subject to removal in a future version. Use riskScore() instead.
ShippingAddress	getShippingAddress()	Deprecated, for removal: This API element is subject to removal in a future version. Use shippingAddress() instead.
Phone	getShippingPhone()	Deprecated, for removal: This API element is subject to removal in a future version. Use shippingPhone() instead.
List<Warning>	getWarnings()	Deprecated, for removal: This API element is subject to removal in a future version. Use warnings() instead.
final int	hashCode()	Returns a hash code value for this object.
UUID	id()	Returns the value of the id record component.
IpAddress	ipAddress()	Returns the value of the ipAddress record component.
Integer	queriesRemaining()	Returns the value of the queriesRemaining record component.
Double	riskScore()	Returns the value of the riskScore record component.
ShippingAddress	shippingAddress()	Returns the value of the shippingAddress record component.
Phone	shippingPhone()	Returns the value of the shippingPhone record component.
final String	toString()	Returns a string representation of this record class.
List<Warning>	warnings()	Returns the value of the warnings record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface JsonSerializable

toJson

Constructor Details

InsightsResponse

public InsightsResponse(BillingAddress billingAddress,
 Phone billingPhone,
 CreditCard creditCard,
 Device device,
 Disposition disposition,
 Email email,
 Double fundsRemaining,
 UUID id,
 IpAddress ipAddress,
 Integer queriesRemaining,
 Double riskScore,
 ShippingAddress shippingAddress,
 Phone shippingPhone,
 List<Warning> warnings)

Compact canonical constructor that sets defaults for null values.

InsightsResponse

public InsightsResponse()

Constructs an instance of InsightsResponse with no data.

Method Details

getBillingAddress

@Deprecated(since="4.0.0",
            forRemoval=true)
public BillingAddress getBillingAddress()

Deprecated, for removal: This API element is subject to removal in a future version.

Use billingAddress() instead. This method will be removed in 5.0.0.

Returns:

The BillingAddress model object.

getBillingPhone

@Deprecated(since="4.0.0",
            forRemoval=true)
public Phone getBillingPhone()

Deprecated, for removal: This API element is subject to removal in a future version.

Use billingPhone() instead. This method will be removed in 5.0.0.

Returns:

The Phone model object for the billing phone number.

getCreditCard

@Deprecated(since="4.0.0",
            forRemoval=true)
public CreditCard getCreditCard()

Deprecated, for removal: This API element is subject to removal in a future version.

Use creditCard() instead. This method will be removed in 5.0.0.

Returns:

The CreditCard model object.

getDevice

@Deprecated(since="4.0.0",
            forRemoval=true)
public Device getDevice()

Deprecated, for removal: This API element is subject to removal in a future version.

Use device() instead. This method will be removed in 5.0.0.

Returns:

The Device model object.

getDisposition

@Deprecated(since="4.0.0",
            forRemoval=true)
public Disposition getDisposition()

Deprecated, for removal: This API element is subject to removal in a future version.

Use disposition() instead. This method will be removed in 5.0.0.

Returns:

The disposition set by your custom rules.

getEmail

@Deprecated(since="4.0.0",
            forRemoval=true)
public Email getEmail()

Deprecated, for removal: This API element is subject to removal in a future version.

Use email() instead. This method will be removed in 5.0.0.

Returns:

The Email model object.

getFundsRemaining

@Deprecated(since="4.0.0",
            forRemoval=true)
public Double getFundsRemaining()

Deprecated, for removal: This API element is subject to removal in a future version.

Use fundsRemaining() instead. This method will be removed in 5.0.0.

Returns:

The approximate US dollar value of the funds remaining on your MaxMind account.

getId

@Deprecated(since="4.0.0",
            forRemoval=true)
public UUID getId()

Deprecated, for removal: This API element is subject to removal in a future version.

Use id() instead. This method will be removed in 5.0.0.

Returns:

This is a UUID that identifies the minFraud request.

getIpAddress

@Deprecated(since="4.0.0",
            forRemoval=true)
public IpAddress getIpAddress()

Deprecated, for removal: This API element is subject to removal in a future version.

Use ipAddress() instead. This method will be removed in 5.0.0.

Returns:

The IpAddress model object.

getQueriesRemaining

@Deprecated(since="4.0.0",
            forRemoval=true)
public Integer getQueriesRemaining()

Deprecated, for removal: This API element is subject to removal in a future version.

Use queriesRemaining() instead. This method will be removed in 5.0.0.

Returns:

The approximate number of queries remaining for this service before your account runs out of funds.

getRiskScore

@Deprecated(since="4.0.0",
            forRemoval=true)
public Double getRiskScore()

Deprecated, for removal: This API element is subject to removal in a future version.

Use riskScore() instead. This method will be removed in 5.0.0.

Returns:

This returns the risk score, from 0.01 to 99. A higher score indicates a higher risk of fraud. For example, a score of 20 indicates a 20% chance that a transaction is fraudulent. We never return a risk score of 0, since all transactions have the possibility of being fraudulent. Likewise, we never return a risk score of 100.

getShippingAddress

@Deprecated(since="4.0.0",
            forRemoval=true)
public ShippingAddress getShippingAddress()

Deprecated, for removal: This API element is subject to removal in a future version.

Use shippingAddress() instead. This method will be removed in 5.0.0.

Returns:

The ShippingAddress model object.

getShippingPhone

@Deprecated(since="4.0.0",
            forRemoval=true)
public Phone getShippingPhone()

Deprecated, for removal: This API element is subject to removal in a future version.

Use shippingPhone() instead. This method will be removed in 5.0.0.

Returns:

The Phone model object for the shipping phone number.

getWarnings

@Deprecated(since="4.0.0",
            forRemoval=true)
public List<Warning> getWarnings()

Deprecated, for removal: This API element is subject to removal in a future version.

Use warnings() instead. This method will be removed in 5.0.0.

Returns:

An unmodifiable list containing warning objects that detail issues with the request such as invalid or unknown inputs. It is highly recommended that you check this list for issues when integrating the web service.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

billingAddress

public BillingAddress billingAddress()

Returns the value of the billingAddress record component.

Returns:

the value of the billingAddress record component

billingPhone

public Phone billingPhone()

Returns the value of the billingPhone record component.

Returns:

the value of the billingPhone record component

creditCard

public CreditCard creditCard()

Returns the value of the creditCard record component.

Returns:

the value of the creditCard record component

device

public Device device()

Returns the value of the device record component.

Returns:

the value of the device record component

disposition

public Disposition disposition()

Returns the value of the disposition record component.

Returns:

the value of the disposition record component

email

public Email email()

Returns the value of the email record component.

Returns:

the value of the email record component

fundsRemaining

public Double fundsRemaining()

Returns the value of the fundsRemaining record component.

Returns:

the value of the fundsRemaining record component

id

public UUID id()

Returns the value of the id record component.

Returns:

the value of the id record component

ipAddress

public IpAddress ipAddress()

Returns the value of the ipAddress record component.

Returns:

the value of the ipAddress record component

queriesRemaining

public Integer queriesRemaining()

Returns the value of the queriesRemaining record component.

Returns:

the value of the queriesRemaining record component

riskScore

public Double riskScore()

Returns the value of the riskScore record component.

Returns:

the value of the riskScore record component

shippingAddress

public ShippingAddress shippingAddress()

Returns the value of the shippingAddress record component.

Returns:

the value of the shippingAddress record component

shippingPhone

public Phone shippingPhone()

Returns the value of the shippingPhone record component.

Returns:

the value of the shippingPhone record component

warnings

public List<Warning> warnings()

Returns the value of the warnings record component.

Returns:

the value of the warnings record component