Add Help Center API support

Tests/HelpCenter/ArticleTests.cs

@@ -0,0 +1,72 @@
+using NUnit.Framework;
+using ZendeskApi_v2;
+using ZendeskApi_v2.Models.Articles;
+
+namespace Tests.HelpCenter
+{
+	[TestFixture]
+	public class ArticleTests
+	{
+		private ZendeskApi api = new ZendeskApi(Settings.Site, Settings.Email, Settings.Password);
+
+		[Test]
+		public void CanGetArticles()
+		{
+			var res = api.HelpCenter.Articles.GetArticles();
+			Assert.Greater(res.Count, 0);
+
+            var resSections = api.HelpCenter.Sections.GetSections();
+            var res1 = api.HelpCenter.Articles.GetArticlesBySectionId(resSections.Sections[0].Id.Value);
+			Assert.AreEqual(res1.Articles[0].SectionId, resSections.Sections[0].Id);
+		}
+
+		[Test]
+		public void CanCreateUpdateAndDeleteArticles()
+		{
+			var resSections = api.HelpCenter.Sections.GetSections();
+            var res = api.HelpCenter.Articles.CreateArticle(resSections.Sections[0].Id.Value, new Article()
+			{
+				Title = "My Test article",
+				Body = "The body of my article",
+				Locale = "en-us"
+			});
+			Assert.Greater(res.Arcticle.Id, 0);
+
+			res.Arcticle.Body = "updated body";
+            var update = api.HelpCenter.Articles.UpdateArticle(res.Arcticle);
+			Assert.AreEqual(update.Arcticle.Body, res.Arcticle.Body);
+
+            Assert.True(api.HelpCenter.Articles.DeleteArticle(res.Arcticle.Id.Value));
+		}
+
+		[Test]
+		public void CanGetArticlesAsync()
+		{
+            var res = api.HelpCenter.Articles.GetArticlesAsync().Result;
+			Assert.Greater(res.Count, 0);
+
+            var resSections = api.HelpCenter.Sections.GetSectionsAsync().Result;
+            var res1 = api.HelpCenter.Articles.GetArticlesBySectionIdAsync(resSections.Sections[0].Id.Value);
+			Assert.AreEqual(res1.Result.Articles[0].SectionId, resSections.Sections[0].Id);
+		}
+
+		[Test]
+		public void CanCreateUpdateAndDeleteArticlesAsync()
+		{
+            var resSections = api.HelpCenter.Sections.GetSectionsAsync().Result;
+            var res = api.HelpCenter.Articles.CreateArticleAsync(resSections.Sections[0].Id.Value, new Article()
+			{
+				Title = "My Test article",
+				Body = "The body of my article",
+				Locale = "en-us"
+			}).Result;
+			Assert.Greater(res.Arcticle.Id, 0);
+
+			res.Arcticle.Body = "updated body";
+            var update = api.HelpCenter.Articles.UpdateArticleAsync(res.Arcticle).Result;
+			Assert.AreEqual(update.Arcticle.Body, res.Arcticle.Body);
+
+            Assert.True(api.HelpCenter.Articles.DeleteArticleAsync(res.Arcticle.Id.Value).Result);
+		}
+	}
+}

Tests/HelpCenter/CategoryTests.cs

@@ -0,0 +1,38 @@
+using NUnit.Framework;
+using ZendeskApi_v2;
+using ZendeskApi_v2.Models.HelpCenter.Categories;
+
+namespace Tests.HelpCenter
+{
+   [TestFixture]
+   public class CategoryTests
+   {
+      private ZendeskApi api = new ZendeskApi(Settings.Site, Settings.Email, Settings.Password);
+
+      [Test]
+      public void CanGetCategories()
+      {
+         var res = api.HelpCenter.Categories.GetCategories();
+         Assert.Greater(res.Count, 0);
+
+         var res1 = api.HelpCenter.Categories.GetCategoryById(res.Categories[0].Id.Value);
+         Assert.AreEqual(res1.Category.Id, res.Categories[0].Id);
+      }
+
+      [Test]
+      public void CanCreateUpdateAndDeleteCategories()
+      {
+         var res = api.HelpCenter.Categories.CreateCategory(new Category()
+         {
+            Name = "My Test category"
+         });
+         Assert.Greater(res.Category.Id, 0);
+
+         res.Category.Description = "updated description";
+         var update = api.HelpCenter.Categories.UpdateCategory(res.Category);
+         Assert.AreEqual(update.Category.Description, res.Category.Description);
+
+         Assert.True(api.HelpCenter.Categories.DeleteCategory(res.Category.Id.Value));
+      }
+   }
+}

