Strongly typed 'Suppression'

SendGrid/Example/Program.cs

@@ -31,7 +31,7 @@ private static void Main()
                     UseProxy = useFiddler
                 }
             );
-            
+
             // Test sending email 
             var to = "example@example.com";
             var from = "example@example.com";
@@ -40,7 +40,6 @@ private static void Main()
             // Test viewing, creating, modifying and deleting API keys through our v3 Web API 
             ApiKeys(httpClient);
             UnsubscribeGroups(httpClient);
-            Suppressions(httpClient);
             GlobalSuppressions(httpClient);
             GlobalStats(httpClient);
         }
@@ -132,20 +131,48 @@ private static void UnsubscribeGroups(HttpClient httpClient)
 
             // CREATE A NEW SUPPRESSION GROUP
             var newGroup = client.UnsubscribeGroups.CreateAsync("New group", "This is a new group for testing purposes", false).Result;
-            Console.WriteLine("Unique ID of the new suppresion group: {0}", newGroup.Id);
-            
+            Console.WriteLine("Unique ID of the new unsubscribe group: {0}", newGroup.Id);
+
             // UPDATE A SUPPRESSION GROUP
             var updatedGroup = client.UnsubscribeGroups.UpdateAsync(newGroup.Id, "This is the updated name").Result;
-            Console.WriteLine("Suppresion group {0} updated", updatedGroup.Id);
+            Console.WriteLine("Unsubscribe group {0} updated", updatedGroup.Id);
 
             // GET UNSUBSCRIBE GROUPS
             var groups = client.UnsubscribeGroups.GetAllAsync().Result;
-            Console.WriteLine("There are {0} suppresion groups", groups.Length);
+            Console.WriteLine("There are {0} unsubscribe groups", groups.Length);
 
             // GET A PARTICULAR UNSUBSCRIBE GROUP
             var group = client.UnsubscribeGroups.GetAsync(newGroup.Id).Result;
             Console.WriteLine("Retrieved unsubscribe group {0}: {1}", group.Id, group.Name);
 
+            // ADD A FEW ADDRESSES TO UNSUBSCRIBE GROUP
+            client.Suppressions.AddAddressToUnsubscribeGroupAsync(group.Id, "test1@example.com").Wait();
+            Console.WriteLine("Added test1@example.com to unsubscribe group {0}", group.Id);
+            client.Suppressions.AddAddressToUnsubscribeGroupAsync(group.Id, "test2@example.com").Wait();
+            Console.WriteLine("Added test2@example.com to unsubscribe group {0}", group.Id);
+
+            // GET THE ADDRESSES IN A GROUP
+            var unsubscribedAddresses = client.Suppressions.GetUnsubscribedAddressesAsync(group.Id).Result;
+            Console.WriteLine("There are {0} unsubscribed addresses in group {1}", unsubscribedAddresses.Length, group.Id);
+
+            // REMOVE ALL ADDRESSES FROM UNSUBSCRIBE GROUP
+            foreach (var address in unsubscribedAddresses)
+            {
+                client.Suppressions.RemoveAddressFromSuppressionGroupAsync(group.Id, address).Wait();
+                Console.WriteLine("{0} removed from unsubscribe group {1}", address, group.Id);
+            }
+
+            // MAKE SURE THERE ARE NO ADDRESSES IN THE GROUP
+            unsubscribedAddresses = client.Suppressions.GetUnsubscribedAddressesAsync(group.Id).Result;
+            if (unsubscribedAddresses.Length == 0)
+            {
+                Console.WriteLine("As expected, there are no more addresses in group {0}", group.Id);
+            }
+            else
+            {
+                Console.WriteLine("We expected the group {1} to be empty but instead we found {0} unsubscribed addresses.", unsubscribedAddresses.Length, group.Id);
+            }
+
             // DELETE UNSUBSCRIBE GROUP
             client.UnsubscribeGroups.DeleteAsync(newGroup.Id).Wait();
             Console.WriteLine("Suppression group {0} deleted", newGroup.Id);
@@ -154,42 +181,6 @@ private static void UnsubscribeGroups(HttpClient httpClient)
             Console.ReadKey();
         }
 
