diff --git a/Nhl.Api/README.md b/Nhl.Api/README.md index 842ce56e..9aca8591 100644 --- a/Nhl.Api/README.md +++ b/Nhl.Api/README.md @@ -386,7 +386,7 @@ Returns the all the NHL player game center statistics for a specific player for ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -405,7 +405,7 @@ Returns the all the NHL player game center statistics for a specific player for ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -1352,11 +1352,11 @@ Returns the NHL team schedule for the specified team and the specified date and ##### Summary -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -1372,11 +1372,11 @@ Returns the number of face offs won by a player for a specific season and game t ##### Summary -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -2631,7 +2631,7 @@ Returns the all the NHL player game center statistics for a specific player for ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -2650,7 +2650,7 @@ Returns the all the NHL player game center statistics for a specific player for ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -2783,11 +2783,11 @@ Returns all the NHL team valid game types for all valid NHL seasons for the sele ##### Summary -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters @@ -2803,11 +2803,11 @@ Returns the number of face offs won by a player for a specific season and game t ##### Summary -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Returns -Returns the number of face offs won by a player for a specific season and game type +Returns the number of total number of a player statistics for a player for a specific season ##### Parameters diff --git a/Nhl.Api/Src/Api/NhlApi.cs b/Nhl.Api/Src/Api/NhlApi.cs index 135be6df..e103424d 100644 --- a/Nhl.Api/Src/Api/NhlApi.cs +++ b/Nhl.Api/Src/Api/NhlApi.cs @@ -720,26 +720,26 @@ public async Task IsLeagueActiveAsync(CancellationToken cancellationToken } /// - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season /// /// The player enumeration identifier, specifying which the NHL player, for more information /// The NHL player game center statistic type, for more information on valid game center statistics /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token that can be used by other objects or threads to receive notice of cancellation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum playerEnum, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default) { return await _nhlStatisticsApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum, playerGameCenterStatistic, seasonYear, cancellationToken); } /// - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season /// /// The NHL player identifier, Example: 8478402 - Connor McDavid /// The NHL player game center statistic type, for more information on valid game center statistics /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token that can be used by other objects or threads to receive notice of cancellation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int playerId, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default) { return await _nhlStatisticsApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId, playerGameCenterStatistic, seasonYear, cancellationToken); @@ -761,7 +761,7 @@ public async Task> GetAllPlayersAsync(CancellationT /// The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token to cancel the asynchronous operation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the all the NHL player game center statistics for a specific player for a specific season and game type public async Task<(PlayerProfile PlayerProfile, Dictionary StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(int playerId, string seasonYear, CancellationToken cancellationToken = default) { return await _nhlStatisticsApi.GetAllTotalPlayerStatisticValueBySeasonAsync(playerId, seasonYear, cancellationToken); @@ -773,7 +773,7 @@ public async Task> GetAllPlayersAsync(CancellationT /// The player enumeration identifier, specifying which the NHL player, for more information /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token to cancel the asynchronous operation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the all the NHL player game center statistics for a specific player for a specific season and game type public async Task<(PlayerProfile PlayerProfile, Dictionary StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum playerEnum, string seasonYear, CancellationToken cancellationToken = default) { return await _nhlStatisticsApi.GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum, seasonYear, cancellationToken); diff --git a/Nhl.Api/Src/StatisticsApi/INhlStatisticsApi.cs b/Nhl.Api/Src/StatisticsApi/INhlStatisticsApi.cs index 569e1b5b..dd15d515 100644 --- a/Nhl.Api/Src/StatisticsApi/INhlStatisticsApi.cs +++ b/Nhl.Api/Src/StatisticsApi/INhlStatisticsApi.cs @@ -80,7 +80,7 @@ public interface INhlStatisticsApi /// The player game center statistic type, for more information /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token that can be used by other objects or threads to receive notice of cancellation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the total value of a statistic type for a player for a specific season, including face offs won, hits, shots on goal, missed shots, blocked shots, giveaways, penalties and takeaways public Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum playerEnum, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default); /// @@ -90,25 +90,24 @@ public interface INhlStatisticsApi /// The player game center statistic type, for more information /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token that can be used by other objects or threads to receive notice of cancellation - /// Returns the number of face offs won by a player for a specific season + /// Returns the total value of a statistic type for a player for a specific season, including face offs won, hits, shots on goal, missed shots, blocked shots, giveaways, penalties and takeaways public Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int playerId, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default); /// - /// Returns the all the NHL player game center statistics for a specific player for a specific season and game type + /// Returns the all the NHL player game center statistics for a specific player for a specific season /// /// The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token to cancel the asynchronous operation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public Task<(PlayerProfile PlayerProfile, Dictionary StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(int playerId, string seasonYear, CancellationToken cancellationToken = default); - /// - /// Returns the all the NHL player game center statistics for a specific player for a specific season and game type + /// Returns the all the NHL player game center statistics for a specific player for a specific season /// /// The player enumeration identifier, specifying which the NHL player, for more information /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token to cancel the asynchronous operation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public Task<(PlayerProfile PlayerProfile, Dictionary StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum playerEnum, string seasonYear, CancellationToken cancellationToken = default); } diff --git a/Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs b/Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs index e214a47c..21443614 100644 --- a/Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs +++ b/Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs @@ -147,13 +147,13 @@ public async Task> GetTeamStatisticsBySeasonAsync(int } /// - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season /// /// The player enumeration identifier, specifying which the NHL player, for more information /// The NHL player game center statistic type, for more information on valid game center statistics /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token that can be used by other objects or threads to receive notice of cancellation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum playerEnum, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default) { var statisticTotal = 0; @@ -208,13 +208,13 @@ public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEn } /// - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season /// /// The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid /// The NHL player game center statistic type, for more information on valid game center statistics /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token to cancel the asynchronous operation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int playerId, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default) { var statisticTotal = 0; @@ -273,7 +273,7 @@ public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int play /// The player enumeration identifier, specifying which the NHL player, for more information /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token that can be used by other objects or threads to receive notice of cancellation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public async Task<(PlayerProfile PlayerProfile, Dictionary StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum playerEnum, string seasonYear, CancellationToken cancellationToken = default) { var statisticTotals = new Dictionary @@ -355,7 +355,7 @@ public async Task GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int play /// The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid /// The NHL season year to retrieve the team statistics, see for more information on valid season years /// A cancellation token to cancel the asynchronous operation - /// Returns the number of face offs won by a player for a specific season and game type + /// Returns the number of total number of a player statistics for a player for a specific season public async Task<(PlayerProfile PlayerProfile, Dictionary StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(int playerId, string seasonYear, CancellationToken cancellationToken = default) { var statisticTotals = new Dictionary