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

Add Projects API client (preview)
This commit is contained in:
Martin Scholz
2017-07-23 00:18:34 +02:00
committed by Ryan Gribble
parent fc5bc947aa
commit 329ef960ed
45 changed files with 5821 additions and 2 deletions

View File

@@ -0,0 +1,82 @@
using System;
using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
/// <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 interface IObservableProjectCardsClient
{
/// <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>
IObservable<ProjectCard> GetAll(int columnId);
/// <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>
IObservable<ProjectCard> GetAll(int columnId, ApiOptions 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>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
IObservable<ProjectCard> Get(int id);
/// <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>
IObservable<ProjectCard> Create(int columnId, NewProjectCard newProjectCard);
/// <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>
IObservable<ProjectCard> Update(int id, ProjectCardUpdate projectCardUpdate);
/// <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>
IObservable<bool> Delete(int id);
/// <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>
IObservable<bool> Move(int id, ProjectCardMove position);
}
}