Tests/Tests.csproj

@@ -64,12 +64,14 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="HelpCenter\ArticleTests.cs" />
     <Compile Include="AttachmentTests.cs" />
     <Compile Include="CategoryTests.cs" />
     <Compile Include="CoreTests.cs" />
     <Compile Include="CustomRolesTests.cs" />
     <Compile Include="ForumTests.cs" />
     <Compile Include="GroupTests.cs" />
+    <Compile Include="HelpCenter\CategoryTests.cs" />
     <Compile Include="JobStatusTests.cs" />
     <Compile Include="LocaleTests.cs" />
     <Compile Include="MacroTests.cs" />

ZendeskApi_v2/Core.cs

@@ -140,7 +140,7 @@ protected T GenericGet<T>(string resource)
         protected bool GenericDelete(string resource)
         {
             var res = RunRequest(resource, "DELETE");
-            return res.HttpStatusCode == HttpStatusCode.OK;            
+            return res.HttpStatusCode == HttpStatusCode.OK || res.HttpStatusCode == HttpStatusCode.NoContent;
         }
 
         protected T GenericPost<T>(string resource, object body=null)
@@ -267,7 +267,7 @@ protected async Task<T> GenericGetAsync<T>(string resource)
         protected async Task<bool> GenericDeleteAsync(string resource)
         {
             var res = RunRequestAsync(resource, "DELETE");
-            return await res.ContinueWith(x => x.Result.HttpStatusCode == HttpStatusCode.OK);
+            return await res.ContinueWith(x => x.Result.HttpStatusCode == HttpStatusCode.OK || x.Result.HttpStatusCode == HttpStatusCode.NoContent);
         }
 
         protected async Task<T> GenericPostAsync<T>(string resource, object body = null)

ZendeskApi_v2/HelpCenterApi.cs

@@ -0,0 +1,30 @@
+using ZendeskApi_v2.Requests.HelpCenter;
+namespace ZendeskApi_v2.HelpCenter
+{
+    public interface IHelpCenterApi
+    {
+        ICategories Categories { get; }
+        ISections Sections { get; }
+        IArticles Articles { get; }
+
+        string Locale { get; }
+    }
+
+    public class HelpCenterApi : IHelpCenterApi
+    {
+        public ICategories Categories { get; set; }
+        public ISections Sections { get; set; }
+        public IArticles Articles { get; set; }
+
+        public string Locale { get; set; }
+
+        public HelpCenterApi(string yourZendeskUrl, string user, string password, string apiToken, string locale)
+        {
+            Categories = new Categories(yourZendeskUrl, user, password, apiToken, locale);
+            Sections = new Sections(yourZendeskUrl, user, password, apiToken);
+            Articles = new Articles(yourZendeskUrl, user, password, apiToken);
+
+            Locale = locale;
+        }
+    }
+}

ZendeskApi_v2/Models/Articles/Article.cs

@@ -0,0 +1,47 @@
+using Newtonsoft.Json;
+
+namespace ZendeskApi_v2.Models.Articles
+{
+
+	public class Article
+	{
+		[JsonProperty("id")]
+		public long? Id { get; set; }
+
+		[JsonProperty("title")]
+		public string Title { get; set; }
+
+		[JsonProperty("body")]
+		public string Body { get; set; }
+
+		[JsonProperty("locale")]
+		public string Locale { get; set; }
+
+		[JsonProperty("author_id")]
+		public long? AuthorId { get; set; }
+
+		[JsonProperty("comments_disabled")]
+		public bool CommentsDisabled { get; set; }
+
+		[JsonProperty("promoted")]
+		public bool Promoted { get; set; }
+
+		[JsonProperty("position")]
+		public int Position { get; set; }
+
+		[JsonProperty("vote_sum")]
+		public int VoteSum { get; set; }
+
+		[JsonProperty("vote_count")]
+		public int VoteCount { get; set; }
+
+		[JsonProperty("section_id")]
+		public long? SectionId { get; set; }
+
+		[JsonProperty("created_at")]
+		public string CreatedAt { get; set; }
+
+		[JsonProperty("updated_at")]
+		public string UpdatedAt { get; set; }
+	}
+}

