[suppression_list] add ability to insert/update a single entry

Author: Ashu Goel

lib/suppression_list.ex

@@ -2,20 +2,49 @@ defmodule SparkPost.SuppressionList do
   @moduledoc """
   The SparkPost Suppression List API for working with suppression lists.
   Use `SparkPost.SuppressionList.delete/1` to delete a single entry from a list,
-  `SparkPost.SuppressionList.search/1` to search through your account's suppression list.
+  `SparkPost.SuppressionList.update_one/3` to insert or update a single list entry,
+  or `SparkPost.SuppressionList.search/1` to search through your account's suppression list.
 
   Check out the documentation for each function
   or use the [SparkPost API reference](https://developers.sparkpost.com/api/suppression_list.html) for details.
 
   Returned by `SparkPost.SuppressionList.delete/1`:
     - nothing (empty body)
 
+  Returned by `SparkPost.SuppressionList.update_one/3`:
+    - message (A success message string)
+
   Returned by `SparkPost.SuppressionList.search/1`.
     - %SparkPost.SuppressionList.SearchResult{}
   """
 
   alias SparkPost.Endpoint
 
+  @doc """
+  Insert or update a single entry in the suppression list.
+  Returns a single string with the success message if the entry
+  was updated or inserted. Returns a %SparkPost.Endpoint.Error{} with a 400
+  if the type is invalid.
+
+  Parameters:
+    - recipient: the email to insert or update in the suppression list
+    - type: one of "transactional" or "non_transactional"
+    - description (optional): optional description of this entry in the suppression list
+  """
+  def update_one(recipient, type, description \\ nil) do
+    body = if description == nil do
+      %{type: type}
+    else
+      %{type: type, description: description}
+    end
+    response = Endpoint.request(:put, "suppression-list/#{recipient}", body)
+    case response do
+      %SparkPost.Endpoint.Response{status_code: 200, results: results} ->
+        Map.get(results, :message, "")
+      _ -> response
+    end
+  end
+
   @doc """
   Deletes a specific entry from the list. Returns an empty string if
   the deletion was successful. Returns a %SparkPost.Endpoint.Error{} with a 404

test/data/suppressionlistupdate.json

@@ -0,0 +1,5 @@
+{
+  "results": {
+      "message": "Test response message"
+  }
+}

test/data/suppressionupdate_fail.json

@@ -0,0 +1,7 @@
+{
+  "errors": [
+    {
+        "message": "Type must be one of: 'transactional', 'non_transactional'"
+    }
+  ]
+}

test/suppression_list_test.exs

@@ -8,6 +8,28 @@ defmodule SparkPost.SuppressionListTest do
 
   import Mock
 
+  test_with_mock "SuppressionList.update_one succeeds with message",
+    HTTPoison, [request: fn (method, url, body, headers, opts) ->
+      assert method == :put
+      fun = MockServer.mk_http_resp(200, MockServer.get_json("suppressionlistupdate"))
+      fun.(method, url, body, headers, opts)
+    end] do
+    resp = SuppressionList.update_one("test@marketing.com", "non_transactional", "test description")
+    assert resp == "Test response message"
+  end
+
+  test_with_mock "SuppressionList.update_one fails with invalid type",
+    HTTPoison, [request: fn (method, url, body, headers, opts) ->
+      assert method == :put
+      fun = MockServer.mk_http_resp(400, MockServer.get_json("suppressionupdate_fail"))
+      fun.(method, url, body, headers, opts)
+    end] do
+    resp = SuppressionList.update_one("test@marketing.com", "bad_type")
+    assert %SparkPost.Endpoint.Error{} = resp
+    assert resp.status_code == 400
+    assert resp.errors == [%{message: "Type must be one of: 'transactional', 'non_transactional'"}]
+  end
+
   test_with_mock "SuppressionList.delete succeeds with empty body",
     HTTPoison, [request: fn (method, url, body, headers, opts) ->
       assert method == :delete