Merge pull request #47 from hyperwallet/feature/DTRUNEONE-1585-V3-python-Updating-request-query-parameters-of-list-methods

feature/DTPAYHWBM-7: V3 updated filters for list endpoints and relevant unit tests

Author: hlahlou-pp-dev

hyperwallet/api.py

@@ -1891,6 +1891,9 @@ def listVenmoAccounts(self,
         if not userToken:
             raise HyperwalletException('userToken is required')
 
+        if params and not set(list(params)).issubset(VenmoAccount.filters_array):
+            raise HyperwalletException('Invalid filter')
+
         response = self.apiClient.doGet(
             self.__buildUrl('users', userToken, 'venmo-accounts'),
             params
@@ -1999,6 +2002,9 @@ def listVenmoAccountStatusTransitions(self,
         if not venmoAccountToken:
             raise HyperwalletException('venmoAccountToken is required')
 
+        if params and not set(list(params)).issubset(StatusTransition.filters_array):
+            raise HyperwalletException('Invalid filter')
+
         response = self.apiClient.doGet(
             self.__buildUrl(
                 'users',
@@ -2248,7 +2254,7 @@ def listBalancesForUser(self,
         if not userToken:
             raise HyperwalletException('userToken is required')
 
-        if params and not set(list(params)).issubset(Balance.filters_array):
+        if params and not set(list(params)).issubset(Balance.filters_array_user):
             raise HyperwalletException('Invalid filter')
 
         response = self.apiClient.doGet(
@@ -2281,7 +2287,7 @@ def listBalancesForPrepaidCard(self,
         if not prepaidCardToken:
             raise HyperwalletException('prepaidCardToken is required')
 
-        if params and not set(list(params)).issubset(Balance.filters_array):
+        if params and not set(list(params)).issubset(Balance.filters_array_prepaid_card):
             raise HyperwalletException('Invalid filter')
 
         response = self.apiClient.doGet(
@@ -2320,7 +2326,7 @@ def listBalancesForAccount(self,
         if not accountToken:
             raise HyperwalletException('accountToken is required')
 
-        if params and not set(list(params)).issubset(Balance.filters_array):
+        if params and not set(list(params)).issubset(Balance.filters_array_account):
             raise HyperwalletException('Invalid filter')
 
         response = self.apiClient.doGet(
@@ -2360,6 +2366,9 @@ def listReceiptsForUser(self,
         if not userToken:
             raise HyperwalletException('userToken is required')
 
+        if params and not set(list(params)).issubset(Receipt.filters_array_user):
+            raise HyperwalletException('Invalid filter')
+
         response = self.apiClient.doGet(
             self.__buildUrl('users', userToken, 'receipts'),
             params
@@ -2390,6 +2399,9 @@ def listReceiptsForPrepaidCard(self,
         if not prepaidCardToken:
             raise HyperwalletException('prepaidCardToken is required')
 
+        if params and not set(list(params)).issubset(Receipt.filters_array_prepaid_card):
+            raise HyperwalletException('Invalid filter')
+
         response = self.apiClient.doGet(
             self.__buildUrl(
                 'users',
@@ -2426,6 +2438,9 @@ def listReceiptsForAccount(self,
         if not accountToken:
             raise HyperwalletException('accountToken is required')
 
+        if params and not set(list(params)).issubset(Receipt.filters_array_account):
+            raise HyperwalletException('Invalid filter')
+
         response = self.apiClient.doGet(
             self.__buildUrl(
                 'programs',
@@ -2628,6 +2643,9 @@ def listTransferMethodConfigurations(self,
         if not userToken:
             raise HyperwalletException('userToken is required')
 
+        if params and not set(list(params)).issubset(TransferMethodConfiguration.filters_array):
+            raise HyperwalletException('Invalid filter')
+
         params.update({'userToken': userToken})
 
         response = self.apiClient.doGet(
@@ -3078,6 +3096,9 @@ def listTransferMethods(self,
 
         if not userToken:
             raise HyperwalletException('userToken is required')
+        
+        if params and not set(list(params)).issubset(TransferMethod.filters_array):
+            raise HyperwalletException('Invalid filter')
 
         response = self.apiClient.doGet(
             self.__buildUrl(

hyperwallet/models.py

@@ -70,7 +70,7 @@ class User(HyperwalletModel):
         A dictionary containing the attributes for the User.
     '''
 
-    filters_array = {'clientUserId', 'email', 'programToken', 'status', 'verificationStatus'}
+    filters_array = {'clientUserId','email','programToken','status','verificationStatus', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -166,6 +166,8 @@ class TransferMethod(HyperwalletModel):
         A dictionary containing the attributes for the Transfer Method.
     '''
 
+    filters_array = {'status', 'type', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
+
     def __init__(self, data):
         '''
         Create a new Transfer Method with the provided attributes.
@@ -201,7 +203,7 @@ class BankAccount(TransferMethod):
         A dictionary containing the attributes for the Bank Account.
     '''
 
-    filters_array = {'type', 'status'}
+    filters_array = {'type','status', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -284,7 +286,7 @@ class BankCard(TransferMethod):
         A dictionary containing the attributes for the Bank Card.
     '''
 
-    filters_array = {'status'}
+    filters_array = {'status', 'type', 'createdOn', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -320,7 +322,7 @@ class PrepaidCard(TransferMethod):
         A dictionary containing the attributes for the Prepaid Card.
     '''
 
-    filters_array = {'status'}
+    filters_array = {'status', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -355,7 +357,7 @@ class PaperCheck(TransferMethod):
         A dictionary containing the attributes for the Paper Check.
     '''
 
-    filters_array = {'status'}
+    filters_array = {'status', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -414,7 +416,7 @@ class Transfer(HyperwalletModel):
         A dictionary containing the attributes for the Transfer.
     '''
 
-    filters_array = {'clientTransferId', 'sourceToken', 'destinationToken'}
+    filters_array = {'clientTransferId','sourceToken','destinationToken', 'createdBefore', 'createdAfter', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -460,7 +462,7 @@ class PayPalAccount(TransferMethod):
         A dictionary containing the attributes for the PayPal Account.
     '''
 
-    filters_array = {'status'}
+    filters_array = {'status', 'type', 'createdOn' , 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -491,6 +493,8 @@ class VenmoAccount(TransferMethod):
         A dictionary containing the attributes for the Venmo Account.
     '''
 
+    filters_array = {'status', 'type', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
+
     def __init__(self, data):
         '''
         Create a new Venmo Account with the provided attributes.
@@ -520,7 +524,7 @@ class Payment(HyperwalletModel):
         A dictionary containing the attributes for the Payment.
     '''
 
-    filters_array = {'clientPaymentId', 'releaseOn'}
+    filters_array = {'clientPaymentId', 'currency', 'memo', 'releaseDate', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -564,7 +568,9 @@ class Balance(HyperwalletModel):
         A dictionary containing the attributes for the Balance.
     '''
 
-    filters_array = {'currency'}
+    filters_array_user = {'currency', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
+    filters_array_account = {'currency', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
+    filters_array_prepaid_card = {'createdBefore', 'createdAfter'}
 
     def __init__(self, data):
         '''
@@ -596,6 +602,10 @@ class Receipt(HyperwalletModel):
         A dictionary containing the attributes for the Receipt.
     '''
 
+    filters_array_user = {'currency', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
+    filters_array_account = {'currency', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
+    filters_array_prepaid_card = {'createdBefore', 'createdAfter'}
+
     def __init__(self, data):
         '''
         Create a new Receipt with the provided attributes.
@@ -700,7 +710,7 @@ class StatusTransition(HyperwalletModel):
         A dictionary containing the attributes for the Status Transition.
     '''
 
-    filters_array = {'transition'}
+    filters_array = {'transition', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''
@@ -737,6 +747,8 @@ class TransferMethodConfiguration(HyperwalletModel):
         A dictionary containing the attributes for the Transfer Method Configuration.
     '''
 
+    filters_array = {'userToken', 'offset', 'limit'}
+
     def __init__(self, data):
         '''
         Create a new Transfer Method Configuration with the provided attributes.
@@ -778,7 +790,7 @@ class Webhook(HyperwalletModel):
         A dictionary containing the attributes for the Webhook.
     '''
 
-    filters_array = {'programToken'}
+    filters_array = {'programToken', 'type', 'createdBefore', 'createdAfter', 'sortBy', 'offset', 'limit'}
 
     def __init__(self, data):
         '''