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
290 lines
17 KiB
C#
290 lines
17 KiB
C#
using System.Diagnostics.CodeAnalysis;
|
||
using System.Threading.Tasks;
|
||
using System;
|
||
using System.Collections.Generic;
|
||
|
||
namespace Octokit
|
||
{
|
||
/// <summary>
|
||
/// A client for GitHub's OAuth API.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// See the <a href="http://developer.github.com/v3/oauth/">OAuth API documentation</a> for more details.
|
||
/// </remarks>
|
||
public interface IAuthorizationsClient
|
||
{
|
||
/// <summary>
|
||
/// Gets all <see cref="Authorization"/>s for the authenticated user.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make the request.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>A list of <see cref="Authorization"/>s for the authenticated user.</returns>
|
||
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
|
||
Justification = "It's an API call, so it's not a property.")]
|
||
Task<IReadOnlyList<Authorization>> GetAll();
|
||
|
||
/// <summary>
|
||
/// Gets all <see cref="Authorization"/>s for the authenticated user.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="options">Options for changing the API response</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make the request.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>A list of <see cref="Authorization"/>s for the authenticated user.</returns>
|
||
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
|
||
Justification = "It's an API call, so it's not a property.")]
|
||
Task<IReadOnlyList<Authorization>> GetAll(ApiOptions options);
|
||
|
||
/// <summary>
|
||
/// Gets a specific <see cref="Authorization"/> for the authenticated user.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#get-a-single-authorization">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="id">The Id of the <see cref="Authorization"/> to get</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The specified <see cref="Authorization"/>.</returns>
|
||
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
|
||
Justification = "It's fiiiine. It's fine. Trust us.")]
|
||
Task<Authorization> Get(long id);
|
||
|
||
/// <summary>
|
||
/// Creates a new personal token for the authenticated user.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="newAuthorization">Describes the new authorization to create</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="TwoFactorRequiredException">
|
||
/// Thrown when the current account has two-factor authentication enabled and an authentication code is required.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The created <see cref="Authorization"/>.</returns>
|
||
Task<ApplicationAuthorization> Create(NewAuthorization newAuthorization);
|
||
|
||
/// <summary>
|
||
/// Creates a new personal token for the authenticated user.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="twoFactorAuthenticationCode">The two-factor authentication code in response to the current user's previous challenge</param>
|
||
/// <param name="newAuthorization">Describes the new authorization to create</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="TwoFactorRequiredException">
|
||
/// Thrown when the current account has two-factor authentication enabled and an authentication code is required.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The created <see cref="Authorization"/>.</returns>
|
||
Task<ApplicationAuthorization> Create(NewAuthorization newAuthorization, string twoFactorAuthenticationCode);
|
||
|
||
/// <summary>
|
||
/// Creates a new authorization for the specified OAuth application if an authorization for that application
|
||
/// doesn’t already exist for the user; otherwise, it fails.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#get-or-create-an-authorization-for-a-specific-app">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="clientId">Client Id of the OAuth application for the token</param>
|
||
/// <param name="clientSecret">The client secret</param>
|
||
/// <param name="newAuthorization">Describes the new authorization to create</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="TwoFactorRequiredException">
|
||
/// Thrown when the current account has two-factor authentication enabled and an authentication code is required.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The created <see cref="Authorization"/>.</returns>
|
||
Task<ApplicationAuthorization> Create(
|
||
string clientId,
|
||
string clientSecret,
|
||
NewAuthorization newAuthorization);
|
||
|
||
/// <summary>
|
||
/// Creates a new authorization for the specified OAuth application if an authorization for that application
|
||
/// doesn’t already exist for the user; otherwise, it fails.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#get-or-create-an-authorization-for-a-specific-app">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="clientId">Client Id of the OAuth application for the token</param>
|
||
/// <param name="clientSecret">The client secret</param>
|
||
/// <param name="twoFactorAuthenticationCode">The two-factor authentication code in response to the current user's previous challenge</param>
|
||
/// <param name="newAuthorization">Describes the new authorization to create</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="TwoFactorRequiredException">
|
||
/// Thrown when the current account has two-factor authentication enabled and an authentication code is required.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The created <see cref="Authorization"/>.</returns>
|
||
Task<ApplicationAuthorization> Create(
|
||
string clientId,
|
||
string clientSecret,
|
||
NewAuthorization newAuthorization,
|
||
string twoFactorAuthenticationCode);
|
||
|
||
/// <summary>
|
||
/// Creates a new authorization for the specified OAuth application if an authorization for that application doesn’t already
|
||
/// exist for the user; otherwise, returns the user’s existing authorization for that application.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#get-or-create-an-authorization-for-a-specific-app">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="clientId">Client Id of the OAuth application for the token</param>
|
||
/// <param name="clientSecret">The client secret</param>
|
||
/// <param name="newAuthorization">Describes the new authorization to create</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="TwoFactorRequiredException">
|
||
/// Thrown when the current account has two-factor authentication enabled and an authentication code is required.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The created <see cref="Authorization"/>.</returns>
|
||
Task<ApplicationAuthorization> GetOrCreateApplicationAuthentication(
|
||
string clientId,
|
||
string clientSecret,
|
||
NewAuthorization newAuthorization);
|
||
|
||
/// <summary>
|
||
/// Creates a new authorization for the specified OAuth application if an authorization for that application doesn’t already
|
||
/// exist for the user; otherwise, returns the user’s existing authorization for that application.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#get-or-create-an-authorization-for-a-specific-app">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="clientId">Client Id of the OAuth application for the token</param>
|
||
/// <param name="clientSecret">The client secret</param>
|
||
/// <param name="newAuthorization">Describes the new authorization to create</param>
|
||
/// <param name="twoFactorAuthenticationCode">The two-factor authentication code in response to the current user's previous challenge</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make this request.
|
||
/// </exception>
|
||
/// <exception cref="TwoFactorRequiredException">
|
||
/// Thrown when the current account has two-factor authentication enabled and an authentication code is required.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The created <see cref="Authorization"/>.</returns>
|
||
Task<ApplicationAuthorization> GetOrCreateApplicationAuthentication(
|
||
string clientId,
|
||
string clientSecret,
|
||
NewAuthorization newAuthorization,
|
||
string twoFactorAuthenticationCode);
|
||
|
||
/// <summary>
|
||
/// Checks the validity of an OAuth token without running afoul of normal rate limits for failed login attempts.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="https://developer.github.com/v3/oauth_authorizations/#check-an-authorization">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="clientId">Client Id of the OAuth application for the token</param>
|
||
/// <param name="accessToken">The OAuth token to check</param>
|
||
/// <returns>The valid <see cref="ApplicationAuthorization"/>.</returns>
|
||
Task<ApplicationAuthorization> CheckApplicationAuthentication(string clientId, string accessToken);
|
||
|
||
/// <summary>
|
||
/// Resets a valid OAuth token for an OAuth application without end user involvement.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization">API documentation</a> for more information.
|
||
/// </remarks>
|
||
/// <param name="clientId">ClientID of the OAuth application for the token</param>
|
||
/// <param name="accessToken">The OAuth token to reset</param>
|
||
/// <returns>The valid <see cref="ApplicationAuthorization"/> with a new OAuth token</returns>
|
||
Task<ApplicationAuthorization> ResetApplicationAuthentication(string clientId, string accessToken);
|
||
|
||
/// <summary>
|
||
/// Revokes a single OAuth token for an OAuth application.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application">API documentation for more information.</a>
|
||
/// </remarks>
|
||
/// <param name="clientId">ClientID of the OAuth application for the token</param>
|
||
/// <param name="accessToken">The OAuth token to revoke</param>
|
||
/// <returns>A <see cref="Task"/> for the request's execution.</returns>
|
||
Task RevokeApplicationAuthentication(string clientId, string accessToken);
|
||
|
||
/// <summary>
|
||
/// Updates the specified <see cref="Authorization"/>.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#update-an-existing-authorization">API
|
||
/// documentation</a> for more details.
|
||
/// </remarks>
|
||
/// <param name="id">Id of the <see cref="Authorization"/> to update</param>
|
||
/// <param name="authorizationUpdate">Describes the changes to make to the authorization</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make the request.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>The updated <see cref="Authorization"/>.</returns>
|
||
Task<Authorization> Update(long id, AuthorizationUpdate authorizationUpdate);
|
||
|
||
/// <summary>
|
||
/// Deletes the specified <see cref="Authorization"/>.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#delete-an-authorization">API
|
||
/// documentation</a> for more details.
|
||
/// </remarks>
|
||
/// <param name="id">The system-wide Id of the authorization to delete</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make the request.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>A <see cref="Task"/> for the request's execution.</returns>
|
||
Task Delete(long id);
|
||
|
||
/// <summary>
|
||
/// Deletes the specified <see cref="Authorization"/>.
|
||
/// </summary>
|
||
/// <remarks>
|
||
/// This method requires authentication.
|
||
/// See the <a href="http://developer.github.com/v3/oauth/#delete-an-authorization">API
|
||
/// documentation</a> for more details.
|
||
/// </remarks>
|
||
/// <param name="id">The system-wide Id of the authorization to delete</param>
|
||
/// <param name="twoFactorAuthenticationCode">Two factor authorization code</param>
|
||
/// <exception cref="AuthorizationException">
|
||
/// Thrown when the current user does not have permission to make the request.
|
||
/// </exception>
|
||
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
|
||
/// <returns>A <see cref="Task"/> for the request's execution.</returns>
|
||
Task Delete(long id, string twoFactorAuthenticationCode);
|
||
}
|
||
}
|