Merge pull request #119 from starkbank/feature/update-deposit-resource-readme-update

Add update function to Deposit resource

Author: leonardokagohara-stark

CHANGELOG.md

@@ -18,6 +18,7 @@ Given a version number MAJOR.MINOR.PATCH, increment:
 - SplitLog resource
 - SplitReceiver resource
 - SplitReceiverLog resource
+- update function to Deposit resource
 
 ## [2.22.0] - 2023-09-18
 ### Removed 

README.md

@@ -852,6 +852,21 @@ deposit = starkbank.deposit.get("5155165527080960")
 print(deposit)
 ```
 
+## Update a deposit
+
+You can update an deposit's amount by its id. Only the amount can be decreased, which will result in a payment reversal. To fully reverse the deposit, pass amount = 0.
+
+```python
+import starkbank
+
+deposit = starkbank.deposit.update(
+    "5155165527080960",
+    amount=0,
+)
+
+print(deposit)
+```
+
 ## Query deposit logs
 
 Logs are pretty important to understand the life cycle of a deposit.
@@ -2437,7 +2452,7 @@ With this function, you can manually set events retrieved from the API as
 ```python
 import starkbank
 
-event = starkbank.event.update(id="129837198237192", is_delivered=True)
+event = starkbank.event.update("129837198237192", is_delivered=True)
 
 print(event)
 ```

starkbank/deposit/__deposit.py

@@ -119,3 +119,20 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, sort=Non
         ids=ids,
         user=user,
     )
+
+
+def update(id, amount=None, user=None):
+    """# Update Deposit entity
+    Update the Deposit by passing its id to be partially or fully reversed.
+    ## Parameters (required):
+    - id [string]: Deposit id. ex: "5656565656565656"
+    ## Parameters (optional):
+    - amount [string, default None]: The new amount of the Deposit. If the amount = 0 the Deposit will be fully reversed
+    - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call
+    ## Return:
+    - target Deposit with updated attributes
+    """
+    payload = {
+        "amount": amount,
+    }
+    return rest.patch_id(resource=_resource, id=id, user=user, payload=payload)

starkbank/deposit/__init__.py

@@ -1,3 +1,3 @@
-from .__deposit import get, query, page
+from .__deposit import get, query, page, update
 from .log.__log import Log
 from . import log

tests/sdk/test_corporate_card.py

@@ -1,9 +1,9 @@
 import starkbank
 from unittest import TestCase, main
 from datetime import date, timedelta
-from tests.utils.holder import generateExampleHoldersJson
 from tests.utils.user import exampleProject
 from tests.utils.card import generateExampleCardJson
+from tests.utils.holder import generateExampleHoldersJson
 
 starkbank.user = exampleProject
 

tests/sdk/test_deposit.py

@@ -47,5 +47,21 @@ def test_success(self):
         print(deposit)
 
 
+class TestDepositInfoPatch(TestCase):
+
+    def test_success_amount(self):
+        deposits = starkbank.deposit.query(status="created", limit=1)
+        deposit_amount = 0
+        for deposit in deposits:
+            self.assertIsNotNone(deposit.id)
+            updated_deposit = starkbank.deposit.update(
+                deposit.id,
+                amount=deposit_amount,
+            )
+            print(updated_deposit)
+            self.assertEqual(updated_deposit.amount, deposit_amount)
+
+
 if __name__ == '__main__':
     main()
+

tests/sdk/test_dict_key.py

@@ -8,7 +8,7 @@
 class TestDictKeyInfoGet(TestCase):
 
     def test_success(self):
-        dict_key = starkbank.dictkey.get("valid@starkbank.com")
+        dict_key = starkbank.dictkey.get("valid@sandbox.com")
         self.assertIsNotNone(dict_key.id)
         print(dict_key)
 

tests/sdk/test_transfer.py

@@ -1,8 +1,8 @@
 import starkbank
-from datetime import timedelta, date
 from unittest import TestCase, main
-from tests.utils.transfer import generateExampleTransfersJson
+from datetime import timedelta, date
 from tests.utils.user import exampleProject
+from tests.utils.transfer import generateExampleTransfersJson
 
 
 starkbank.user = exampleProject