mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
6bb0408582
* reworks all number parameter names to represent what they actually are. Refactors some types to be the appropriate types based on OpenAPI and docs. * updates interfaces and implementations for id naming * updates reactive to match sync SDKs
84 lines
3.6 KiB
C#
84 lines
3.6 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Project Columns API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/projects/columns/">Repository Projects API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IProjectColumnsClient
|
|
{
|
|
/// <summary>
|
|
/// Gets all columns.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#list-project-columns">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="projectId">The Id of the project</param>
|
|
Task<IReadOnlyList<ProjectColumn>> GetAll(int projectId);
|
|
|
|
/// <summary>
|
|
/// Gets all columns.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#list-project-columns">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="projectId">The Id of the project</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<ProjectColumn>> GetAll(int projectId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets a single column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#get-a-project-column">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="columnId">The id of the column</param>
|
|
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
|
|
Task<ProjectColumn> Get(int columnId);
|
|
|
|
/// <summary>
|
|
/// Creates a column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#create-a-project-column">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="projectId">The Id of the project</param>
|
|
/// <param name="newProjectColumn">The column to create</param>
|
|
Task<ProjectColumn> Create(int projectId, NewProjectColumn newProjectColumn);
|
|
|
|
/// <summary>
|
|
/// Updates a column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#update-a-project-column">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="columnId">The id of the column</param>
|
|
/// <param name="projectColumnUpdate">New values to update the column with</param>
|
|
Task<ProjectColumn> Update(int columnId, ProjectColumnUpdate projectColumnUpdate);
|
|
|
|
/// <summary>
|
|
/// Deletes a column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#delete-a-project-column">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="columnId">The id of the column</param>
|
|
Task<bool> Delete(int columnId);
|
|
|
|
/// <summary>
|
|
/// Moves a column.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/projects/columns/#move-a-project-column">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="columnId">The id of the column</param>
|
|
/// <param name="position">The position to move the column</param>
|
|
Task<bool> Move(int columnId, ProjectColumnMove position);
|
|
}
|
|
}
|