Merge pull request #522 from maxmind/pcronin/updates

Custom rule label, minFraud "test" action, and 3DS result added

Author: kevcenteno

.husky/_/husky.sh

@@ -23,8 +23,7 @@ if [ -z "$husky_skip_init" ]; then
 
   if [ $exitCode != 0 ]; then
     echo "husky - $hook_name hook exited with code $exitCode (error)"
-    exit $exitCode
   fi
 
-  exit 0
+  exit $exitCode
 fi

CHANGELOG.md

@@ -1,6 +1,21 @@
 CHANGELOG
 =========
 
+4.3.0
+
+* Added support for the new `test` disposition action.
+* Added support for the `/disposition/rule_label` output in Score, Insights and
+  Factors. This is available at `response.disposition.ruleLabel()`, and is the
+  label of the custom rule that was triggered by the transaction.
+* Added support for the `/credit_card/was_3d_secure_successful` input in Score,
+  Insights and Factors. The input should indicate whether or not the outcome of
+  3D-Secure verification (e.g. Safekey, SecureCode, Verified by Visa) was
+  successful. `true` if customer verification was successful, or `false` if the
+  customer failed verification. If 3-D Secure verification was not used, was
+  unavailable, or resulted in another outcome other than success or failure, do
+  not include this field. Use the `was3DSecureSuccessful` property in a call to
+  `new minFraud.CreditCard()` to set it.
+
 4.2.0 (2021-08-18)
 ------------------
 

README.md

