Merge pull request #666 from recurly/v3-v2021-02-25-7561215547

Generated Latest Changes for v2021-02-25

Author: douglasmiller

openapi/api.yaml

@@ -19422,16 +19422,19 @@ components:
             Integer paired with `Net Terms Type` and representing the number
             of days past the current date (for `net` Net Terms Type) or days after
             the last day of the current month (for `eom` Net Terms Type) that the
-            invoice will become past due. For any value, an additional 24 hours is
+            invoice will become past due. For `manual` collection method, an additional 24 hours is
             added to ensure the customer has the entire last day to make payment before
-            becoming past due.  For example:
+            becoming past due. For example:
 
             If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
             If an invoice is due `net 30`, it will become past due at 31 days exactly.
             If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+            For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
             When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:
@@ -19617,16 +19620,19 @@ components:
             Integer paired with `Net Terms Type` and representing the number
             of days past the current date (for `net` Net Terms Type) or days after
             the last day of the current month (for `eom` Net Terms Type) that the
-            invoice will become past due. For any value, an additional 24 hours is
+            invoice will become past due. For `manual` collection method, an additional 24 hours is
             added to ensure the customer has the entire last day to make payment before
-            becoming past due.  For example:
+            becoming past due. For example:
 
             If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
             If an invoice is due `net 30`, it will become past due at 31 days exactly.
             If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+            For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
             When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:
@@ -21733,16 +21739,19 @@ components:
             Integer paired with `Net Terms Type` and representing the number
             of days past the current date (for `net` Net Terms Type) or days after
             the last day of the current month (for `eom` Net Terms Type) that the
-            invoice will become past due. For any value, an additional 24 hours is
+            invoice will become past due. For `manual` collection method, an additional 24 hours is
             added to ensure the customer has the entire last day to make payment before
-            becoming past due.  For example:
+            becoming past due. For example:
 
             If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
             If an invoice is due `net 30`, it will become past due at 31 days exactly.
             If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+            For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
             When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:
@@ -22314,7 +22323,8 @@ components:
             month (for `eom` Net Terms Type) that the invoice will become past due. During a subscription
             change, it's not necessary to provide both the `Net Terms Type` and `Net Terms` parameters.
 
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:
@@ -22527,16 +22537,19 @@ components:
             Integer paired with `Net Terms Type` and representing the number
             of days past the current date (for `net` Net Terms Type) or days after
             the last day of the current month (for `eom` Net Terms Type) that the
-            invoice will become past due. For any value, an additional 24 hours is
+            invoice will become past due. For `manual` collection method, an additional 24 hours is
             added to ensure the customer has the entire last day to make payment before
-            becoming past due.  For example:
+            becoming past due. For example:
 
             If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
             If an invoice is due `net 30`, it will become past due at 31 days exactly.
             If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+            For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
             When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:
@@ -22720,16 +22733,19 @@ components:
             Integer paired with `Net Terms Type` and representing the number
             of days past the current date (for `net` Net Terms Type) or days after
             the last day of the current month (for `eom` Net Terms Type) that the
-            invoice will become past due. For any value, an additional 24 hours is
+            invoice will become past due. For `manual` collection method, an additional 24 hours is
             added to ensure the customer has the entire last day to make payment before
-            becoming past due.  For example:
+            becoming past due. For example:
 
             If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
             If an invoice is due `net 30`, it will become past due at 31 days exactly.
             If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+            For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
             When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:
@@ -23154,6 +23170,44 @@ components:
             For all other countries this will come from the VAT Number field in the
             Billing Info.
           title: VAT Number
+        fraud_info:
+          "$ref": "#/components/schemas/TransactionFraudInfo"
+    TransactionFraudInfo:
+      type: object
+      title: Fraud information
+      readOnly: true
+      properties:
+        object:
+          type: string
+          title: Object type
+          readOnly: true
+        score:
+          type: integer
+          title: Kount score
+          minimum: 1
+          maximum: 99
+        decision:
+          title: Kount decision
+          maxLength: 10
+          "$ref": "#/components/schemas/KountDecisionEnum"
+        reference:
+          type: string
+          title: Kount transaction reference ID
+        risk_rules_triggered:
+          type: array
+          title: Risk Rules Triggered
+          description: A list of fraud risk rules that were triggered for the transaction.
+          items:
+            "$ref": "#/components/schemas/FraudRiskRule"
+    FraudRiskRule:
+      type: object
+      properties:
+        code:
+          type: string
+          title: The Kount rule number.
+        message:
+          type: string
+          title: Description of why the rule was triggered
     ExternalTransaction:
       type: object
       properties:
