# College Football Data API
#
# This is an API for accessing all sorts of college football data. It currently has a wide array of data ranging from play by play to player statistics to game scores and more.
#
# OpenAPI spec version: 2.3.5
# Contact: admin@collegefootballdata.com
# Generated by: https://github.com/swagger-api/swagger-codegen.git
#' @title Players operations
#' @description swagger.Players
#'
#' @field path Stores url path of the request.
#' @field apiClient Handles the client-server communication.
#' @field userAgent Set the user agent of the request.
#'
#' @importFrom R6 R6Class
#'
#' @section Methods:
#' \describe{
#'
#' get_player_season_stats Player stats by season
#'
#'
#' get_player_usage Player usage metrics broken down by season
#'
#'
#' get_returning_production Team returning production metrics
#'
#'
#' player_search Search for player information
#'
#' }
#'
#' @export
PlayersApi <- R6::R6Class(
'PlayersApi',
public = list(
userAgent = "Swagger-Codegen/1.0.0/r",
apiClient = NULL,
initialize = function(apiClient){
if (!missing(apiClient)) {
self$apiClient <- apiClient
}
else {
self$apiClient <- ApiClient$new()
}
},
get_player_season_stats = function(year, team, conference, start_week, end_week, season_type, category, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`year`)) {
queryParams['year'] <- year
}
if (!missing(`team`)) {
queryParams['team'] <- team
}
if (!missing(`conference`)) {
queryParams['conference'] <- conference
}
if (!missing(`start_week`)) {
queryParams['startWeek'] <- start_week
}
if (!missing(`end_week`)) {
queryParams['endWeek'] <- end_week
}
if (!missing(`season_type`)) {
queryParams['seasonType'] <- season_type
}
if (!missing(`category`)) {
queryParams['category'] <- category
}
urlPath <- "/stats/player/season"
resp <- self$apiClient$callApi(url = paste0(self$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
returnObject <- PlayerSeasonStat$new()
result <- returnObject$fromJSON(httr::content(resp, "text", encoding = "UTF-8"))
Response$new(returnObject, resp)
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
Response$new("API client error", resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
Response$new("API server error", resp)
}
},
get_player_usage = function(year, team, conference, position, player_id, exclude_garbage_time, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`year`)) {
queryParams['year'] <- year
}
if (!missing(`team`)) {
queryParams['team'] <- team
}
if (!missing(`conference`)) {
queryParams['conference'] <- conference
}
if (!missing(`position`)) {
queryParams['position'] <- position
}
if (!missing(`player_id`)) {
queryParams['playerId'] <- player_id
}
if (!missing(`exclude_garbage_time`)) {
queryParams['excludeGarbageTime'] <- exclude_garbage_time
}
urlPath <- "/player/usage"
resp <- self$apiClient$callApi(url = paste0(self$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
returnObject <- PlayerUsage$new()
result <- returnObject$fromJSON(httr::content(resp, "text", encoding = "UTF-8"))
Response$new(returnObject, resp)
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
Response$new("API client error", resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
Response$new("API server error", resp)
}
},
get_returning_production = function(year, team, conference, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`year`)) {
queryParams['year'] <- year
}
if (!missing(`team`)) {
queryParams['team'] <- team
}
if (!missing(`conference`)) {
queryParams['conference'] <- conference
}
urlPath <- "/player/returning"
resp <- self$apiClient$callApi(url = paste0(self$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
returnObject <- ReturningProduction$new()
result <- returnObject$fromJSON(httr::content(resp, "text", encoding = "UTF-8"))
Response$new(returnObject, resp)
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
Response$new("API client error", resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
Response$new("API server error", resp)
}
},
player_search = function(search_term, position, team, year, ...){
args <- list(...)
queryParams <- list()
headerParams <- character()
if (!missing(`search_term`)) {
queryParams['searchTerm'] <- search_term
}
if (!missing(`position`)) {
queryParams['position'] <- position
}
if (!missing(`team`)) {
queryParams['team'] <- team
}
if (!missing(`year`)) {
queryParams['year'] <- year
}
urlPath <- "/player/search"
resp <- self$apiClient$callApi(url = paste0(self$apiClient$basePath, urlPath),
method = "GET",
queryParams = queryParams,
headerParams = headerParams,
body = body,
...)
if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) {
returnObject <- PlayerSearchResult$new()
result <- returnObject$fromJSON(httr::content(resp, "text", encoding = "UTF-8"))
Response$new(returnObject, resp)
} else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) {
Response$new("API client error", resp)
} else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) {
Response$new("API server error", resp)
}
}
)
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.