4.14.0

braintreeps · braintreeps · commit 9b58e54eee72 · 2022-02-17T20:40:04.000Z
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -4,6 +4,7 @@
 
 - [ ] Added changelog entry
 - [ ] Ran unit tests (`nosetests tests/unit`)
+- [ ] I understand that unless this is a Draft PR or has a DO NOT MERGE label, this PR is considered to be in a deploy ready state and can be deployed if merged to main
 
 <!-- **For Braintree Developers only, don't forget:**
 - [ ] Does this change require work to be done to the GraphQL API? If you have questions check with the GraphQL team.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+## 4.14.0
+* Add `PaymentMethodCustomerDataUpdated` webhook
+
 ## 4.13.0
 * Add plan create/update/find API endpoint
 * Add `TransactionReview` webhook notification
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ _The Python core development community has released [End-of-Life branches](https
 
 ## Versions
 
-Braintree employs a deprecation policy for our SDKs. For more information on the statuses of an SDK check our [developer docs](http://developers.braintreepayments.com/reference/general/server-sdk-deprecation-policy).
+Braintree employs a deprecation policy for our SDKs. For more information on the statuses of an SDK check our [developer docs](https://developer.paypal.com/braintree/docs/reference/general/server-sdk-deprecation-policy).
 
 | Major version number | Status | Released | Deprecated | Unsupported |
 | -------------------- | ------ | -------- | ---------- | ----------- |
@@ -24,9 +24,9 @@ Braintree employs a deprecation policy for our SDKs. For more information on the
 
 ## Documentation
 
- * [Official documentation](https://developers.braintreepayments.com/ios+python/start/hello-server)
+ * [Official documentation](https://developer.paypal.com/braintree/docs/start/hello-server/python)
 
-Updating from an Inactive, Deprecated, or Unsupported version of this SDK? Check our [Migration Guide](https://developers.braintreepayments.com/reference/general/server-sdk-migration-guide/python) for tips.
+Updating from an Inactive, Deprecated, or Unsupported version of this SDK? Check our [Migration Guide](https://developer.paypal.com/braintree/docs/reference/general/server-sdk-migration-guide/python) for tips.
 
 ## Quick Start Example
 
diff --git a/braintree/__init__.py b/braintree/__init__.py
@@ -28,6 +28,7 @@
 from braintree.discount_gateway import DiscountGateway
 from braintree.dispute import Dispute
 from braintree.dispute_search import DisputeSearch
+from braintree.enriched_customer_data import EnrichedCustomerData
 from braintree.environment import Environment
 from braintree.error_codes import ErrorCodes
 from braintree.error_result import ErrorResult
@@ -41,6 +42,7 @@
 from braintree.partner_merchant import PartnerMerchant
 from braintree.payment_instrument_type import PaymentInstrumentType
 from braintree.payment_method import PaymentMethod
+from braintree.payment_method_customer_data_updated_metadata import PaymentMethodCustomerDataUpdatedMetadata
 from braintree.payment_method_nonce import PaymentMethodNonce
 from braintree.payment_method_parser import parse_payment_method
 from braintree.paypal_account import PayPalAccount
@@ -70,6 +72,7 @@
 from braintree.unknown_payment_method import UnknownPaymentMethod
 from braintree.validation_error_collection import ValidationErrorCollection
 from braintree.venmo_account import VenmoAccount
+from braintree.venmo_profile_data import VenmoProfileData
 from braintree.version import Version
 from braintree.webhook_notification import WebhookNotification
 from braintree.webhook_notification_gateway import WebhookNotificationGateway
diff --git a/braintree/credit_card.py b/braintree/credit_card.py
@@ -38,7 +38,7 @@ class CreditCard(Resource):
         print(result.credit_card.token)
         print(result.credit_card.masked_number)
 
-    For more information on CreditCards, see https://developers.braintreepayments.com/reference/request/credit-card/create/python
+    For more information on CreditCards, see https://developer.paypal.com/braintree/docs/reference/request/credit-card/create/python
 
     """
     class CardType(object):
diff --git a/braintree/customer.py b/braintree/customer.py
@@ -66,7 +66,7 @@ class Customer(Resource):
         print(result.customer.id)
         print(result.customer.first_name)
 
-    For more information on Customers, see https://developers.braintreepayments.com/reference/request/customer/create/python
+    For more information on Customers, see https://developer.paypal.com/braintree/docs/reference/request/customer/create/python
 
     """
 
diff --git a/braintree/document_upload.py b/braintree/document_upload.py
@@ -17,7 +17,7 @@ class DocumentUpload(Resource):
             }
         )
 
-    For more information on DocumentUploads, see https://developers.braintreepayments.com/reference/request/document_upload/create
+    For more information on DocumentUploads, see https://developer.paypal.com/braintree/docs/reference/request/document-upload/create
 
     """
 
diff --git a/braintree/enriched_customer_data.py b/braintree/enriched_customer_data.py
@@ -0,0 +1,10 @@
+from braintree.resource import Resource
+from braintree.venmo_profile_data import VenmoProfileData
+
+class EnrichedCustomerData(Resource):
+    """
+    A class representing Braintree EnrichedCustomerData object.
+    """
+    def __init__(self, gateway, attributes):
+        Resource.__init__(self, gateway, attributes)
+        self.profile_data = VenmoProfileData(gateway, attributes.pop("profile_data"))
diff --git a/braintree/exceptions/authentication_error.py b/braintree/exceptions/authentication_error.py
@@ -4,6 +4,6 @@ class AuthenticationError(BraintreeError):
     """
     Raised when the client library cannot authenticate with the gateway.  This generally means the public_key/private key are incorrect, or the user is not active.
 
-    See https://developers.braintreepayments.com/reference/general/exceptions/python#authentication-error
+    See https://developer.paypal.com/braintree/docs/reference/general/exceptions/python#authentication-error
     """
     pass
diff --git a/braintree/exceptions/authorization_error.py b/braintree/exceptions/authorization_error.py
@@ -4,6 +4,6 @@ class AuthorizationError(BraintreeError):
     """
     Raised when the user does not have permission to complete the requested operation.
 
-    See https://developers.braintreepayments.com/reference/general/exceptions/python#authorization-error
+    See https://developer.paypal.com/braintree/docs/reference/general/exceptions/python#authorization-error
     """
     pass
diff --git a/braintree/exceptions/not_found_error.py b/braintree/exceptions/not_found_error.py
@@ -4,6 +4,6 @@ class NotFoundError(BraintreeError):
     """
     Raised when an object is not found in the gateway, such as a Transaction.find("bad_id").
 
-    See https://developers.braintreepayments.com/reference/general/exceptions/python#not-found-error
+    See https://developer.paypal.com/braintree/docs/reference/general/exceptions/python#not-found-error
     """
     pass
diff --git a/braintree/exceptions/server_error.py b/braintree/exceptions/server_error.py
@@ -4,6 +4,6 @@ class ServerError(BraintreeError):
     """
     Raised when the gateway raises an error.  Please contact support at support@getbraintree.com.
 
-    See https://developers.braintreepayments.com/reference/general/exceptions/python#server-error
+    See https://developer.paypal.com/braintree/docs/reference/general/exceptions/python#server-error
     """
     pass
diff --git a/braintree/exceptions/upgrade_required_error.py b/braintree/exceptions/upgrade_required_error.py
@@ -4,6 +4,6 @@ class UpgradeRequiredError(BraintreeError):
     """
     Raised for unsupported client library versions.
 
-    See https://developers.braintreepayments.com/reference/general/exceptions/python#upgrade-required-error
+    See https://developer.paypal.com/braintree/docs/reference/general/exceptions/python#upgrade-required-error
     """
     pass
diff --git a/braintree/payment_method_customer_data_updated_metadata.py b/braintree/payment_method_customer_data_updated_metadata.py
@@ -0,0 +1,14 @@
+from braintree.resource import Resource
+from braintree.payment_method_parser import parse_payment_method
+from braintree.enriched_customer_data import EnrichedCustomerData
+
+class PaymentMethodCustomerDataUpdatedMetadata(Resource):
+    """
+    A class representing Braintree PaymentMethodCustomerDataUpdatedMetadata webhook.
+    """
+    def __init__(self, gateway, attributes):
+        Resource.__init__(self, gateway, attributes)
+        self.payment_method = parse_payment_method(gateway, attributes["payment_method"])
+        if attributes["enriched_customer_data"]:
+            self.enriched_customer_data = EnrichedCustomerData(gateway, attributes["enriched_customer_data"])
+
diff --git a/braintree/subscription.py b/braintree/subscription.py
@@ -32,7 +32,7 @@ class Subscription(Resource):
             "trial_period": True
         })
 
-    For more information on Subscriptions, see https://developers.braintreepayments.com/reference/request/subscription/create/python
+    For more information on Subscriptions, see https://developer.paypal.com/braintree/docs/reference/request/subscription/create/python
 
     """
 
diff --git a/braintree/transaction.py b/braintree/transaction.py
@@ -89,7 +89,7 @@ class Transaction(Resource):
         print(result.transaction.amount)
         print(result.transaction.order_id)
 
-    For more information on Transactions, see https://developers.braintreepayments.com/reference/request/transaction/sale/python
+    For more information on Transactions, see https://developer.paypal.com/braintree/docs/reference/request/transaction/sale/python
 
     """
 
diff --git a/braintree/validation_error_collection.py b/braintree/validation_error_collection.py
@@ -5,7 +5,7 @@ class ValidationErrorCollection(object):
     """
     A class representing a collection of validation errors.
 
-    For more information on ValidationErrors, see https://developers.braintreepayments.com/reference/general/validation-errors/overview/python
+    For more information on ValidationErrors, see https://developer.paypal.com/braintree/docs/reference/general/validation-errors/overview/python
 
     """
 
diff --git a/braintree/venmo_profile_data.py b/braintree/venmo_profile_data.py
@@ -0,0 +1,9 @@
+from braintree.resource import Resource
+
+class VenmoProfileData(Resource):
+    """
+    A class representing Braintree VenmoProfileData object.
+    """
+    def __init__(self, gateway, attributes):
+        Resource.__init__(self, gateway, attributes)
+
diff --git a/braintree/version.py b/braintree/version.py
@@ -1 +1 @@
-Version = "4.13.1"
+Version = "4.14.0"
diff --git a/braintree/webhook_notification.py b/braintree/webhook_notification.py
@@ -13,6 +13,7 @@
 from braintree.merchant_account import MerchantAccount
 from braintree.oauth_access_revocation import OAuthAccessRevocation
 from braintree.partner_merchant import PartnerMerchant
+from braintree.payment_method_customer_data_updated_metadata import PaymentMethodCustomerDataUpdatedMetadata
 from braintree.resource import Resource
 from braintree.revoked_payment_method_metadata import RevokedPaymentMethodMetadata
 from braintree.subscription import Subscription
@@ -44,6 +45,7 @@ class Kind(object):
         PartnerMerchantConnected = "partner_merchant_connected"
         PartnerMerchantDeclined = "partner_merchant_declined"
         PartnerMerchantDisconnected = "partner_merchant_disconnected"
+        PaymentMethodCustomerDataUpdated = "payment_method_customer_data_updated"
         PaymentMethodRevokedByCustomer = "payment_method_revoked_by_customer"
         RecipientUpdatedGrantedPaymentMethod = "recipient_updated_granted_payment_method"
         SubMerchantAccountApproved = "sub_merchant_account_approved"
@@ -113,6 +115,8 @@ def __init__(self, gateway, attributes):
             self.local_payment_funded = LocalPaymentFunded(gateway, node_wrapper["local_payment_funded"])
         elif "local_payment_reversed" in node_wrapper and attributes["kind"] == WebhookNotification.Kind.LocalPaymentReversed:
             self.local_payment_reversed = LocalPaymentReversed(gateway, node_wrapper["local_payment_reversed"])
+        elif "payment_method_customer_data_updated_metadata" in node_wrapper and attributes["kind"] == WebhookNotification.Kind.PaymentMethodCustomerDataUpdated:
+            self.payment_method_customer_data_updated_metadata = PaymentMethodCustomerDataUpdatedMetadata(gateway, node_wrapper["payment_method_customer_data_updated_metadata"])
 
         if "errors" in node_wrapper:
             self.errors = ValidationErrorCollection(node_wrapper['errors'])
diff --git a/braintree/webhook_testing_gateway.py b/braintree/webhook_testing_gateway.py
@@ -97,6 +97,8 @@ def __subject_sample_xml(self, kind, id):
             return self.__local_payment_funded()
         elif kind == WebhookNotification.Kind.LocalPaymentReversed:
             return self.__local_payment_reversed()
+        elif kind == WebhookNotification.Kind.PaymentMethodCustomerDataUpdated:
+            return self.__payment_method_customer_data_updated_sample_xml(id)
         else:
             return self.__subscription_sample_xml(id)
 
@@ -827,21 +829,7 @@ def __granted_payment_instrument_update(self):
             """
 
     def __granted_payment_method_revoked(self, id):
-        return """
-            <venmo-account>
-                <created-at type="datetime">2018-10-11T21:28:37Z</created-at>
-                <updated-at type="datetime">2018-10-11T21:28:37Z</updated-at>
-                <default type="boolean">true</default>
-                <image-url>https://assets.braintreegateway.com/payment_method_logo/venmo.png?environment=test</image-url>
-                <token>%s</token>
-                <source-description>Venmo Account: venmojoe</source-description>
-                <username>venmojoe</username>
-                <venmo-user-id>456</venmo-user-id>
-                <subscriptions type="array"/>
-                <customer-id>venmo_customer_id</customer-id>
-                <global-id>cGF5bWVudG1ldGhvZF92ZW5tb2FjY291bnQ</global-id>
-            </venmo-account>
-            """ % id
+        return self.__venmo_account_xml(id)
 
     def __payment_method_revoked_by_customer(self, id):
         return """
@@ -907,3 +895,41 @@ def __local_payment_reversed(self):
                 <payment-id>a-payment-id</payment-id>
             </local-payment-reversed>
             """
+
+    def __payment_method_customer_data_updated_sample_xml(self, id):
+        return """
+            <payment-method-customer-data-updated-metadata>
+                <token>TOKEN-12345</token>
+                <payment-method>%s</payment-method>
+                <datetime-updated type='dateTime'>2022-01-01T21:28:37Z</datetime-updated>
+                <enriched-customer-data>
+                    <fields-updated type='array'>
+                        <item>username</item>
+                    </fields-updated>
+                    <profile-data>
+                        <username>venmo_username</username>
+                        <first-name>John</first-name>
+                        <last-name>Doe</last-name>
+                        <phone-number>1231231234</phone-number>
+                        <email>john.doe@paypal.com</email>
+                    </profile-data>
+                </enriched-customer-data>
+            </payment-method-customer-data-updated-metadata>
+            """ % self.__venmo_account_xml(id)
+
+    def __venmo_account_xml(self, id):
+        return """
+            <venmo-account>
+                <created-at type="datetime">2018-10-11T21:28:37Z</created-at>
+                <updated-at type="datetime">2018-10-11T21:28:37Z</updated-at>
+                <default type="boolean">true</default>
+                <image-url>https://assets.braintreegateway.com/payment_method_logo/venmo.png?environment=test</image-url>
+                <token>%s</token>
+                <source-description>Venmo Account: venmojoe</source-description>
+                <username>venmojoe</username>
+                <venmo-user-id>456</venmo-user-id>
+                <subscriptions type="array"/>
+                <customer-id>venmo_customer_id</customer-id>
+                <global-id>cGF5bWVudG1ldGhvZF92ZW5tb2FjY291bnQ</global-id>
+            </venmo-account>
+            """ % id
diff --git a/setup.py b/setup.py
@@ -7,17 +7,17 @@
         The Braintree Python SDK provides integration access to the Braintree Gateway.
 
         1. https://github.com/braintree/braintree_python - README and Samples
-        2. https://developers.braintreepayments.com/python/sdk/server/overview - API Reference
+        2. https://developer.paypal.com/braintree/docs/reference/overview - API Reference
       """
 
 setup(
     name="braintree",
-    version="4.13.1",
+    version="4.14.0",
     description="Braintree Python Library",
     long_description=long_description,
     author="Braintree",
     author_email="support@braintreepayments.com",
-    url="https://developers.braintreepayments.com/python/sdk/server/overview",
+    url="https://developer.paypal.com/braintree/docs/reference/overview",
     packages=["braintree", "braintree.dispute_details", "braintree.exceptions", "braintree.exceptions.http", "braintree.merchant_account", "braintree.util", "braintree.test"],
     package_data={"braintree": ["ssl/*"]},
     install_requires=["requests>=0.11.1,<3.0"],
diff --git a/tests/unit/test_webhooks.py b/tests/unit/test_webhooks.py
@@ -791,3 +791,27 @@ def test_local_payment_reversed_webhook(self):
 
         self.assertEqual(WebhookNotification.Kind.LocalPaymentReversed, notification.kind)
         self.assertEqual("a-payment-id", local_payment_reversed.payment_id)
+
+    def test_payment_method_customer_data_updated_webhook(self):
+        sample_notification = WebhookTesting.sample_notification(
+            WebhookNotification.Kind.PaymentMethodCustomerDataUpdated,
+            "my_id"
+        )
+
+        notification = WebhookNotification.parse(sample_notification["bt_signature"], sample_notification["bt_payload"])
+        payment_method_customer_data_updated = notification.payment_method_customer_data_updated_metadata
+
+        self.assertEqual(WebhookNotification.Kind.PaymentMethodCustomerDataUpdated, notification.kind)
+
+        self.assertEqual(payment_method_customer_data_updated.token, "TOKEN-12345")
+        self.assertEqual(payment_method_customer_data_updated.datetime_updated, "2022-01-01T21:28:37Z")
+
+        enriched_customer_data = payment_method_customer_data_updated.enriched_customer_data
+        self.assertEqual(enriched_customer_data.fields_updated, ["username"])
+
+        profile_data = enriched_customer_data.profile_data
+        self.assertEqual(profile_data.first_name, "John")
+        self.assertEqual(profile_data.last_name, "Doe")
+        self.assertEqual(profile_data.username, "venmo_username")
+        self.assertEqual(profile_data.phone_number, "1231231234")
+        self.assertEqual(profile_data.email, "john.doe@paypal.com")

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ class DocumentUpload(Resource):`
`17`	`17`	`}`
`18`	`18`	`)`
`19`	`19`
`20`		`- For more information on DocumentUploads, see https://developers.braintreepayments.com/reference/request/document_upload/create`
	`20`	`+ For more information on DocumentUploads, see https://developer.paypal.com/braintree/docs/reference/request/document-upload/create`
`21`	`21`
`22`	`22`	`"""`
`23`	`23`