Merge pull request #36 from hyperwallet/feature/HW-58097-V3-Python-SDK-for-Transfer-Refunds

Feature/hw 58097 v3 python sdk for transfer refunds

Author: akalichety-hw

hyperwallet/__init__.py

@@ -31,7 +31,8 @@
     Account,                                                             # noqa
     StatusTransition,                                                    # noqa
     TransferMethodConfiguration,                                         # noqa
-    Webhook                                                              # noqa
+    Webhook,                                                             # noqa
+    TransferRefunds                                                      # naqa
 )
 
 from .api import Api                                                     # noqa

hyperwallet/api.py

@@ -22,7 +22,8 @@
     Account,
     StatusTransition,
     TransferMethodConfiguration,
-    Webhook
+    Webhook,
+    TransferRefunds
 )
 
 
@@ -2722,3 +2723,72 @@ def uploadDocumentsForUser(self,
         )
 
         return User(response)
+
+    '''
+
+    Transfer Refunds
+
+    '''
+
+
+    def createTransferRefund(self,
+                             transferToken=None,
+                             data=None):
+        '''
+        Create a Transfer Refund.
+        :param transferToken:
+            A token identifying the Transfer. **REQUIRED**
+        :param data:
+            A dictionary containing Transfer Refund information. **REQUIRED**
+        :returns:
+            A Transfer Refund.
+        '''
+
+        if not transferToken:
+            raise HyperwalletException('transferToken is required')
+
+        if not data:
+            raise HyperwalletException('data is required')
+
+        response = self.apiClient.doPost(
+            self.__buildUrl(
+                'transfers',
+                transferToken,
+                'refunds'
+            ),
+            data
+        )
+
+        return TransferRefunds(response)
+
+    def createTransferSpendBackRefund(self,
+                                      transferToken=None,
+                                      sourceToken=None,
+                                      params=None):
+        '''
+        Create a Transfer Refund.
+        :param transferToken:
+            A token identifying the Transfer. **REQUIRED**
+        :param data:
+            A dictionary containing Transfer Refund information. **REQUIRED**
+        :returns:
+            A Transfer Refund.
+        '''
+
+        if not transferToken:
+            raise HyperwalletException('transferToken is required')
+
+        if not sourceToken:
+            raise HyperwalletException('sourceToken is required')
+
+        response = self.apiClient.doGet(
+            self.__buildUrl(
+                'transfers',
+                transferToken,
+                'refunds',
+                sourceToken
+            ),
+            params
+        )
+
+        return TransferRefunds(response)

hyperwallet/models.py

@@ -798,3 +798,51 @@ def __repr__(self):
             date=self.createdOn,
             token=self.token
         )
+'''
+
+   Transfer Refunds
+
+'''
+
+class TransferRefunds(HyperwalletModel):
+    '''
+    The TransferRefunds Model.
+
+    :param data:
+        A dictionary containing the attributes for the Transfer Refunds.
+    '''
+
+    def __init__(self, data):
+        '''
+        Create a new Transfer Refunds with the provided attributes.
+        '''
+
+        super(TransferRefunds, self).__init__(data)
+
+        self.defaults = {
+            'token': None,
+            'status': None,
+            'createdOn': None,
+            'clientRefundId': None,
+            'sourceToken': None,
+            'sourceAmount': None,
+            'sourceFeeAmount': None,
+            'sourceCurrency': None,
+            'destinationToken': None,
+            'destinationAmount': None,
+            'destinationFeeAmount': None,
+            'destinationCurrency': None,
+            'foreignExchanges': None,
+            'notes': None,
+            'memo': None,
+            'expiresOn': None
+        }
+
+        for (param, default) in self.defaults.items():
+            setattr(self, param, data.get(param, default))
+
+    def __repr__(self):
+        return "TransferRefunds({date}, {token})".format(
+            date=self.createdOn,
+            token=self.token
+        )

hyperwallet/tests/test_api.py

@@ -2212,6 +2212,60 @@ def test_uploadDocumentsForUser_success(self, mock_put):
 
         self.assertTrue(response.token, self.data.get('token'))
 
+    '''
+
+    Transfer Refunds
+
+    '''
+
+    @mock.patch('hyperwallet.utils.ApiClient._makeRequest')
+    def test_create_transfer_refunds_success(self, mock_post):
+
+        mock_post.return_value = self.data
+        response = self.api.createTransferRefund('token',self.data)
+        self.assertTrue(response.token, self.data.get('token'))
+
+    def test_create_transfer_refunds_fail_need_payment_token(self):
+
+        with self.assertRaises(HyperwalletException) as exc:
+            self.api.createTransferRefund()
+
+        self.assertEqual(exc.exception.message, 'transferToken is required')
+
+    def test_create_transfer_refunds_fail_need_data(self):
+
+        with self.assertRaises(HyperwalletException) as exc:
+            self.api.createTransferRefund('token')
+
+        self.assertEqual(exc.exception.message, 'data is required')
+
+    '''
+
+    Transfer Spend Back Refunds
+
+    '''
+
+    def test_create_transfer_spend_back_refunds_user_token(self):
+
+        with self.assertRaises(HyperwalletException) as exc:
+            self.api.createTransferSpendBackRefund()
+
+        self.assertEqual(exc.exception.message, 'transferToken is required')
+
+    def test_create_transfer_spend_back_refunds_fail_need_payment_token(self):
+
+        with self.assertRaises(HyperwalletException) as exc:
+            self.api.createTransferSpendBackRefund('token')
+
+        self.assertEqual(exc.exception.message, 'sourceToken is required')
+
+    @mock.patch('hyperwallet.utils.ApiClient._makeRequest')
+    def test_create_transfer_spend_back_refunds_success(self, mock_get):
+
+        mock_get.return_value = self.data
+        response = self.api.createTransferSpendBackRefund('token', 'token')
+
+        self.assertTrue(response.token, self.data.get('token'))
 
 if __name__ == '__main__':
     unittest.main()

hyperwallet/tests/test_models.py

@@ -22,7 +22,8 @@
     Account,
     StatusTransition,
     TransferMethodConfiguration,
-    Webhook
+    Webhook,
+    TransferRefunds
 )
 
 
@@ -529,6 +530,29 @@ def test_webhook_model_bad_type(self):
 
         self.assertEqual(test_webhook.object, webhook_data.get('object'))
 
+    '''
+    
+    Transfer Refunds
+
+    '''
+
+    def test_transfer_refunds(self):
+
+        status_transfer_refunds_data = {
+            "clientRefundId": "12312312312412112",
+            "notes": "Merchant Payment return to Wallet Balance",
+            "memo": "TransferClientId123456"
+        }
+
+        status_transfer_refunds = TransferRefunds(status_transfer_refunds_data)
+
+        self.assertEqual(
+            status_transfer_refunds.__repr__(),
+            'TransferRefunds({date}, {token})'.format(
+                date=status_transfer_refunds_data.get('createdOn'),
+                token=status_transfer_refunds_data.get('token')
+            )
+        )
 
 if __name__ == '__main__':
     unittest.main()