GROW-965: Adding method for contact finance update (#63)

david-vacasa · web-flow · commit 00adea259a68 · 2019-08-19T13:38:34.000-06:00
* GROW-965: Adding method for contact finance update

* GROW-965: Fixing changelog and version

* GROW-965: Log order
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,17 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0] - 2019-08-19
+### Added
+ - update_contact_finances()
+
+
 ## [2.0.0] - 2019-08-10
 ### Added
 - New CHANGELOG.md added.
 
 ### Changes
 - The `get_quote()` method now utilizes
 [v2 of the quotes endpoint](https://connect.vacasait.com/#operation/get-quote-v2).
+
+
diff --git a/setup.py b/setup.py
@@ -2,7 +2,7 @@
 
 setup(
     name='VacasaConnect',
-    version='2.0.0',
+    version='2.1.0',
     description='A Python 3.6+ SDK for the connect.vacasa.com API.',
     packages=['vacasa.connect'],
     url='https://github.com/Vacasa/python-vacasa-connect-sdk',
diff --git a/tests/test_connect.py b/tests/test_connect.py
@@ -153,3 +153,44 @@ def test_create_cancelled_reservation_ignores_missing_display_currency_code(mock
     mock_post.assert_called_once_with('https://fake_url/v1/reservations',
                                       headers=ANY,
                                       json=deepcopy(TEST_EXPECTED['reservation_without_display_currency_code']))
+
+
+# ----- Contracts (DOCUMENTS) ----- #
+@patch.object(VacasaConnect, '_post')
+def test_create_contract(mock_post):
+    connect = mock_connect()
+
+    connect.create_contract(**deepcopy(TEST_DATA['normal_contract']))
+    mock_post.assert_called_once_with('https://fake_url/v1/contracts',
+                                      headers=ANY,
+                                      json=deepcopy(TEST_EXPECTED['normal_contract']))
+
+
+# ----- Contacts (PEOPLE) ----- #
+@patch.object(VacasaConnect, '_post')
+def test_create_contact(mock_post):
+    connect = mock_connect()
+
+    connect.create_contact(**deepcopy(TEST_DATA['normal_contact']))
+    mock_post.assert_called_once_with('https://fake_url/v1/contacts',
+                                      headers=ANY,
+                                      json=deepcopy(TEST_EXPECTED['normal_contact']))
+
+
+@patch.object(VacasaConnect, '_patch')
+def test_update_finance_payload(mock_patch):
+    connect = mock_connect()
+
+    connect.update_contact_finances_payload(12345, deepcopy(TEST_DATA['normal_contact_finances']))
+    mock_patch.assert_called_once_with('https://fake_url/v1/contacts/12345/finances',
+                                      headers=ANY,
+                                      json=deepcopy(TEST_EXPECTED['normal_contact_finances']))
+
+@patch.object(VacasaConnect, '_patch')
+def test_update_finance(mock_patch):
+    connect = mock_connect()
+
+    connect.update_contact_finances(12340, **deepcopy(TEST_DATA['normal_contact_finances']))
+    mock_patch.assert_called_once_with('https://fake_url/v1/contacts/12340/finances',
+                                      headers=ANY,
+                                      json=deepcopy(TEST_EXPECTED['normal_contact_finances']))
diff --git a/tests/test_data.py b/tests/test_data.py
@@ -13,6 +13,51 @@
         last_name='Doe',
         account_number='bar',
         exp_mmyy='0130'
+    ),
+    normal_contact=dict(
+        address_1= "123 Main st",
+        address_2= "",
+        city= "Springfield",
+        country_code= "US",
+        created_by= 0,
+        email= "user@example.com",
+        first_name= "User",
+        language_id= 0,
+        last_name= "Namesson",
+        phone= "208-555-6677",
+        phone_notes= "Don't ever call after midnight",
+        state= "MO",
+        tax_entity_name= "Arbys",
+        zip= "string"
+    ),
+    normal_contract=dict(
+        amendment_by_notice_id= 4,
+        channel_fee_cost_sharing_id= 5,
+        created_by= 0,
+        end_date= "2019-08-15",
+        form_id= 1,
+        management_fee= 0,
+        monthly_rent= 0,
+        owners= [
+            dict(
+                percentage_ownership= 100,
+                tax_ownership= 100,
+                contact_id= 12345
+                )
+            ],
+        referral_discount= 0,
+        referral_eligible= False,
+        start_date= "2019-08-15",
+        template_version_id= 1,
+        unit_id= 0
+    ),
+    normal_contact_finances=dict(
+        account_name= "Chemical Bank",
+        account_number= "987654321",
+        routing_number= "123456789",
+        tax_id= "00-0000-0",
+        tax_entity_name= "Arbys",
+        tax_form_code_id= 12
     )
 )
 
diff --git a/tests/test_expected.py b/tests/test_expected.py
@@ -22,7 +22,66 @@
                 source=None
             )
         )
