Cleaned recipient.py of static methods and moved it to types package, adjusted recipient_gateway imports accordingly and added more inline comments.

Author: Aman-Aalam

test/integration/RecipientTest.py

@@ -6,7 +6,7 @@
 sys.path.append(os.path.abspath('.'))
 
 from trolley.configuration import Configuration
-from trolley.recipient import Recipient
+from trolley.types.recipient import Recipient
 from trolley.types.recipient_account import RecipientAccount
 from TestSetup import TestSetup
 from TestHelper import TestHelper

trolley/__init__.py

@@ -1,7 +1,7 @@
 from trolley.configuration import Configuration
 from trolley.client import Client
 from trolley.gateway import Gateway
-from trolley.recipient import Recipient
+from trolley.types.recipient import Recipient
 from trolley.types.recipient_account import RecipientAccount
 from trolley.types.log import Log
 from trolley.types.batch import Batch

trolley/recipient.py

@@ -1,7 +1,10 @@
 from collections import namedtuple
 from trolley.exceptions.invalidFieldException import InvalidFieldException
 import trolley.configuration
+from trolley.types.log import Log
 from trolley.types.meta import Meta
+from trolley.types.payment import Payment
+from trolley.types.recipient import Recipient
 from trolley.utils.url_utils import UrlUtils
 
 
@@ -15,13 +18,18 @@ def __init__(self, gateway, config):
         self.gateway = gateway
         self.config = config
 
+    """
+        Retrieve a recipient
+            A recipient_id is required::
+            recipient.find('R-fjeracjmuflh')
+        """
     def find(self, recipient_id, term=""):
         if recipient_id is None:
             raise InvalidFieldException("Recipient id cannot be None.")
         endpoint = f'/v1/recipients/{recipient_id}/{term}'
         response = trolley.configuration.Configuration.client(
             self.config).get(endpoint)
-        recip = trolley.Recipient.factory(response)
+        recip = Recipient.factory(response)
         recipient = namedtuple("Recipient", recip.keys())(*recip.values())
         count = 0
         for account in recipient.accounts:
@@ -30,16 +38,27 @@ def find(self, recipient_id, term=""):
             count = count + 1
         return recipient
 
+    """
+        Create a recipient
+            A body is required::
+            recipient.create({"type": "individual", "firstName": "John",
+                                    "lastName": "Smith", "email": "[email protected]"})
+        """
     def create(self, body):
         if body is None:
             raise InvalidFieldException("Body cannot be None.")
         endpoint = '/v1/recipients/'
         response = trolley.configuration.Configuration.client(
             self.config).post(endpoint, body)
-        recip = trolley.Recipient.factory(response)
+        recip = Recipient.factory(response)
         recipient = namedtuple("Recipient", recip.keys())(*recip.values())
         return recipient
 
+    """
+        Update a recipient
+            A recipient_id and body are required::
+            recipient.update('R-fjeracjmuflh', {'firstName': 'tom'})
+        """
     def update(self, recipient_id, body):
         if recipient_id is None:
             raise InvalidFieldException("Recipient id cannot be None.")
@@ -50,6 +69,11 @@ def update(self, recipient_id, body):
             self.config).patch(endpoint, body)
         return True
 
+    """
+        Delete a recipient
+            A recipient_id is required::
+            recipient.delete('R-fjeracjmuflh')
+        """
     def delete(self, recipient_id):
         if recipient_id is None:
             raise InvalidFieldException("Recipient id cannot be None.")
@@ -58,6 +82,14 @@ def delete(self, recipient_id):
             self.config).delete(endpoint)
         return True
 
+    """
+        Delete multiple recipients
+            A list of recipient_ids is required::
+            recipient.delete_multiple([
+                'R-fjeracjmuflh',
+                'R-ajerasdfuflf'
+            ])
+        """
     def delete_multiple(self, recipient_ids):
         if recipient_ids is None:
             raise InvalidFieldException("Recipient ids cannot be None.")
