Merge pull request #125 from thinkingserious/asm_suppressions_delete

Asm suppressions delete

Author: thinkingserious

README.rst

@@ -261,6 +261,36 @@ Get a single record.
 .. code:: python
 
     status, msg = client.asm_groups.get(record_id)
+    
+ASM Suppressions
+~~~~~~~~~~~~~~~~
+
+Suppressions are email addresses that can be added to groups to prevent certain types of emails from being delivered to those addresses.
+
+Add recipient addresses to the suppressions list for a given group.
+
+.. code:: python
+    
+    client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
+    group_id = <group_id_number> # If no group_id_number, the emails will be added to the global suppression group
+    emails = ['elmer+test@thinkingserious.com', 'elmer+test2@thinkingserious.com']
+    status, msg = client.asm_suppressions.post(group_id, emails)
+
+Get suppressed addresses for a given group.
+
+.. code:: python
+
+    status, msg = client.asm_suppressions.get(<group_id>)
+
+Get suppression groups associated with a given recipient address.
+
+.. code:: python
+
+    status, msg = client.asm_suppressions.get(None,<email_address>)
+    
+Delete a recipient email from the suppressions list for a group.
+
+    status, msg = client.asm_suppressions.delete(<group_id>,<email_address>)
 
 SendGrid's `X-SMTPAPI`_
 -----------------------

example_v3_test.py

@@ -12,12 +12,17 @@
 
 client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
 
-status, msg = client.asm_suppressions.post(60, ['elmer+test@thinkingserious.com', 'elmer.thomas@yahoo.com'])
+status, msg = client.asm_suppressions.delete(67,'elmer+test@thinkingserious.com')
 print status
 print msg
 
 """
 
+status, msg = client.asm_suppressions.post(60, ['elmer+test@thinkingserious.com', 'elmer.thomas@yahoo.com'])
+print status
+print msg
+
+
 status, msg = client.asm_suppressions.get(None,'elmer.thomas@yahoo.com')
 print status
 print msg

sendgrid/resources/asm_suppressions.py

@@ -55,4 +55,9 @@ def post(self, id, emails):
         self._endpoint = self._base_endpoint + "/" + str(id) + "/suppressions"
         data = {}
         data["recipient_emails"] = emails
-        return self.client.post(self, data)
+        return self.client.post(self, data)
+
+    # Delete a recipient email from the suppressions list for a group.
+    def delete(self, id, email):
+        self.endpoint = self._base_endpoint + "/" + str(id) + "/suppressions/" + email
+        return self.client.delete(self)

test/test_asm_suppressions.py

@@ -36,6 +36,16 @@ def test_asm_suppressions_post(self):
         status, msg = self.client.asm_suppressions.post(id, emails)
         self.assertEqual(status, 201)
         self.assertEqual(msg['recipient_emails'], emails)
+        emails = ['elmer+test@thinkingserious.com', 'elmer.thomas@yahoo.com']
+        status, msg = self.client.asm_suppressions.post(id, emails)
+        self.assertEqual(status, 201)
+        self.assertEqual(msg['recipient_emails'], emails)
+        
+    def test_asm_supressions_delete(self):
+        id = 67
+        email = 'elmer+test@thinkingserious.com'
+        status, msg = self.client.asm_suppressions.delete(id, email)
+        self.assertEqual(status, 204)
 
 if __name__ == '__main__':
     unittest.main()