Merge pull request #94 from andela-sjames/develop

Update docs and test

Author: andela-sjames

docs/transactions.md

@@ -1,4 +1,6 @@
 ## Transactions
+`https://paystack.com/docs/api/transaction/`
+
 
 ##### `Transaction.initialize(reference, amount, email, plan)` - Initialize a transaction.
 
@@ -77,16 +79,18 @@ response = Transaction.get(transaction_id=23)
 
 JSON data from paystack API.
 
-##### `Transaction.list()` - List transactions.
+##### `Transaction.list(**kwargs)` - List transactions.
 
 ```python
 from paystackapi.transaction import Transaction
-response = Transaction.list()
+response = Transaction.list(perPage=3,page=1)
 ```
 
-*Arguments*
+*Arguments* 
 
-No argument required.
+- `customer`: Specify an ID for the customer whose transactions you want to retrieve (optional)
+- `status`: Filter transactions by status ('failed', 'success', 'abandoned') (optional)
+- ...
 
 *Returns*
 

paystackapi/tests/test_transaction.py

@@ -77,7 +77,10 @@ def test_list(self):
             status=201,
         )
 
-        response = Transaction.list()
+        response = Transaction.list(
+            perPage=3,
+            page=1
+        )
         self.assertTrue(response['status'])
 
     @httpretty.activate

paystackapi/transaction.py

@@ -77,10 +77,12 @@ def list(cls, **kwargs):
         Args:
             No argument required.
             optional:
-                customer_id: When used as a param, returns the transactions related to the customer
-                customer_email: When used as a param, does not return transactions related to the customer
+                customer: When used as a param, returns the transactions related to the customer
+                status: Filter transactions by status ('failed', 'success', 'abandoned')
                 perPage: Specify how many records you want to retrieve per page.
                     If not specify we use a default value of 50. (Integer)
+                page: Specify exactly what page you want to retrieve.
+                    If not specify we use a default value of 1. (Integer)
 
         Returns:
             Json data from paystack API.