@@ -67,6 +99,11 @@ def delete_multiple(self, recipient_ids):
             self.config).delete(endpoint, recipient_ids)
         return True
 
+    """
+        Retrieve Recipient activity logs, by page
+            A recipient_id is required:
+            recipient.retrieve_logs('R-fjeracjmuflh')
+        """
     def retrieve_logs(self, recipient_id, page=1, pageSize=10):
         if recipient_id is None:
             raise InvalidFieldException("Recipient id cannot be None.")
@@ -78,7 +115,7 @@ def retrieve_logs(self, recipient_id, page=1, pageSize=10):
         logs = []
         count = 0
         for log in response['recipientLogs']:
-            temp = trolley.Log.factory(log)
+            temp = Log.factory(log)
 
             logs.insert(count, namedtuple("Log", temp.keys())(*temp.values()))
 
@@ -89,6 +126,11 @@ def retrieve_logs(self, recipient_id, page=1, pageSize=10):
 
         return logs
 
+    """
+        Retrieve all payments of the Recipient
+            A recipient_id is required:
+            recipient.get_all_payments('R-fjeracjmuflh')
+        """
     def get_all_payments(self, recipient_id):
         if recipient_id is None:
             raise InvalidFieldException("Recipient id cannot be None.")
@@ -99,7 +141,7 @@ def get_all_payments(self, recipient_id):
         payments = []
         count = 0
         for payment in response['payments']:
-            temppayment = trolley.Payment.factory(payment)
+            temppayment = Payment.factory(payment)
             newpayment = namedtuple("Payment", temppayment.keys())(*temppayment.values())
             payments.insert(count, newpayment)
             count = count + 1
@@ -109,6 +151,11 @@ def get_all_payments(self, recipient_id):
 
         return payments
 
+    """
+        Retrieve all offline payments of the Recipient
+            A recipient_id is required:
+            recipient.get_all_offline_payments('R-fjeracjmuflh')
+        """
     def get_all_offline_payments(self, recipient_id):
         if recipient_id is None:
             raise InvalidFieldException("Recipient id cannot be None.")
@@ -119,7 +166,7 @@ def get_all_offline_payments(self, recipient_id):
         offlinePayments = []
         count = 0
         for offlinePayment in response['offlinePayments']:
-            temppayment = trolley.Payment.factory(offlinePayment)
+            temppayment = Payment.factory(offlinePayment)
             newpayment = namedtuple("Payment", temppayment.keys())(*temppayment.values())
             offlinePayments.insert(count, newpayment)
             count = count + 1
@@ -134,7 +181,8 @@ def get_all_offline_payments(self, recipient_id):
         You can use this generator in a foreach loop to sequentially go through all the 
         search results without needing to call this method again.
         
-            For accessing specific pages, check the search_by_page() method. """
+        For accessing specific pages, check the search_by_page() method. 
+        """
     def search(self, search=None, name=None, email=None, reference_id=None, start_date=None,
                end_date=None, status=None, compliance_status=None, country=None, payout_method=None, currency=None,
                order_by=None, sort_by=None):
@@ -156,7 +204,9 @@ def search(self, search=None, name=None, email=None, reference_id=None, start_da
 
     """ Search Recipients by providing a page number.
         This method returns a list.
-        You should use this function when you want to paginate manually. """
+        You should use this function when you want to paginate manually.
+        recipient.search_by_page(1,10,'test')
+     """
     def search_by_page(self, page=1, page_size=10, search=None, name=None, email=None, reference_id=None, start_date=None,
                end_date=None, status=None, compliance_status=None, country=None, payout_method=None, currency=None,
                order_by=None, sort_by=None):
@@ -169,7 +219,7 @@ def __build_recipients_from_response(self, response, include_meta=False):
         recipients = []
         count = 0
         for recipient in response['recipients']:
-            temp = trolley.recipient.Recipient.factory(recipient)
+            temp = Recipient.factory(recipient)
 
             recipient = namedtuple("Recipient", temp.keys())(*temp.values())
             recipients.insert(count, recipient)