Adds logic to manage suppressions

docs/index.rst

@@ -28,6 +28,7 @@ Contents:
    django
    tornado
    spamcheck
+   suppression
    webhooks
    testing
    reference

docs/supression.rst

@@ -0,0 +1,77 @@
+.. _supression:
+
+Suppression API
+==============
+
+You can manage Postmark's Suppression lists with a few simple calls:
+
+To view the current suppression list:
+.. code-block:: python
+
+    >>> response = postmark.get_suppressions(stream_id="test")
+    >>> print(response['Suppressions'])
+    {
+      "Suppressions":[
+        {
+          "EmailAddress":"[email protected]",
+          "SuppressionReason":"ManualSuppression",
+          "Origin": "Recipient",
+          "CreatedAt":"2019-12-17T08:58:33-05:00"
+        },
+        {
+          "EmailAddress":"[email protected]",
+          "SuppressionReason":"HardBounce",
+          "Origin": "Recipient",
+          "CreatedAt":"2019-12-17T08:58:33-05:00"
+        },
+        {
+          "EmailAddress":"[email protected]",
+          "SuppressionReason":"SpamComplaint",
+          "Origin": "Recipient",
+          "CreatedAt":"2019-12-17T08:58:33-05:00"
+        }
+      ]
+    }
+You can filter this with  "SuppressionReason", "Origin", "todate", "fromdate", and "EmailAddress" lile:
+.. code-block:: python
+
+    >>> response = postmark.get_suppressions(stream_id="test", EmailAddress="[email protected]")
+    >>> print(response['Suppressions'])
+    {
+      "Suppressions":[
+        {
+          "EmailAddress":"[email protected]",
+          "SuppressionReason":"ManualSuppression",
+          "Origin": "Recipient",
+          "CreatedAt":"2019-12-17T08:58:33-05:00"
+        }
+      ]
+    }
+You can add a new suppression with:
+.. code-block:: python
+
+    >>> response = postmark.add_suppressions(stream_id="test", emails=["[email protected]"])
+    >>> print(response['Suppressions'])
+    {
+      "Suppressions":[
+        {
+          "EmailAddress":"[email protected]",
+          "Status":"Suppressed",
+          "Message": null
+        },
+      ]
+    }
+You can delete a suppression with:
+.. code-block:: python
+
+    >>> response = postmark.delete_suppressions(stream_id="test", emails=["[email protected]"])
+    >>> print(response['Suppressions'])
+    {
+      "Suppressions":[
+            {
+          "EmailAddress":"[email protected]",
+          "Status":"Deleted",
+          "Message": null
+        }
+      ]
+    }

src/postmarker/core.py

@@ -116,6 +116,31 @@ def spamcheck(self, dump, options="long"):
             raise SpamAssassinError(response["message"])
         return response
 
+    def get_suppressions(self, stream_id, **kwargs):
+        url = DEFAULT_API + f"/message-streams/{stream_id}/suppressions/dump"
+        response = self._call("GET", url, **kwargs)
+        return response
+
+    def add_suppression(self, stream_id, emails):
+        url = DEFAULT_API + f"/message-streams/{stream_id}/suppressions"
+        if type(emails) != list:
+            raise ValueError("emails must be of type list")
+        data = {'Suppressions': []}
+        for email in emails:
+            data['Suppressions'].append({'EmailAddress': email})
+        response = self._call("POST", url, "", data)
+        return response
+
+    def delete_suppression(self, stream_id, emails):
+        url = DEFAULT_API + f"/message-streams/{stream_id}/suppressions/delete"
+        if type(emails) != list:
+            raise ValueError("emails must be of type list")
+        data = {'Suppressions': []}
+        for email in emails:
+            data['Suppressions'].append({'EmailAddress': email})
+        response = self._call("POST", url, "", data)
+        return response
+
     def _call(self, method, root, endpoint, data=None, headers=None, **kwargs):
         default_headers = {"Accept": "application/json", "User-Agent": USER_AGENT}
         if headers: