mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
222 lines
7.7 KiB
C#
222 lines
7.7 KiB
C#
using System;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A Client for the GitHub API v3. You can read more about the API here: http://developer.github.com.
|
|
/// </summary>
|
|
public interface IGitHubClient : IApiInfoProvider
|
|
{
|
|
/// <summary>
|
|
/// Sets the timeout for the connection between the client and the server.
|
|
/// GitHub will terminate the request if it takes more than 10 seconds to process the request
|
|
/// Useful to set a specific timeout for lengthy operations, such as uploading release assets
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See more information here: https://technet.microsoft.com/library/system.net.http.httpclient.timeout(v=vs.110).aspx
|
|
/// </remarks>
|
|
/// <param name="timeout">The Timeout value</param>
|
|
void SetRequestTimeout(TimeSpan timeout);
|
|
|
|
/// <summary>
|
|
/// Provides a client connection to make rest requests to HTTP endpoints.
|
|
/// </summary>
|
|
IConnection Connection { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Authorization API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/oauth_authorizations/
|
|
/// </remarks>
|
|
IAuthorizationsClient Authorization { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Activity API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/activity/
|
|
/// </remarks>
|
|
IActivitiesClient Activity { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Actions API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/actions/
|
|
/// </remarks>
|
|
IActionsClient Actions { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Application API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/apps/
|
|
/// </remarks>
|
|
IGitHubAppsClient GitHubApps { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Issue API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/issues/
|
|
/// </remarks>
|
|
IIssuesClient Issue { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Migration API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/migration/
|
|
/// </remarks>
|
|
IMigrationClient Migration { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Miscellaneous API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/misc/
|
|
/// </remarks>
|
|
IMiscellaneousClient Miscellaneous { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's OAuth API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/oauth/
|
|
/// </remarks>
|
|
IOauthClient Oauth { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Organizations API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/orgs/
|
|
/// </remarks>
|
|
IOrganizationsClient Organization { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Pacakges API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://docs.github.com/rest/packages
|
|
/// </remarks>
|
|
IPackagesClient Packages { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Pull Requests API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/pulls/
|
|
/// </remarks>
|
|
IPullRequestsClient PullRequest { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Repositories API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/repos/
|
|
/// </remarks>
|
|
IRepositoriesClient Repository { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Gists API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/gists/
|
|
/// </remarks>
|
|
IGistsClient Gist { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Users API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/users/
|
|
/// </remarks>
|
|
IUsersClient User { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Git Data API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/git/
|
|
/// </remarks>
|
|
IGitDatabaseClient Git { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Search API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/search/
|
|
/// </remarks>
|
|
ISearchClient Search { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Enterprise API
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/enterprise/
|
|
/// </remarks>
|
|
IEnterpriseClient Enterprise { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Reactions API
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/reactions/
|
|
/// </remarks>
|
|
IReactionsClient Reaction { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Checks API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://developer.github.com/v3/checks/
|
|
/// </remarks>
|
|
IChecksClient Check { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Meta API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://docs.github.com/rest/meta
|
|
/// </remarks>
|
|
IMetaClient Meta { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Rate Limit API
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://docs.github.com/rest/rate-limit
|
|
/// </remarks>
|
|
IRateLimitClient RateLimit { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Markdown API
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://docs.github.com/rest/markdown
|
|
/// </remarks>
|
|
IMarkdownClient Markdown { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Git Ignore API
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://docs.github.com/rest/gitignore
|
|
/// </remarks>
|
|
IGitIgnoreClient GitIgnore { get; }
|
|
|
|
/// <summary>
|
|
/// Access GitHub's Licenses API
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Refer to the API documentation for more information: https://docs.github.com/rest/licenses
|
|
/// </remarks>
|
|
ILicensesClient Licenses { get; }
|
|
IEmojisClient Emojis { get; }
|
|
|
|
ICodespacesClient Codespaces { get; }
|
|
}
|
|
}
|