Merge pull request #98 from sharhan-alhassan/feat/send-update-subscri…

…ption-link

Feat:Subscription --> Email a customer a link for updating the card on their subscription

docs/subscription.md

@@ -88,3 +88,35 @@ response = Subscription.enable(code="SUB_vsyqdmlzble3uii",
 *Returns*
 
 JSON data from paystack API.
+
+##### `Subscription.generate_update_subscription_link(subscription_code)` - Generate a link for updating the card on a subscription
+```python
+from paystackapi.subscription import Subscription
+response = Subscription.generate_update_subscription_link(
+    subscription_code='SUB_vsyqdmlzble3uii'
+)
+```
+
+*Arguments*
+- `subscription_code`: subscription code
+
+*Returns*
+
+JSON data from paystack API.
+
+
+##### `Subscription.send_update_subscription_link(subscription_code)` - Email a customer a link for updating the card on their subscription
+
+```python
+from paystackapi.subscription import Subscription
+response = Subscription.send_update_subscription_link(
+    subscription_code='SUB_vsyqdmlzble3uii'
+)
+```
+
+*Arguments*
+- `subscription_code`: subscription code
+
+*Returns*
+
+JSON data from paystack API.

paystackapi/subscription.py

@@ -76,3 +76,29 @@ def fetch(cls, subscription_id):
             Json data from paystack API.
         """
         return cls().requests.get(f"subscription/{subscription_id}")
+
+    @classmethod
+    def generate_update_subscription_link(cls, subscription_code):
+        """
+        Generate a link for updating the card on a subscription
+        
+        Args:
+            subscription_code: subscription code.
+        
+        Returns:
+            Json data from paystack API.
+        """
+        return cls().requests.get(f"subscription/{subscription_code}/manage/link")
+
+    @classmethod
+    def send_update_subscription_link(cls, subscription_code):
+        """
+        Email a customer a link for updating the card on their subscription
+        
+        Args:
+            subscription_code: subscription code.
+        
+        Returns:
+            Json data from paystack API.
+        """
+        return cls().requests.post(f"subscription/{subscription_code}/manage/email")

paystackapi/tests/test_subscription.py

@@ -82,3 +82,29 @@ def test_enable(self):
 
         response = Subscription.enable(code="SUB_vsyqdmlzble3uii", token="d7gofp6yppn3qz7")
         self.assertEqual(response['status'], True)
+
+    @httpretty.activate
+    def test_generate_update_subscription_link(self):
+        """Function defined to test generation of a link for updating the card on a subscription"""
+        httpretty.register_uri(
+            httpretty.GET,
+            self.endpoint_url("/subscription/SUB_vsyqdmlzble3uii/manage/link"),
+            content_type='text/json',
+            status=200,
+        )
+
+        response = Subscription.generate_update_subscription_link(subscription_code='SUB_vsyqdmlzble3uii')
+        self.assertEqual(response['status'], True)
+
+    @httpretty.activate
+    def test_send_update_subscription_link(self):
+        """Function defined to test emailing a customer a link for updating the card on their subscription"""
+        httpretty.register_uri(
+            httpretty.POST,
+            self.endpoint_url("/subscription/SUB_vsyqdmlzble3uii/manage/email"),
+            content_type='text/json',
+            status=200,
+        )
+
+        response = Subscription.send_update_subscription_link(subscription_code='SUB_vsyqdmlzble3uii')
+        self.assertEqual(response['status'], True)