Strongly typed Lists

SendGrid/Example/Program.cs

@@ -42,6 +42,7 @@ private static void Main()
             UnsubscribeGroups(httpClient);
             GlobalSuppressions(httpClient);
             GlobalStats(httpClient);
+            Lists(httpClient);
         }
 
         private static void SendAsync(SendGrid.SendGridMessage message)
@@ -236,5 +237,37 @@ private static void GlobalStats(HttpClient httpClient)
             Console.WriteLine("\n\nPress any key to continue");
             Console.ReadKey();
         }
+
+        private static void Lists(HttpClient httpClient)
+        {
+            Console.WriteLine("\n***** LISTS *****");
+
+            var apiKey = Environment.GetEnvironmentVariable("SENDGRID_APIKEY", EnvironmentVariableTarget.User);
+            var client = new SendGrid.Client(apiKey: apiKey, httpClient: httpClient);
+
+            var firstList = client.Lists.CreateAsync("My first list").Result;
+            Console.WriteLine("List '{0}' created. Id: {1}", firstList.Name, firstList.Id);
+
+            var secondList = client.Lists.CreateAsync("My second list").Result;
+            Console.WriteLine("List '{0}' created. Id: {1}", secondList.Name, secondList.Id);
+
+            client.Lists.UpdateAsync(firstList.Id, "New name").Wait();
+            Console.WriteLine("List '{0}' updated", firstList.Id);
+
+            var lists = client.Lists.GetAllAsync().Result;
+            Console.WriteLine("All lists retrieved. There are {0} lists", lists.Length);
+
+            client.Lists.DeleteAsync(firstList.Id).Wait();
+            Console.WriteLine("List {0} deleted", firstList.Id);
+
+            client.Lists.DeleteAsync(secondList.Id).Wait();
+            Console.WriteLine("List {0} deleted", secondList.Id);
+
+            lists = client.Lists.GetAllAsync().Result;
+            Console.WriteLine("All lists retrieved. There are {0} lists", lists.Length);
+
+            Console.WriteLine("\n\nPress any key to continue");
+            Console.ReadKey();
+        }
     }
 }

SendGrid/SendGrid/Client.cs

@@ -30,6 +30,7 @@ private enum Methods
         public User User { get; private set; }
         public CustomFields CustomFields { get; private set; }
         public Contacts Contacts { get; private set; }
+        public Lists Lists { get; private set; }
         public string Version { get; private set; }
 
         /// <summary>
@@ -52,6 +53,7 @@ public Client(string apiKey, string baseUri = "https://api.sendgrid.com/", HttpC
             Contacts = new Contacts(this);
             Bounces = new Bounces(this);
             CustomFields = new CustomFields(this);
+            Lists = new Lists(this);
 
             _httpClient = httpClient ?? new HttpClient();
             _httpClient.BaseAddress = _baseUri;

SendGrid/SendGrid/Model/List.cs

@@ -0,0 +1,16 @@
+using Newtonsoft.Json;
+
+namespace SendGrid.Model
+{
+    public class List
+    {
+        [JsonProperty("id")]
+        public long Id { get; set; }
+
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("recipient_count")]
+        public long RecipientCount { get; set; }
+    }
+}

SendGrid/SendGrid/Resources/Lists.cs

