using System.Collections.Generic;
using System.Threading.Tasks;
namespace Octokit
{
///
/// A client for GitHub's Issue Labels API.
///
///
/// See the Issue Labels API documentation for more information.
///
public class IssuesLabelsClient : ApiClient, IIssuesLabelsClient
{
public IssuesLabelsClient(IApiConnection apiConnection)
: base(apiConnection)
{
}
///
/// Gets all labels for the issue.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the issue
[ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/labels")]
public Task> GetAllForIssue(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
return GetAllForIssue(owner, name, number, ApiOptions.None);
}
///
/// Gets all labels for the issue.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the issue
[ManualRoute("GET", "/repositories/{id}/issues/{number}/labels")]
public Task> GetAllForIssue(long repositoryId, int number)
{
return GetAllForIssue(repositoryId, number, ApiOptions.None);
}
///
/// Gets all labels for the issue.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the issue
/// Options for changing the API response
[ManualRoute("GET", "/repos/{owner}/{repo}/issues/{issue_number}/labels")]
public Task> GetAllForIssue(string owner, string name, int number, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll(ApiUrls.IssueLabels(owner, name, number), options);
}
///
/// Gets all labels for the issue.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the issue
/// Options for changing the API response
[ManualRoute("GET", "/repositories/{id}/issues/{number}/labels")]
public Task> GetAllForIssue(long repositoryId, int number, ApiOptions options)
{
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll(ApiUrls.IssueLabels(repositoryId, number), options);
}
///
/// Gets all labels for the repository.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
[ManualRoute("GET", "/repos/{owner}/{repo}/labels")]
public Task> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
return GetAllForRepository(owner, name, ApiOptions.None);
}
///
/// Gets all labels for the repository.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
[ManualRoute("GET", "/repositories/{id}/labels")]
public Task> GetAllForRepository(long repositoryId)
{
return GetAllForRepository(repositoryId, ApiOptions.None);
}
///
/// Gets all labels for the repository.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// Options for changing the API response
[ManualRoute("GET", "/repos/{owner}/{repo}/labels")]
public Task> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll(ApiUrls.Labels(owner, name), options);
}
///
/// Gets all labels for the repository.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// Options for changing the API response
[ManualRoute("GET", "/repositories/{id}/labels")]
public Task> GetAllForRepository(long repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll(ApiUrls.Labels(repositoryId), options);
}
///
/// Gets labels for every issue in a milestone
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the milestone
[ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{milestone_number}/labels")]
public Task> GetAllForMilestone(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
return GetAllForMilestone(owner, name, number, ApiOptions.None);
}
///
/// Gets labels for every issue in a milestone
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the milestone
[ManualRoute("GET", "/repositories/{id}/milestones/{milestone_number}/labels")]
public Task> GetAllForMilestone(long repositoryId, int number)
{
return GetAllForMilestone(repositoryId, number, ApiOptions.None);
}
///
/// Gets labels for every issue in a milestone
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the milestone
/// Options for changing the API response
[ManualRoute("GET", "/repos/{owner}/{repo}/milestones/{milestone_number}/labels")]
public Task> GetAllForMilestone(string owner, string name, int number, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll(ApiUrls.MilestoneLabels(owner, name, number), options);
}
///
/// Gets labels for every issue in a milestone
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the milestone
/// Options for changing the API response
[ManualRoute("GET", "/repositories/{id}/milestones/{milestone_number}/labels")]
public Task> GetAllForMilestone(long repositoryId, int number, ApiOptions options)
{
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll(ApiUrls.MilestoneLabels(repositoryId, number), options);
}
///
/// Gets a single Label by name.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The name of the label
[ManualRoute("GET", "/repos/{owner}/{repo}/labels/{name}")]
public Task Get(string owner, string name, string labelName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
return ApiConnection.Get(ApiUrls.Label(owner, name, labelName));
}
///
/// Gets a single Label by name.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The name of the label
[ManualRoute("GET", "/repositories/{id}/labels/{name}")]
public Task Get(long repositoryId, string labelName)
{
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
return ApiConnection.Get(ApiUrls.Label(repositoryId, labelName));
}
///
/// Deletes a label.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The name of the label
[ManualRoute("DELETE", "/repos/{owner}/{repo}/labels/{name}")]
public Task Delete(string owner, string name, string labelName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
return ApiConnection.Delete(ApiUrls.Label(owner, name, labelName));
}
///
/// Deletes a label.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The name of the label
[ManualRoute("DELETE", "/repositories/{id}/labels/{name}")]
public Task Delete(long repositoryId, string labelName)
{
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
return ApiConnection.Delete(ApiUrls.Label(repositoryId, labelName));
}
///
/// Creates a label.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The data for the label to be created
[ManualRoute("POST", "/repos/{owner}/{repo}/labels")]
public Task Create(string owner, string name, NewLabel newLabel)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(newLabel, nameof(newLabel));
return ApiConnection.Post(ApiUrls.Labels(owner, name), newLabel);
}
///
/// Creates a label.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The data for the label to be created
[ManualRoute("POST", "/repositories/{id}/labels/{name}")]
public Task Create(long repositoryId, NewLabel newLabel)
{
Ensure.ArgumentNotNull(newLabel, nameof(newLabel));
return ApiConnection.Post(ApiUrls.Labels(repositoryId), newLabel);
}
///
/// Updates a label.
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The name of the label
/// The data for the label to be updated
[ManualRoute("PATCH", "/repos/{owner}/{repo}/labels/{name}")]
public Task Update(string owner, string name, string labelName, LabelUpdate labelUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
Ensure.ArgumentNotNull(labelUpdate, nameof(labelUpdate));
// BUG: this should be a PATCH instead of POST
return ApiConnection.Post(ApiUrls.Label(owner, name, labelName), labelUpdate);
}
///
/// Updates a label.
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The name of the label
/// The data for the label to be updated
[ManualRoute("PATCH", "/repositories/{id}/labels/{name}")]
public Task Update(long repositoryId, string labelName, LabelUpdate labelUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
Ensure.ArgumentNotNull(labelUpdate, nameof(labelUpdate));
// BUG: this should be a PATCH instead of POST
return ApiConnection.Post(ApiUrls.Label(repositoryId, labelName), labelUpdate);
}
///
/// Adds a label to an issue
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the issue
/// The names of the labels to add
[ManualRoute("POST", "/repos/{owner}/{repo}/issues/{issue_number}/labels")]
public Task> AddToIssue(string owner, string name, int number, string[] labels)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(labels, nameof(labels));
return ApiConnection.Post>(ApiUrls.IssueLabels(owner, name, number), labels);
}
///
/// Adds a label to an issue
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the issue
/// The names of the labels to add
[ManualRoute("POST", "/repositories/{id}/issues/{number}/labels")]
public Task> AddToIssue(long repositoryId, int number, string[] labels)
{
Ensure.ArgumentNotNull(labels, nameof(labels));
return ApiConnection.Post>(ApiUrls.IssueLabels(repositoryId, number), labels);
}
///
/// Removes a label from an issue
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the issue
/// The name of the label to remove
[ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{issue_number}/labels")]
public Task> RemoveFromIssue(string owner, string name, int number, string labelName)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
return ApiConnection.Delete>(ApiUrls.IssueLabel(owner, name, number, labelName), new object());
}
///
/// Removes a label from an issue
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the issue
/// The name of the label to remove
[ManualRoute("DELETE", "/repositories/{id}/issues/{number}/labels")]
public Task> RemoveFromIssue(long repositoryId, int number, string labelName)
{
Ensure.ArgumentNotNullOrEmptyString(labelName, nameof(labelName));
return ApiConnection.Delete>(ApiUrls.IssueLabel(repositoryId, number, labelName), new object());
}
///
/// Replaces all labels on the specified issues with the provided labels
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the issue
/// The names of the labels to set
[ManualRoute("PUT", "/repos/{owner}/{repo}/issues/{issue_number}/labels")]
public Task> ReplaceAllForIssue(string owner, string name, int number, string[] labels)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(labels, nameof(labels));
return ApiConnection.Put>(ApiUrls.IssueLabels(owner, name, number), labels);
}
///
/// Replaces all labels on the specified issues with the provided labels
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the issue
/// The names of the labels to set
[ManualRoute("PUT", "/repositories/{id}/issues/{number}/labels")]
public Task> ReplaceAllForIssue(long repositoryId, int number, string[] labels)
{
Ensure.ArgumentNotNull(labels, nameof(labels));
return ApiConnection.Put>(ApiUrls.IssueLabels(repositoryId, number), labels);
}
///
/// Removes all labels from an issue
///
///
/// See the API documentation for more information.
///
/// The owner of the repository
/// The name of the repository
/// The number of the issue
[ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{issue_number}/labels")]
public Task RemoveAllFromIssue(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
return ApiConnection.Delete(ApiUrls.IssueLabels(owner, name, number));
}
///
/// Removes all labels from an issue
///
///
/// See the API documentation for more information.
///
/// The Id of the repository
/// The number of the issue
[ManualRoute("DELETE", "/repositories/{id}/issues/{number}/labels")]
public Task RemoveAllFromIssue(long repositoryId, int number)
{
return ApiConnection.Delete(ApiUrls.IssueLabels(repositoryId, number));
}
}
}