-        private static void Suppressions(HttpClient httpClient)
-        {
-            String apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
-            var client = new SendGrid.Client(apiKey);
-
-            // GET SUPPRESSED ADDRESSES FOR A GIVEN GROUP
-            int groupID = 69;
-            HttpResponseMessage responseGetUnique = client.Suppressions.Get(groupID).Result;
-            Console.WriteLine(responseGetUnique.StatusCode);
-            Console.WriteLine(responseGetUnique.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("These are the suppressed emails with group ID: " + groupID.ToString() + ". Press any key to continue.");
-            Console.ReadKey();
-
-            // ADD EMAILS TO A SUPPRESSION GROUP
-            string[] emails = { "example@example.com", "example2@example.com" };
-            HttpResponseMessage responsePost = client.Suppressions.Post(groupID, emails).Result;
-            var rawString = responsePost.Content.ReadAsStringAsync().Result;
-            dynamic jsonObject = JObject.Parse(rawString);
-            Console.WriteLine(responsePost.StatusCode);
-            Console.WriteLine(responsePost.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("Emails added to Suppression Group:" + groupID.ToString() + ".\n\nPress any key to continue.");
-            Console.ReadKey();
-
-            // DELETE EMAILS FROM A SUPPRESSION GROUP
-            Console.WriteLine("Deleting emails from Suppression Group, please wait.");
-            HttpResponseMessage responseDelete1 = client.Suppressions.Delete(groupID, "example@example.com").Result;
-            Console.WriteLine(responseDelete1.StatusCode);
-            HttpResponseMessage responseDelete2 = client.Suppressions.Delete(groupID, "example2@example.com").Result;
-            Console.WriteLine(responseDelete2.StatusCode);
-            HttpResponseMessage responseFinal = client.Suppressions.Get(groupID).Result;
-            Console.WriteLine(responseFinal.StatusCode);
-            Console.WriteLine(responseFinal.Content.ReadAsStringAsync().Result);
-            Console.WriteLine("Emails removed from Suppression Group" + groupID.ToString() + "Deleted.\n\nPress any key to end.");
-            Console.ReadKey();
-        }
-
         private static void GlobalSuppressions(HttpClient httpClient)
         {
             Console.WriteLine("\n***** GLOBAL SUPPRESSION *****");

SendGrid/SendGrid/Resources/Suppressions.cs

@@ -1,6 +1,8 @@
-using System.Net.Http;
+using Newtonsoft.Json.Linq;
+using SendGrid.Utilities;
+using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
-using Newtonsoft.Json.Linq;
 
 namespace SendGrid.Resources
 {
@@ -26,9 +28,27 @@ public Suppressions(Client client, string endpoint = "v3/asm/groups")
         /// </summary>
         /// <param name="groupId">ID of the suppression group</param>
         /// <returns>https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/suppressions.html</returns>
-        public async Task<HttpResponseMessage> Get(int groupId)
+        public async Task<string[]> GetUnsubscribedAddressesAsync(int groupId)
         {
-            return await _client.Get(_endpoint + "/" + groupId.ToString() + "/suppressions");
+            var response = await _client.Get(string.Format("{0}/{1}/suppressions", _endpoint, groupId));
+            response.EnsureSuccess();
+
+            var responseContent = await response.Content.ReadAsStringAsync();
+            var suppressedAddresses = JArray.Parse(responseContent).ToObject<string[]>();
+            return suppressedAddresses;
+        }
+
+        /// <summary>
+        /// Add recipient address to the suppressions list for a given group.
+        /// 
+        /// If the group has been deleted, this request will add the address to the global suppression.
+        /// </summary>
+        /// <param name="groupId">ID of the suppression group</param>
+        /// <param name="email">Email address to add to the suppression group</param>
+        /// <returns>https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/suppressions.html</returns>
+        public async Task AddAddressToUnsubscribeGroupAsync(int groupId, string email)
+        {
+            await AddAddressToUnsubscribeGroupAsync(groupId, new[] { email });
         }
 
         /// <summary>
@@ -37,24 +57,25 @@ public async Task<HttpResponseMessage> Get(int groupId)
         /// If the group has been deleted, this request will add the address to the global suppression.
         /// </summary>
         /// <param name="groupId">ID of the suppression group</param>
-        /// <param name="recipient_emails">Array of email addresses to add to the suppression group</param>
+        /// <param name="emails">Email addresses to add to the suppression group</param>
         /// <returns>https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/suppressions.html</returns>
-        public async Task<HttpResponseMessage> Post(int groupId, string[] emails)
+        public async Task AddAddressToUnsubscribeGroupAsync(int groupId, IEnumerable<string> emails)
         {
-            JArray receipient_emails = new JArray();
-            foreach (string email in emails) { receipient_emails.Add(email); }
-            var data = new JObject(new JProperty("recipient_emails", receipient_emails));
-            return await _client.Post(_endpoint + "/" + groupId.ToString() + "/suppressions", data);
+            var data = new JObject(new JProperty("recipient_emails", new JArray(emails.ToArray())));
+            var response = await _client.Post(string.Format("{0}/{1}/suppressions", _endpoint, groupId), data);
+            response.EnsureSuccess();
         }
 
         /// <summary>
-        /// Delete a suppression group.
+        /// Delete a recipient email from the suppressions list for a group.
         /// </summary>
         /// <param name="groupId">ID of the suppression group to delete</param>
+        /// <param name="email">Email address to remove from the suppression group</param>
         /// <returns>https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/suppressions.html</returns>
-        public async Task<HttpResponseMessage> Delete(int groupId, string email)
+        public async Task RemoveAddressFromSuppressionGroupAsync(int groupId, string email)
         {
-            return await _client.Delete(_endpoint + "/" + groupId.ToString() + "/suppressions/" + email);
+            var response = await _client.Delete(string.Format("{0}/{1}/suppressions/{2}", _endpoint, groupId, email));
+            response.EnsureSuccess();
         }
     }
 }