@@ -23457,16 +23511,19 @@ components:
             Integer paired with `Net Terms Type` and representing the number
             of days past the current date (for `net` Net Terms Type) or days after
             the last day of the current month (for `eom` Net Terms Type) that the
-            invoice will become past due. For any value, an additional 24 hours is
+            invoice will become past due. For `manual` collection method, an additional 24 hours is
             added to ensure the customer has the entire last day to make payment before
-            becoming past due.  For example:
+            becoming past due. For example:
 
             If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
             If an invoice is due `net 30`, it will become past due at 31 days exactly.
             If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+            For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
             When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-            For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+            For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+            or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
           minimum: 0
           default: 0
         net_terms_type:

recurly/resources.py

@@ -700,6 +700,8 @@ class Transaction(Resource):
         Language code for the message
     cvv_check : str
         When processed, result from checking the CVV/CVC value on the transaction.
+    fraud_info : TransactionFraudInfo
+        Fraud information
     gateway_approval_code : str
         Transaction approval code from the payment gateway.
     gateway_message : str
@@ -776,6 +778,7 @@ class Transaction(Resource):
         "customer_message": str,
         "customer_message_locale": str,
         "cvv_check": str,
+        "fraud_info": "TransactionFraudInfo",
         "gateway_approval_code": str,
         "gateway_message": str,
         "gateway_reference": str,
@@ -893,6 +896,47 @@ class TransactionPaymentGateway(Resource):
     }
 
 
+class TransactionFraudInfo(Resource):
+    """
+    Attributes
+    ----------
+    decision : str
+        Kount decision
+    object : str
+        Object type
+    reference : str
+        Kount transaction reference ID
+    risk_rules_triggered : :obj:`list` of :obj:`FraudRiskRule`
+        A list of fraud risk rules that were triggered for the transaction.
+    score : int
+        Kount score
+    """
+
+    schema = {
+        "decision": str,
+        "object": str,
+        "reference": str,
+        "risk_rules_triggered": ["FraudRiskRule"],
+        "score": int,
+    }
+
+
+class FraudRiskRule(Resource):
+    """
+    Attributes
+    ----------
+    code : str
+        The Kount rule number.
+    message : str
+        Description of why the rule was triggered
+    """
+
+    schema = {
+        "code": str,
+        "message": str,
+    }
+
+
 class CouponRedemption(Resource):
     """
     Attributes
@@ -1409,16 +1453,19 @@ class Invoice(Resource):
         Integer paired with `Net Terms Type` and representing the number
         of days past the current date (for `net` Net Terms Type) or days after
         the last day of the current month (for `eom` Net Terms Type) that the
-        invoice will become past due. For any value, an additional 24 hours is
+        invoice will become past due. For `manual` collection method, an additional 24 hours is
         added to ensure the customer has the entire last day to make payment before
-        becoming past due.  For example:
+        becoming past due. For example:
 
         If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
         If an invoice is due `net 30`, it will become past due at 31 days exactly.
         If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+        For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
         When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-        For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+        For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+        or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
     net_terms_type : str
         Optionally supplied string that may be either `net` or `eom` (end-of-month).
         When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date.
@@ -1914,16 +1961,19 @@ class Subscription(Resource):
         Integer paired with `Net Terms Type` and representing the number
         of days past the current date (for `net` Net Terms Type) or days after
         the last day of the current month (for `eom` Net Terms Type) that the
-        invoice will become past due. For any value, an additional 24 hours is
+        invoice will become past due. For `manual` collection method, an additional 24 hours is
         added to ensure the customer has the entire last day to make payment before
-        becoming past due.  For example:
+        becoming past due. For example:
 
         If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.
         If an invoice is due `net 30`, it will become past due at 31 days exactly.
         If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.
 
+        For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.
         When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.
-        For more information please visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+
+        For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)
+        or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.
     net_terms_type : str
         Optionally supplied string that may be either `net` or `eom` (end-of-month).
         When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date.