mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
600c8657e4
* removes obsolete OranizationsClient.GetAll (replaced with GetAllForUser) * removes obsolete PullRequestsClient.Comment (replaced with ReviewComment) * removes obsolete TeamsClient.GetMembership (replaced with GetMembershipDetails) removes obsolete TeamsClient.AddMembership (replaced with AddOrEditMembership) removes obsolete TeamsClient.AddMembership (replaced with AddOrEditMembership) removes obsolete TeamMembership response class (replaced with TeamMembershipDetails) * removes obsolete RepositoryBranchesClient.GetRequiredStatusChecksContexts (replaced with GetAllRequiredStatusChecksContexts) removes obsolete RepositoryBranchesClient.GetProtectedBranchTeamRestrictions (replaced with GetAllProtectedBranchTeamRestrictions) removes obsolete RepositoryBranchesClient.GetProtectedBranchUserRestrictions (replaced with GetAllProtectedBranchUserRestrictions) * removes obsolete RepositoryTrafficClient.GetReferrers (replaced with GetAllReferrers) removes obsolete RepositoryTrafficClient.GetPaths (replaced with GetAllPaths) * removes obsolete constructors from BranchProtectionUpdateSettings and UpdateTeam request models * removes obsolete Assignee property from NewIssue and IssueUpdate request models (replaced with Assignees)
78 lines
4.0 KiB
C#
78 lines
4.0 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Repository Traffic API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="https://developer.github.com/v3/repos/traffic/">Repository Traffic API documentation</a> for more information.
|
|
/// </remarks>
|
|
public interface IRepositoryTrafficClient
|
|
{
|
|
[ExcludeFromPaginationApiOptionsConventionTest("Pagination not supported by GitHub API (tested 29/08/2017)")]
|
|
Task<IReadOnlyList<RepositoryTrafficReferrer>> GetAllReferrers(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// List the top 10 referrers over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-referrers</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
[ExcludeFromPaginationApiOptionsConventionTest("Pagination not supported by GitHub API (tested 29/08/2017)")]
|
|
Task<IReadOnlyList<RepositoryTrafficReferrer>> GetAllReferrers(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// List the top 10 popular contents over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-paths</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
[ExcludeFromPaginationApiOptionsConventionTest("Pagination not supported by GitHub API (tested 29/08/2017)")]
|
|
Task<IReadOnlyList<RepositoryTrafficPath>> GetAllPaths(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// List the top 10 popular contents over the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#list-paths</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
[ExcludeFromPaginationApiOptionsConventionTest("Pagination not supported by GitHub API (tested 29/08/2017)")]
|
|
Task<IReadOnlyList<RepositoryTrafficPath>> GetAllPaths(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Get the total number of views and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#views</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
Task<RepositoryTrafficViewSummary> GetViews(string owner, string name, RepositoryTrafficRequest per);
|
|
|
|
/// <summary>
|
|
/// Get the total number of views and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#views</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
Task<RepositoryTrafficViewSummary> GetViews(long repositoryId, RepositoryTrafficRequest per);
|
|
|
|
/// <summary>
|
|
/// Get the total number of clones and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#clones</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
Task<RepositoryTrafficCloneSummary> GetClones(string owner, string name, RepositoryTrafficRequest per);
|
|
|
|
/// <summary>
|
|
/// Get the total number of clones and breakdown per day or week for the last 14 days
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/repos/traffic/#clones</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
/// <param name="per">Breakdown per day or week</param>
|
|
Task<RepositoryTrafficCloneSummary> GetClones(long repositoryId, RepositoryTrafficRequest per);
|
|
}
|
|
}
|