mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
6565a07974
* Fixes ids for Releases, Collaborators, and Contributors * updates the interface for releases * update the obverable release client * updates ids from int to long based on GH database schema * converts a test condition to use the proper type * updates generated paging and observable classes
105 lines
4.6 KiB
C#
105 lines
4.6 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
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 interface IProjectCardsClient
|
|
{
|
|
/// <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>
|
|
Task<IReadOnlyList<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>
|
|
Task<IReadOnlyList<ProjectCard>> GetAll(int columnId, ApiOptions options);
|
|
|
|
/// <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="request">Used to filter the list of project cards returned</param>
|
|
Task<IReadOnlyList<ProjectCard>> GetAll(int columnId, ProjectCardRequest request);
|
|
|
|
/// <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="request">Used to filter the list of project cards returned</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<ProjectCard>> GetAll(int columnId, ProjectCardRequest request, 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")]
|
|
Task<ProjectCard> Get(long 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>
|
|
Task<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>
|
|
Task<ProjectCard> Update(long 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>
|
|
Task<bool> Delete(long 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>
|
|
Task<bool> Move(long id, ProjectCardMove position);
|
|
}
|
|
}
|