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
101 lines
5.1 KiB
C#
101 lines
5.1 KiB
C#
using System.Collections.Generic;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Invitations on a Repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/">Invitations API documentation</a> for more details.
|
|
/// </remarks>
|
|
public interface IRepositoryInvitationsClient
|
|
{
|
|
/// <summary>
|
|
/// Accept a repository invitation.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="invitationId">The id of the invitation</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
Task<bool> Accept(long invitationId);
|
|
|
|
/// <summary>
|
|
/// Decline a repository invitation.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="invitationId">The id of the invitation</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
Task<bool> Decline(long invitationId);
|
|
|
|
/// <summary>
|
|
/// Deletes a repository invitation.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The id of the repository</param>
|
|
/// <param name="invitationId">The id of the invitation</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
Task<bool> Delete(long repositoryId, long invitationId);
|
|
|
|
/// <summary>
|
|
/// Gets all invitations for the current user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
|
Task<IReadOnlyList<RepositoryInvitation>> GetAllForCurrent();
|
|
|
|
/// <summary>
|
|
/// Gets all invitations for the current user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
|
Task<IReadOnlyList<RepositoryInvitation>> GetAllForCurrent(ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the invitations on a repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The id of the repository</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
Task<IReadOnlyList<RepositoryInvitation>> GetAllForRepository(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all the invitations on a repository.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
Task<IReadOnlyList<RepositoryInvitation>> GetAllForRepository(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Updates a repository invitation.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation">API documentation</a> for more information.
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The id of the repository</param>
|
|
/// <param name="invitationId">The id of the invitation</param>
|
|
/// <param name="permissions">The permission for the collaborator</param>
|
|
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
|
Task<RepositoryInvitation> Edit(long repositoryId, long invitationId, InvitationUpdate permissions);
|
|
}
|
|
}
|