@@ -218,6 +218,7 @@ try {
       issuerIdNumber: '411111',
       last4digits: '1234',
       token: 'a_token',
+      was3DSecureSuccessful: true,
     }),
     order: new minFraud.Order({
       affiliateId: 'robotnet',

fixtures/insights.json

@@ -205,7 +205,8 @@
 
       "disposition": {
         "action": "accept",
-        "reason": "default"
+        "reason": "default",
+        "rule_label": "the label"
       },
 
       "warnings": [

fixtures/score.json

@@ -19,7 +19,8 @@
 
       "disposition": {
         "action": "accept",
-        "reason": "default"
+        "reason": "default",
+        "rule_label": "the label"
       },
 
       "warnings": [
@@ -42,7 +43,8 @@
 
       "disposition": {
         "action": "accept",
-        "reason": "default"
+        "reason": "default",
+        "rule_label": "the label"
       }
     },
     "noDisposition": {
@@ -55,6 +57,29 @@
         "risk": 0.01
       },
 
+      "warnings": [
+        {
+          "code": "INPUT_INVALID",
+          "warning": "Encountered value at /shipping/city that does not meet the required constraints",
+          "input_pointer": "/shipping/city"
+        }
+      ]
+    },
+    "noDispositionRuleLabel": {
+      "id": "5bc5d6c2-b2c8-40af-87f4-6d61af86b6ae",
+      "risk_score": 0.01,
+      "funds_remaining": 25.0,
+      "queries_remaining": 5000,
+
+      "ip_address": {
+        "risk": 0.01
+      },
+
+      "disposition": {
+        "action": "accept",
+        "reason": "default"
+      },
+
       "warnings": [
         {
           "code": "INPUT_INVALID",

src/request/credit-card.spec.ts

@@ -32,7 +32,7 @@ describe('CreditCard()', () => {
     ${'token is not all digits'}                        | ${{ token: 'a7f6%gf83fhAu' }}
     ${'token is non-space and printable'}               | ${{ token: 'valid_token' }}
     ${'token is a number with more than 19 characters'} | ${{ token: '12345678901234567890' }}
-  `('does not thrown an error if $condition', ({ val }) => {
+  `('does not throw an error if $condition', ({ val }) => {
     expect(() => new CreditCard(val)).not.toThrow();
   });
 
@@ -45,6 +45,7 @@ describe('CreditCard()', () => {
           issuerIdNumber: '411111',
           last4digits: '1234',
           token: 'valid_token',
+          was3DSecureSuccessful: true,
         })
     ).not.toThrow();
   });

src/request/credit-card.ts

@@ -38,6 +38,15 @@ interface CreditCardProps {
    * The card verification value (CVV) code as provided by the payment processor.
    */
   cvvResult?: string;
+  /**
+   * Whether or not the outcome of 3D-Secure verification (e.g. Safekey,
+   * SecureCode, Verified by Visa) was successful as provided by the end user.
+   * `true` if customer verification was successful, or `false` if the customer
+   * failed verification. If 3-D Secure verification was not used, was
+   * unavailable, or resulted in another outcome other than success or failure,
+   * do not set this property.
+   */
+  was3DSecureSuccessful?: boolean;
 }
 
 const singleChar = /^[A-Za-z0-9]$/;
@@ -65,6 +74,8 @@ export default class CreditCard implements CreditCardProps {
   public avsResult?: string;
   /** @inheritDoc CreditCardProps.cvvResult */
   public cvvResult?: string;
+  /** @inheritDoc CreditCardProps.was3DSecureSuccessful */
+  public was3DSecureSuccessful?: boolean;
 
   public constructor(creditCard: CreditCardProps) {
     if (

src/response/models/score.ts

@@ -42,7 +42,9 @@ export default class Score {
   public readonly warnings?: records.Warning[];
 
   public constructor(response: webRecords.ScoreResponse) {
-    this.disposition = response.disposition as records.Disposition;
+    this.disposition = camelizeResponse(
+      response.disposition
+    ) as records.Disposition;
     this.fundsRemaining = response.funds_remaining;
     this.id = response.id;
     this.ipAddress = response.ip_address;

src/response/records.ts

@@ -94,10 +94,11 @@ export interface CreditCardIssuer {
    */
   readonly name: string;
   /**
-   * This property is `true` if the name matches the name provided in the request
-   * for the card issuer. It is `false` if the name does not match. The property
-   * is `null` if either no name or no issuer ID number (IIN) was provided in the
-   * request or if MaxMind does not have a name associated with the IIN.
+   * This property is `true` if the name matches the name provided in the
+   * request for the card issuer. It is `false` if the name does not match. The
+   * property is `null` if either no name or no issuer ID number (IIN) was
+   * provided in the request or if MaxMind does not have a name associated with
+   * the IIN.
    */
   readonly matchesProvidedName?: boolean;
   /**
@@ -107,9 +108,9 @@ export interface CreditCardIssuer {
   readonly phoneNumber: string;
   /**
    * This property is `true` if the phone number matches the number provided in
-   * the request for the card issuer. It is `false` if the number does not match.
-   * It is `null` if either no phone number or no issuer ID number(IIN) was
-   * provided in the request or if MaxMind does not have a phone number
+   * the request for the card issuer. It is `false` if the number does not
+   * match. It is `null` if either no phone number or no issuer ID number (IIN)
+   * was provided in the request or if MaxMind does not have a phone number
    * associated with the IIN.
    */
   readonly matchesProvidedPhoneNumber?: boolean;
@@ -194,7 +195,8 @@ export interface Device {
 }
 
 /**
- * This object contains information about the email address domain passed in the request.
+ * This object contains information about the email address domain passed in the
+ * request.
  */
 export interface EmailDomain {
   /**
@@ -204,7 +206,8 @@ export interface EmailDomain {
 }
 
 /**
- * This object contains information about the email address passed in the request.
+ * This object contains information about the email address passed in the
+ * request.
  */
 export interface Email {
   /**
@@ -247,9 +250,9 @@ export interface ShippingAddress {
   readonly isHighRisk: boolean;
   /**
    * This property is `true` if the postal code provided with the address is in
-   * the city for the address.The property is `false` when the postal code is not
-   * in the city. If the address was not provided or could not be parsed, the
-   * property will be `null`.
+   * the city for the address. The property is `false` when the postal code is
+   * not in the city. If the address was not provided or could not be parsed,
+   * the property will be `null`.
    */
   readonly isPostalInCity?: boolean;
   /**
@@ -269,9 +272,9 @@ export interface ShippingAddress {
    */
   readonly distanceToBillingAddress: number;
   /**
-   * This property is `true` if the address is in the IP country.The property is
-   * `false` when the address is not in the IP country. If the address could not
-   * be parsed or was not provided or if the IP address could not be
+   * This property is `true` if the address is in the IP country. The property
+   * is `false` when the address is not in the IP country. If the address could
+   * not be parsed or was not provided or if the IP address could not be
    * geolocated, the property will be `null`.
    */
   readonly isInIpCountry?: boolean;
@@ -280,9 +283,9 @@ export interface ShippingAddress {
 export interface BillingAddress {
   /**
    * This property is `true` if the postal code provided with the address is in
-   * the city for the address.The property is `false` when the postal code is not
-   * in the city. If the address was not provided or could not be parsed, the
-   * property will be `null`.
+   * the city for the address. The property is `false` when the postal code is
+   * not in the city. If the address was not provided or could not be parsed,
+   * the property will be `null`.
    */
   readonly isPostalInCity?: boolean;
   /**
@@ -298,9 +301,9 @@ export interface BillingAddress {
    */
   readonly distanceToIpLocation: number;
   /**
-   * This property is `true` if the address is in the IP country.The property is
-   * `false` when the address is not in the IP country. If the address could not
-   * be parsed or was not provided or if the IP address could not be
+   * This property is `true` if the address is in the IP country. The property
+   * is `false` when the address is not in the IP country. If the address could
+   * not be parsed or was not provided or if the IP address could not be
    * geolocated, the property will be `null`.
    */
   readonly isInIpCountry?: boolean;
@@ -312,8 +315,8 @@ export interface BillingAddress {
 export interface Disposition {
   /**
    * The action to take on the transaction as defined by your custom rules. The
-   * current set of values are "accept", "manual_review", and "reject". If you
-   * do not have custom rules set up, `null` will be returned.
+   * current set of values are "accept", "manual_review", "reject", and "test".
+   * If you do not have custom rules set up, `null` will be returned.
    */
   readonly action: DispositionAction;
   /**
@@ -322,6 +325,12 @@ export interface Disposition {
    * will be returned.
    */
   readonly reason: DispositionReason;
+  /**
+   * The label of the custom rule that was triggered. If you do not have custom
+   * rules set up, the triggered custom rule does not have a label, or no custom
+   * rule was triggered, `null` will be returned.
+   */
+  readonly ruleLabel?: string;
 }
 
 /**
@@ -352,7 +361,7 @@ export interface Subscores {
   readonly browser?: number;
   /**
    * Individualized risk of chargeback for the given IP address on your account
-   * and shop ID.This is only available to users sending chargeback data to
+   * and shop ID. This is only available to users sending chargeback data to
    * MaxMind. If present, this is a value in the range 0.01 to 99.
    */
   readonly chargeback?: number;

src/response/web-records.ts

@@ -104,13 +104,14 @@ export interface BillingAddressWebRecord {
   readonly is_in_ip_country?: boolean;
 }
 
-export type DispositionAction = 'accept' | 'reject' | 'manual_review';
+export type DispositionAction = 'accept' | 'reject' | 'manual_review' | 'test';
 
 export type DispositionReason = 'default' | 'custom_rule';
 
 export interface DispositionWebRecord {
   readonly action: DispositionAction;
   readonly reason: DispositionReason;
+  readonly rule_label?: string;
 }
 
 export interface SubscoresWebRecord {