@@ -0,0 +1,184 @@
+using Newtonsoft.Json.Linq;
+using SendGrid.Model;
+using SendGrid.Utilities;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
+using System.Threading.Tasks;
+using System.Web;
+
+namespace SendGrid.Resources
+{
+    public class Lists
+    {
+        private string _endpoint;
+        private Client _client;
+
+        /// <summary>
+        /// Constructs the SendGrid Lists object.
+        /// See https://sendgrid.com/docs/API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html
+        /// </summary>
+        /// <param name="client">SendGrid Web API v3 client</param>
+        /// <param name="endpoint">Resource endpoint, do not prepend slash</param>
+        public Lists(Client client, string endpoint = "v3/contactdb/lists")
+        {
+            _endpoint = endpoint;
+            _client = client;
+        }
+
+        public async Task<List> CreateAsync(string name)
+        {
+            var data = new JObject()
+            {
+                new JProperty("name", name)
+            };
+            var response = await _client.Post(_endpoint, data);
+            response.EnsureSuccess();
+
+            var responseContent = await response.Content.ReadAsStringAsync();
+            var bulkUpsertResult = JObject.Parse(responseContent).ToObject<List>();
+            return bulkUpsertResult;
+        }
+
+        public async Task<List[]> GetAllAsync()
+        {
+            var response = await _client.Get(_endpoint);
+            response.EnsureSuccess();
+
+            var responseContent = await response.Content.ReadAsStringAsync();
+
+            // Response looks like this:
+            // {
+            //  "lists": [
+            //    {
+            //      "id": 1,
+            //      "name": "the jones",
+            //      "recipient_count": 1
+            //    }
+            //  ]
+            //}
+            // We use a dynamic object to get rid of the 'lists' property and simply return an array of lists
+            dynamic dynamicObject = JObject.Parse(responseContent);
+            dynamic dynamicArray = dynamicObject.lists;
+
+            var lists = dynamicArray.ToObject<List[]>();
+            return lists;
+        }
+
+        public async Task DeleteAsync(long listId)
+        {
+            var response = await _client.Delete(string.Format("{0}/{1}", _endpoint, listId));
+            response.EnsureSuccess();
+        }
+
+        public async Task DeleteAsync(IEnumerable<long> recipientIds)
+        {
+            var data = new JArray(recipientIds.ToArray());
+            var response = await _client.Delete(_endpoint, data);
+            response.EnsureSuccess();
+        }
+
+        public async Task<List[]> GetAsync(int recordsPerPage = 100, int page = 1)
+        {
+            var query = HttpUtility.ParseQueryString(string.Empty);
+            query["page_size"] = recordsPerPage.ToString(CultureInfo.InvariantCulture);
+            query["page"] = page.ToString(CultureInfo.InvariantCulture);
+
+            var response = await _client.Get(string.Format("{0}?{1}", _endpoint, query));
+            response.EnsureSuccess();
+
+            var responseContent = await response.Content.ReadAsStringAsync();
+
+            // Response looks like this:
+            // {
+            //  "lists": [
+            //    {
+            //      "id": 1,
+            //      "name": "the jones",
+            //      "recipient_count": 1
+            //    }
+            //  ]
+            //}
+            // We use a dynamic object to get rid of the 'lists' property and simply return an array of lists
+            dynamic dynamicObject = JObject.Parse(responseContent);
+            dynamic dynamicArray = dynamicObject.lists;
+
+            var recipients = dynamicArray.ToObject<List[]>();
+            return recipients;
+        }
+
+        public async Task<List> GetAsync(long listId)
+        {
+            var response = await _client.Get(string.Format("{0}/{1}", _endpoint, listId));
+            response.EnsureSuccess();
+
+            var responseContent = await response.Content.ReadAsStringAsync();
+            var list = JObject.Parse(responseContent).ToObject<List>();
+            return list;
+        }
+
+        public async Task UpdateAsync(long listId, string name)
+        {
+            var data = new JObject()
+            {
+                new JProperty("name", name)
+            };
+            var response = await _client.Patch(string.Format("{0}/{1}", _endpoint, listId), data);
+            response.EnsureSuccess();
+        }
+
+        public async Task<Recipient[]> GetRecipientsAsync(long listId, int recordsPerPage = 100, int page = 1)
+        {
+            var query = HttpUtility.ParseQueryString(string.Empty);
+            query["page_size"] = recordsPerPage.ToString(CultureInfo.InvariantCulture);
+            query["page"] = page.ToString(CultureInfo.InvariantCulture);
+
+            var response = await _client.Get(string.Format("{0}/{1}/recipients?{2}", _endpoint, listId, query));
+            response.EnsureSuccess();
+
+            var responseContent = await response.Content.ReadAsStringAsync();
+
+            // Response looks like this:
+            // {
+            //	"recipients": [
+            //		{
+            //			"created_at": 1422395108,
+            //			"email": "e@example.com",
+            //			"first_name": "Ed",
+            //			"id": "YUBh",
+            //			"last_clicked": null,
+            //			"last_emailed": null,
+            //			"last_name": null,
+            //			"last_opened": null,
+            //			"updated_at": 1422395108
+            //		}
+            //	]
+            // }
+            // We use a dynamic object to get rid of the 'recipients' property and simply return an array of recipients
+            dynamic dynamicObject = JObject.Parse(responseContent);
+            dynamic dynamicArray = dynamicObject.recipients;
+
+            var recipients = dynamicArray.ToObject<Recipient[]>();
+            return recipients;
+        }
+
+        public async Task AddRecipientAsync(long listId, string recipientId)
+        {
+            var response = await _client.Post(string.Format("{0}/{1}/recipients/{2}", _endpoint, listId, recipientId), (JObject)null);
+            response.EnsureSuccess();
+        }
+
+        public async Task RemoveRecipientAsync(long listId, string recipientId)
+        {
+            var response = await _client.Delete(string.Format("{0}/{1}/recipients/{2}", _endpoint, listId, recipientId));
+            response.EnsureSuccess();
+        }
+
+        public async Task AddRecipientsAsync(long listId, IEnumerable<string> recipientIds)
+        {
+            var data = new JArray(recipientIds.ToArray());
+            var response = await _client.Post(string.Format("{0}/{1}/recipients", _endpoint, listId), data);
+            response.EnsureSuccess();
+        }
+    }
+}

SendGrid/SendGrid/SendGrid.csproj

@@ -69,6 +69,7 @@
     <Compile Include="Model\CustomField.cs" />
     <Compile Include="Model\FieldType.cs" />
     <Compile Include="Model\Bounce.cs" />
+    <Compile Include="Model\List.cs" />
     <Compile Include="Model\SuppressionGroup.cs" />
     <Compile Include="Model\Stats.cs" />
     <Compile Include="Model\Metrics.cs" />
@@ -79,6 +80,7 @@
     <Compile Include="Resources\CustomFields.cs" />
     <Compile Include="Resources\GlobalSuppressions.cs" />
     <Compile Include="Resources\GlobalStats.cs" />
+    <Compile Include="Resources\Lists.cs" />
     <Compile Include="Resources\Suppressions.cs" />
     <Compile Include="Resources\UnsubscribeGroups.cs" />
     <Compile Include="Resources\APIKeys.cs" />