+    ),
+    normal_contact=dict(
+        data=dict(
+            attributes=dict(
+                address_1= "123 Main st",
+                address_2= "",
+                city= "Springfield",
+                country_code= "US",
+                created_by= 0,
+                email= "user@example.com",
+                first_name= "User",
+                language_id= 0,
+                last_name= "Namesson",
+                phone= "208-555-6677",
+                phone_notes= "Don't ever call after midnight",
+                state= "MO",
+                tax_entity_name= "Arbys",
+                zip= "string",
+                send_email=False
+            )
+        )
+    ),
+    normal_contract=dict(
+        data=dict(
+            attributes=dict(
+                amendment_by_notice_id= 4,
+                channel_fee_cost_sharing_id= 5,
+                created_by= 0,
+                end_date= "2019-08-15",
+                form_id= 1,
+                management_fee= 0,
+                monthly_rent= 0,
+                owners= [
+                    dict(
+                        percentage_ownership= 100,
+                        tax_ownership= 100,
+                        contact_id= 12345
+                        )
+                    ],
+                referral_discount= 0,
+                referral_eligible= False,
+                start_date= "2019-08-15",
+                template_version_id= 1,
+                unit_id= 0
+            )
+        )
+    ),
+    normal_contact_finances=dict(
+        data=dict(
+            attributes=dict(
+                account_name= "Chemical Bank",
+                account_number= "987654321",
+                routing_number= "123456789",
+                tax_id= "00-0000-0",
+                tax_entity_name= "Arbys",
+                tax_form_code_id= 12
+            )
+        )
     )
+
 )
 
 # terms
diff --git a/vacasa/connect/connect.py b/vacasa/connect/connect.py
@@ -1157,7 +1157,7 @@ def create_contact(self,
                        send_email: bool = False
                        ):
         """
-        https://vacasa.docs.stoplight.io/contacts/postv1contacts
+        https://connect.vacasa.com/#tag/Contacts/paths/~1v1~1contacts/post
 
         Args:
             first_name: First name of the contact
@@ -1210,22 +1210,77 @@ def create_contact(self,
     def update_contact(self, contact_id, params: dict):
 
         """
-        Update a unit via connect.
-        https://vacasa.docs.stoplight.io/contacts/patchv1contactsid
+        Update a contact via connect.
+        https://connect.vacasa.com/#tag/Contacts/paths/~1v1~1contacts/patch
 
         Args:
             contact_id: ID of the contact to update
             params: A dict of key value pairs to update.
 
         Returns: dict
-             updated unit
+             updated contact
 
         """
 
         url = f"{self.endpoint}/v1/contacts/{contact_id}"
         return self._patch(url, json={'data': {'attributes': params}}, headers=self._headers()).json()
 
 
+    def update_contact_finances(self,
+                                contact_id,
+                                account_name: str = None,
+                                account_number: str = None,
+                                routing_number: str = None,
+                                tax_id: str = None,
+                                tax_entity_name: str = None,
+                                tax_form_code_id: int = 0):
+
+        """
+        Update a contacts finances via connect.
+        https://connect.vacasa.com/#tag/Contacts/paths/~1v1~1contacts~1{id}~1finances/patch
+
+        Args:
+            contact_id: ID of the contact to update
+            account_name: Bank Account Name (<= 100 Chars)
+            account_number: Bank Account Number (<= 25 Chars)
+            routing_number: Bank Routing Number (<= 20 Chars)
+            tax_id: Tax Identification (<= 11 Chars)
+            tax_entity_name: Tax Name (<= 100 Chars)
+            tax_form_code_id:
+
+
+        Returns: None
+             Sensitve data.. no result (HTTP-204)
+
+        """
+        return self.update_contact_finances_payload(contact_id, dict(
+            account_name=account_name,
+            account_number=account_number,
+            routing_number=routing_number,
+            tax_id=tax_id,
+            tax_entity_name=tax_entity_name,
+            tax_form_code_id=tax_form_code_id))
+
+    def update_contact_finances_payload(self, contact_id, params: dict):
+
+        """
+        Update a contacts finances via connect.
+        https://connect.vacasa.com/#tag/Contacts/paths/~1v1~1contacts~1{id}~1finances/patch
+
+        Args:
+            contact_id: ID of the contact to update
+            params: A dict of key value pairs to update.
+
+        Returns: None
+             Sensitve data.. no result (HTTP-204)
+
+        """
+
+        url = f"{self.endpoint}/v1/contacts/{contact_id}/finances"
+        return self._patch(url, json={'data': {'attributes': params}}, headers=self._headers()).json()
+
+
+
 def _trip_protection_to_integer(trip_protection: bool) -> int:
     """Convert from True/False/None to 1/0/-1"""
     if trip_protection is None:
