[WIP] Add new Project API Preview (#1480)

Add Projects API client (preview)
2026-06-07 12:26:18 +00:00 · 2017-07-23 00:18:34 +02:00
parent fc5bc947aa
commit 329ef960ed
45 changed files with 5821 additions and 2 deletions
@@ -0,0 +1,135 @@
+using System.Collections.Generic;
+using System.Net;
+using System.Threading.Tasks;
+
+namespace Octokit
+{
+    /// <summary>
+    /// A client for GitHub's Project Cards API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="https://developer.github.com/v3/repos/projects/cards/">Repository Projects API documentation</a> for more information.
+    /// </remarks>
+    public class ProjectCardsClient : ApiClient, IProjectCardsClient
+    {
+        public ProjectCardsClient(IApiConnection apiConnection) :
+            base(apiConnection)
+        {
+        }
+
+        /// <summary>
+        /// Gets all cards.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#list-projects-cards">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="columnId">The id of the column</param>
+        public Task<IReadOnlyList<ProjectCard>> GetAll(int columnId)
+        {
+            return GetAll(columnId, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all cards.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#list-projects-cards">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="columnId">The id of the column</param>
+        /// <param name="options">Options for changing the API response</param>
+        public Task<IReadOnlyList<ProjectCard>> GetAll(int columnId, ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+
+            return ApiConnection.GetAll<ProjectCard>(ApiUrls.ProjectCards(columnId), new Dictionary<string, string>(), AcceptHeaders.ProjectsApiPreview, options);
+        }
+
+        /// <summary>
+        /// Gets a single card.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#get-a-project-card">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="id">The id of the card</param>
+        public Task<ProjectCard> Get(int id)
+        {
+            return ApiConnection.Get<ProjectCard>(ApiUrls.ProjectCard(id), null, AcceptHeaders.ProjectsApiPreview);
+        }
+
+        /// <summary>
+        /// Creates a card.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#create-a-project-card">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="columnId">The id of the column</param>
+        /// <param name="newProjectCard">The card to create</param>
+        public Task<ProjectCard> Create(int columnId, NewProjectCard newProjectCard)
+        {
+            Ensure.ArgumentNotNull(newProjectCard, "newProjectCard");
+
+            return ApiConnection.Post<ProjectCard>(ApiUrls.ProjectCards(columnId), newProjectCard, AcceptHeaders.ProjectsApiPreview);
+        }
+
+        /// <summary>
+        /// Updates a card.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#update-a-project-card">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="id">The id of the card</param>
+        /// <param name="projectCardUpdate">New values to update the card with</param>
+        public Task<ProjectCard> Update(int id, ProjectCardUpdate projectCardUpdate)
+        {
+            Ensure.ArgumentNotNull(projectCardUpdate, "projectCardUpdate");
+
+            return ApiConnection.Patch<ProjectCard>(ApiUrls.ProjectCard(id), projectCardUpdate, AcceptHeaders.ProjectsApiPreview);
+        }
+
+        /// <summary>
+        /// Deletes a card.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#delete-a-project-card">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="id">The id of the card</param>
+        public async Task<bool> Delete(int id)
+        {
+            var endpoint = ApiUrls.ProjectCard(id);
+
+            try
+            {
+                var httpStatusCode = await Connection.Delete(endpoint, new object(), AcceptHeaders.ProjectsApiPreview).ConfigureAwait(false);
+                return httpStatusCode == HttpStatusCode.NoContent;
+            }
+            catch (NotFoundException)
+            {
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Moves a card.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/projects/#move-a-project-card">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="id">The id of the card</param>
+        /// <param name="position">The position to move the card</param>
+        public async Task<bool> Move(int id, ProjectCardMove position)
+        {
+            Ensure.ArgumentNotNull(position, "position");
+
+            var endpoint = ApiUrls.ProjectCardMove(id);
+            try
+            {
+                var httpStatusCode = await Connection.Post(endpoint, position, AcceptHeaders.ProjectsApiPreview).ConfigureAwait(false);
+                return httpStatusCode == HttpStatusCode.Created;
+            }
+            catch (NotFoundException)
+            {
+                return false;
+            }
+        }
+    }
+}