/** * Operations for NFL. * * > **Superseded:** these hand-written `get*` methods predate the generated * > cross-league ESPN surface. They remain supported for back-compat, but new * > code should prefer the generated `espn_nfl_*` wrappers (e.g. * > `sdv.nfl.espn_nfl_scoreboard()`), which cover far more ESPN * > endpoints and share one maintained codegen pipeline. * * @namespace nfl */ declare const _default: { /** * Gets the NFL game play-by-play data for a specified game. * @memberOf nfl * @async * @function * @param {number} id - Game id. * @returns json * @example * const result = await sdv.nfl.getPlayByPlay(401220403); */ getPlayByPlay: (id: any) => Promise<{ teams: any; id: any; drives: any; competitions: any; season: any; week: any; boxScore: any; scoringPlays: any; standings: any; }>; /** * Gets the NFL game box score data for a specified game. * @memberOf nfl * @async * @function * @param {number} id - Game id. * @returns json * @example * const result = await sdv.nfl.getBoxScore(401220403); */ getBoxScore: (id: any) => Promise; /** * Gets the NFL game summary data for a specified game. * @memberOf nfl * @async * @function * @param {number} id - Game id. * @returns json * @example * const result = await sdv.nfl.getSummary(401220403); */ getSummary: (id: any) => Promise<{ id: number; boxScore: any; gameInfo: any; drives: any; leaders: any; header: any; teams: any; scoringPlays: any; winProbability: any; competitions: any; season: any; week: any; standings: any; }>; /** * Gets the NFL PickCenter data for a specified game. * @memberOf nfl * @async * @function * @param {number} id - Game id. * @returns json * @example * const result = await sdv.nfl.getPicks(401220403); */ getPicks: (id: any) => Promise<{ id: number; gameInfo: any; leaders: any; header: any; teams: any; competitions: any; winProbability: any; pickcenter: any; againstTheSpread: any; odds: any; season: any; week: any; standings: any; }>; /** * Gets the NFL schedule data for a specified date if available. * @memberOf nfl * @async * @function * @param {*} year - Year (YYYY) * @param {*} month - Month (MM) * @param {*} day - Day (DD) * @returns json * @example * const result = await sdv.nfl.getSchedule( * year = 2019, month = 11, day = 17 * ) */ getSchedule: ({ year, month, day }: { year?: any; month?: any; day?: any; }) => Promise; /** * Gets the NFL Weekly Schedule data for a specified season type. * @memberOf nfl * @async * @function * @param {*} week - Week (1-17) Default is 1 * @param {*} year - Year (YYYY) Default is current year * @param {*} seasonType - Season Type (1 = Preseason, 2 = Regular Season, 3 = Postseason) Default is 2 * @returns json * @example * const result = await sdv.nfl.getWeeklySchedule( * week = 1, year = 2023, seasonType = 2 * ) */ getWeeklySchedule: ({ week, year, seasonType }: { week?: number; year?: any; seasonType?: number; }) => Promise; /** * Gets the NFL scoreboard data for a specified date if available. * @memberOf nfl * @async * @function * @param {*} year - Year (YYYY) * @param {*} month - Month (MM) * @param {*} day - Day (DD) * @param {number} limit - Limit on the number of results @default 300 * @returns json * @example * const result = await sdv.nfl.getScoreboard( * year = 2019, month = 11, day = 17 * ) */ getScoreboard: ({ year, month, day, limit }: { year: any; month: any; day: any; limit?: number; }) => Promise; /** * Gets the team standings for the NFL. * @memberOf nfl * @async * @function * @param {number} year - Season * @param {string} group - acceptable group names: 'league','conference','division' * @returns json * @example * const yr = 2021; * const result = await sdv.nfl.getStandings(year = yr); */ getStandings: ({ year, group }: { year?: number; group?: string; }) => Promise; /** * Gets the list of all NFL teams their identification info for ESPN. * @memberOf nfl * @async * @function * @example * const result = await sdv.nfl.getTeamList(); */ getTeamList: () => Promise; /** * Gets the team info for a specific NFL team. * @memberOf nfl * @async * @function * @param {number} id - Team Id * @returns json * @example * const teamId = 16; * const result = await sdv.nfl.getTeamInfo(teamId); */ getTeamInfo: ({ id }: { id: any; }) => Promise; /** * Gets the team roster information for a specific NFL team. * @memberOf nfl * @async * @function * @param {number} id - Team Id * @returns json * @example * const teamId = 16; * const result = await sdv.nfl.getTeamPlayers(teamId); */ getTeamPlayers: ({ id }: { id: any; }) => Promise; }; export default _default; //# sourceMappingURL=nfl.service.d.ts.map