ZendeskApi_v2/Models/Articles/GroupArticleResponse.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using Newtonsoft.Json;
+
+namespace ZendeskApi_v2.Models.Articles
+{
+
+	public class GroupArticleResponse : GroupResponseBase
+	{
+
+		[JsonProperty("articles")]
+		public IList<Article> Articles { get; set; }
+	}
+}

ZendeskApi_v2/Models/Articles/IndividualArticleResponse.cs

@@ -0,0 +1,11 @@
+using Newtonsoft.Json;
+
+namespace ZendeskApi_v2.Models.Articles
+{
+	public class IndividualArticleResponse
+	{
+
+		[JsonProperty("article")]
+		public Article Arcticle { get; set; }
+	}
+}

ZendeskApi_v2/Models/Constants/Visibility.cs

@@ -0,0 +1,9 @@
+namespace ZendeskApi_v2.Models.Constants
+{
+	public static class Visibility
+	{
+		public const string Public = "public";
+		public const string Restricted = "restricted";
+		public const string Internet = "internal";
+	}
+}

ZendeskApi_v2/Models/HelpCenter/Categories/Category.cs

@@ -0,0 +1,49 @@
+// Generated by Xamasoft JSON Class Generator
+// http://www.xamasoft.com/json-class-generator
+
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace ZendeskApi_v2.Models.HelpCenter.Categories
+{
+
+    public class Category
+    {
+
+        [JsonProperty("id")]
+        public long? Id { get; set; }
+
+        [JsonProperty("url")]
+        public string Url { get; set; }
+
+        [JsonProperty("html_url")]
+        public string HtmlUrl { get; set; }
+
+        [JsonProperty("position")]
+        public int? Position { get; set; }
+
+        [JsonProperty("created_at")]
+        public string CreatedAt { get; set; }
+
+        [JsonProperty("updated_at")]
+        public string UpdatedAt { get; set; }
+
+        [JsonProperty("name")]
+        public string Name { get; set; }
+
+        [JsonProperty("description")]
+        public string Description { get; set; }
+
+        [JsonProperty("locale")]
+        public string Locale { get; set; }
+
+        [JsonProperty("source_locale")]
+        public string SourceLocale { get; set; }
+
+        [JsonProperty("outdated")]
+        public bool Outdated { get; set; }
+    }
+
+}

ZendeskApi_v2/Models/HelpCenter/Categories/GroupCategoryResponse.cs

@@ -0,0 +1,18 @@
+// JSON C# Class Generator
+// http://at-my-window.blogspot.com/?page=json-class-generator
+
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace ZendeskApi_v2.Models.HelpCenter.Categories
+{
+
+   public class GroupCategoryResponse : GroupResponseBase
+   {
+
+      [JsonProperty("categories")]
+      public IList<Category> Categories { get; set; }
+   }
+}

ZendeskApi_v2/Models/HelpCenter/Categories/IndividualCategoryResponse.cs

@@ -0,0 +1,11 @@
+using Newtonsoft.Json;
+
+namespace ZendeskApi_v2.Models.HelpCenter.Categories
+{
+   public class IndividualCategoryResponse
+   {
+
+      [JsonProperty("category")]
+      public Category Category { get; set; }
+   }
+}

ZendeskApi_v2/Models/Sections/GroupSectionResponse.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+
+namespace ZendeskApi_v2.Models.Sections
+{
+
+	public class GroupSectionResponse : GroupResponseBase
+	{
+
+		[JsonProperty("sections")]
+		public IList<Section> Sections { get; set; }
+	}
+}

ZendeskApi_v2/Models/Sections/IndividualSectionResponse.cs

@@ -0,0 +1,12 @@
+using Newtonsoft.Json;
+using ZendeskApi_v2.Models.Categories;
+
+namespace ZendeskApi_v2.Models.Sections
+{
+	public class IndividualSectionResponse
+	{
+
+		[JsonProperty("section")]
+		public Section Section { get; set; }
+	}
+}