nhl-api-ts 0.2.0 → 0.3.0

package/dist/types/game-center.d.mts

@@ -4,7 +4,7 @@ export interface BoxscoreGoalie {
     sweaterNumber: number;
     name: LocalizedString;
     position: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games */
     starter?: boolean;
     evenStrengthShotsAgainst?: string;
     powerPlayShotsAgainst?: string;
@@ -14,7 +14,7 @@ export interface BoxscoreGoalie {
     evenStrengthGoalsAgainst?: number;
     powerPlayGoalsAgainst?: number;
     shorthandedGoalsAgainst?: number;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games */
     pim?: number;
     goalsAgainst?: number;
     toi?: string;
@@ -108,6 +108,8 @@ export interface BoxscoreTeam {
     placeNameWithPreposition: LocalizedString;
     score?: number;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface DailyScores {
     prevDate: string;
@@ -132,34 +134,35 @@ export interface DailyScoresGame {
     awayTeam: DailyScoresTeam;
     homeTeam: DailyScoresTeam;
     gameCenterLink: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     threeMinRecap?: string;
-    /** Absent when date=now; date=playoff. Low sample count */
+    /** Absent before the game is played */
     threeMinRecapFr?: string;
-    /** Absent when date=now; date=playoff; date=regular. Low sample count */
+    /** Absent before the game is played */
     condensedGame?: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     clock?: GameClock;
     neutralSite: boolean;
     venueTimezone: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     period?: number;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     periodDescriptor?: PeriodDescriptor;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     gameOutcome?: GameOutcome;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     goals?: GameGoal[];
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     ticketsLink?: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     ticketsLinkFr?: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     teamLeaders?: GameTeamLeader[];
-    /** Absent when date=regular. Low sample count */
+    /** Playoff games only */
     seriesStatus?: SeriesStatus;
-    /** Absent when date=regular. Low sample count */
+    /** Playoff games only */
     seriesUrl?: string;
+    condensedGameFr?: string;
 }
 export interface DailyScoresGameWeek {
     date: string;
@@ -178,9 +181,7 @@ export interface DailyScoresTvBroadcast {
     network: string;
     sequenceNumber: number;
     logoUrls?: TeamLogo;
-    /** Absent when date=regular */
     parentId?: number;
-    /** Absent when date=regular. Low sample count */
     languageCode?: string;
 }
 export interface DelayedPenaltyDetails {
@@ -222,14 +223,14 @@ export interface DailyScoresTeam {
     id: number;
     name: LocalizedString;
     abbrev: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     score?: number;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     sog?: number;
     logo: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     record?: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     odds?: TeamOdd[];
 }
 export interface GameClock {
@@ -243,7 +244,6 @@ export interface GameEndPlay {
     periodDescriptor: PeriodDescriptor;
     timeInPeriod: string;
     timeRemaining: string;
-    /** Absent when game=preseason; game=shootout */
     situationCode?: OpenUnion<'0440' | '1551'>;
     homeTeamDefendingSide: OpenUnion<'right' | 'left'>;
     typeCode: number;
@@ -270,9 +270,7 @@ export interface GameGoal {
     highlightClipSharingUrlFr?: string;
     highlightClip?: number;
     highlightClipFr?: number;
-    /** Absent when date=regular. Low sample count */
     discreteClip?: number;
-    /** Absent when date=regular. Low sample count */
     discreteClipFr?: number;
     goalInGame?: number;
 }
@@ -302,16 +300,16 @@ export interface GameLanding {
     awayTeam: GameLandingAwayTeam;
     homeTeam: GameLandingAwayTeam;
     shootoutInUse: boolean;
-    /** Absent when game=playoff */
+    /** Absent for playoff games */
     maxPeriods?: number;
     regPeriods: number;
     otInUse: boolean;
     tiesInUse: boolean;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     ticketsLink?: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     ticketsLinkFr?: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     matchup?: GameLandingMatchup;
     periodDescriptor?: PeriodDescriptor;
     summary?: GameLandingSummary;
@@ -325,10 +323,12 @@ export interface GameLandingAwayTeam {
     placeNameWithPreposition: LocalizedString;
     logo: string;
     darkLogo: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     record?: string;
     score?: number;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface GameLandingMatchup {
     season: number;
@@ -357,29 +357,26 @@ export interface GameLandingScoringGoal {
     assists: GoalAssist[];
     isHome: boolean;
     situationCode?: OpenUnion<'1551' | '0651' | '1331' | '0101' | '1451'>;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClipSharingUrl?: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClip?: number;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     pptReplayUrl?: string;
     homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
-    /** Absent when game=playoff; game=preseason; game=shootout. Low sample count */
     goalInGame?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClip?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClipFr?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipSharingUrlFr?: string;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipFr?: number;
 }
 export interface GameLandingSummary {
     scoring: GameLandingSummaryScoring[];
     threeStars: GameLandingSummaryThreeStar[];
     penalties: SummaryPenalty[];
-    /** Absent when game=regular. Low sample count */
+    /** Only present while the game is live */
+    iceSurface?: SummaryIceSurface;
+    /** Only for games decided by a shootout */
     shootout?: SummaryShootout;
 }
 export interface GameLandingSummaryScoring {
@@ -397,9 +394,9 @@ export interface GameLandingSummaryThreeStar {
     goals?: number;
     assists?: number;
     points?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     goalsAgainstAverage?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     savePctg?: number;
 }
 export interface GameStory {
@@ -420,12 +417,12 @@ export interface GameStory {
     awayTeam: GameStoryAwayTeam;
     homeTeam: GameStoryAwayTeam;
     shootoutInUse: boolean;
-    /** Absent when game=playoff */
+    /** Absent for playoff games */
     maxPeriods?: number;
     regPeriods: number;
     otInUse: boolean;
     tiesInUse: boolean;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     preGameMatchup?: PreGameMatchup;
     summary?: GameStorySummary;
     periodDescriptor?: PeriodDescriptor;
@@ -437,10 +434,12 @@ export interface GameStoryAwayTeam {
     abbrev: string;
     placeName: LocalizedString;
     logo: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     record?: string;
     score?: number;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface PreGameMatchup {
     skatingLeaders: PreGameMatchupSkatingLeaders;
@@ -459,7 +458,6 @@ export interface GameStoryTvBroadcast {
     countryCode: string;
     network: string;
     sequenceNumber: number;
-    /** Absent when game=regular */
     logoUrls?: TeamLogo;
 }
 export interface GameTeamLeader {
@@ -503,37 +501,31 @@ export interface GoalAssist {
 export interface GoalDetails {
     shotType: ShotType;
     scoringPlayerId: number;
-    /** Absent when game=preseason; game=shootout */
     scoringPlayerTotal?: number;
-    /** Absent when game=preseason; game=regular; game=shootout */
+    /** Absent for unassisted goals */
     assist1PlayerId?: number;
-    /** Absent when game=preseason; game=regular; game=shootout */
+    /** Absent for unassisted goals */
     assist1PlayerTotal?: number;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout */
+    /** Absent unless the goal had two assists */
     assist2PlayerId?: number;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout */
+    /** Absent unless the goal had two assists */
     assist2PlayerTotal?: number;
     eventOwnerTeamId: number;
-    /** Absent when game=playoff */
+    /** Absent when the net was empty */
     goalieInNetId?: number;
     awayScore: number;
     homeScore: number;
     xCoord?: number;
     yCoord?: number;
     zoneCode?: ZoneCode;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClipSharingUrl?: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClip?: number;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
     goalInGame?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClip?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClipFr?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipSharingUrlFr?: string;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipFr?: number;
 }
 export interface GoalieComparisonTeam {
@@ -545,27 +537,16 @@ export interface SeasonStatsGoalie {
     teamId: number;
     sweaterNumber: number;
     name: LocalizedString;
-    /** Low sample count */
     gamesPlayed?: number;
-    /** Low sample count */
     wins?: number;
-    /** Low sample count */
     losses?: number;
-    /** Low sample count */
     otLosses?: number;
-    /** Low sample count */
     shotsAgainst?: number;
-    /** Low sample count */
     goalsAgainst?: number;
-    /** Low sample count */
     goalsAgainstAvg?: number;
-    /** Low sample count */
     savePctg?: number;
-    /** Low sample count */
     shutouts?: number;
-    /** Low sample count */
     saves?: number;
-    /** Low sample count */
     toi?: string;
 }
 export interface GoalPlay {
@@ -579,7 +560,7 @@ export interface GoalPlay {
     details: GoalDetails;
     situationCode?: OpenUnion<'1551' | '0651' | '1331' | '1010' | '0101' | '1451'>;
     homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     pptReplayUrl?: string;
 }
 export interface HitDetails {
@@ -610,17 +591,11 @@ export interface GoalieLeader {
     sweaterNumber: number;
     headshot: string;
     positionCode: PositionCode;
-    /** Low sample count */
     gamesPlayed?: number;
-    /** Low sample count */
     seasonPoints?: number;
-    /** Low sample count */
     record?: string;
-    /** Low sample count */
     gaa?: number;
-    /** Low sample count */
     savePctg?: number;
-    /** Low sample count */
     shutouts?: number;
 }
 export interface GoalieTeamTotals {
@@ -713,10 +688,13 @@ export interface PenaltyPlayer {
 }
 export interface PenaltyDetails {
     typeCode: string;
-    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping'>;
+    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping' | 'instigator' | 'instigator-misconduct'>;
     duration: number;
     committedByPlayerId: number;
-    drawnByPlayerId: number;
+    /** Absent for penalties nobody drew, e.g. misconducts */
+    drawnByPlayerId?: number;
+    /** Only when someone other than the committing player serves the penalty */
+    servedByPlayerId?: number;
     eventOwnerTeamId: number;
     xCoord?: number;
     yCoord?: number;
@@ -728,8 +706,11 @@ export interface PenaltyEntry {
     duration: number;
     committedByPlayer: PenaltyPlayer;
     teamAbbrev: LocalizedString;
-    drawnBy: PenaltyPlayer;
-    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping'>;
+    /** Absent for penalties nobody drew, e.g. misconducts */
+    drawnBy?: PenaltyPlayer;
+    /** Name of the player serving the penalty, when not the one who committed it */
+    servedBy?: LocalizedString;
+    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping' | 'instigator' | 'instigator-misconduct'>;
 }
 export interface PenaltyPlay {
     eventId: number;
@@ -807,15 +788,18 @@ export interface PlayByPlay {
     otInUse: boolean;
     clock: GameClock;
     displayPeriod: number;
-    /** Absent when game=playoff */
+    /** Absent for playoff games */
     maxPeriods?: number;
     plays: Play[];
     rosterSpots: PlayByPlayRosterSpot[];
     regPeriods: number;
     periodDescriptor?: PeriodDescriptor;
     gameOutcome?: GameOutcome;
-    /** Empty object in every sample seen. */
-    summary?: Record<string, never>;
+    summary?: PlayByPlaySummary;
+}
+export interface PlayByPlaySummary {
+    /** Only present while the game is live */
+    iceSurface?: SummaryIceSurface;
 }
 export interface PlayByPlayTeam {
     id: number;
@@ -827,6 +811,8 @@ export interface PlayByPlayTeam {
     placeName: LocalizedString;
     placeNameWithPreposition: LocalizedString;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface PlayByPlayRosterSpot {
     teamId: number;
@@ -862,17 +848,16 @@ export interface RightRail {
     seasonSeries: RightRailSeasonSeries[];
     seasonSeriesWins: RightRailSeasonSeriesWins;
     gameInfo: RightRailGameInfo;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     teamSeasonStats?: RightRailTeamSeasonStats;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     last10Record?: RightRailLast10Record;
     linescore?: RightRailLinescore;
     shotsByPeriod?: LinescoreByPeriod[];
     teamGameStats?: SummaryTeamGameStat[];
     gameReports?: RightRailGameReports;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Playoff games only */
     seasonSeriesFullCoverageUrl?: GameFullCoverageUrls;
-    /** Absent when game=preseason; game=shootout. Low sample count */
     gameVideo?: RightRailGameVideo;
 }
 export interface RightRailGameInfo {
@@ -889,16 +874,15 @@ export interface RightRailGameReports {
     faceoffComparison: string;
     rosters: string;
     shotSummary: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games */
     shiftChart?: string;
     toiAway: string;
     toiHome: string;
-    /** Absent when game=regular. Low sample count */
+    /** Only for games decided by a shootout */
     shootoutSummary?: string;
 }
 export interface RightRailGameVideo {
     threeMinRecap: number;
-    /** Low sample count */
     condensedGame?: number;
 }
 export interface RightRailLast10Record {
@@ -910,7 +894,7 @@ export interface RightRailLast10Record {
 export interface RightRailLinescore {
     byPeriod: LinescoreByPeriod[];
     totals: LinescoreTotals;
-    /** Absent when game=regular. Low sample count */
+    /** Only for games decided by a shootout */
     shootout?: LinescoreShootout;
 }
 export interface RightRailSeasonSeries {
@@ -928,6 +912,8 @@ export interface RightRailSeasonSeries {
     periodDescriptor?: PeriodDescriptor;
     gameCenterLink: string;
     gameOutcome: GameOutcome;
+    /** Only present while the game is live */
+    clock?: GameClock;
 }
 export interface GameFullCoverageUrls {
     cs: string;
@@ -942,7 +928,7 @@ export interface GameFullCoverageUrls {
 export interface RightRailSeasonSeriesWins {
     awayTeamWins: number;
     homeTeamWins: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Playoff games only */
     neededToWin?: number;
 }
 export interface RightRailTeamSeasonStats {
@@ -970,20 +956,15 @@ export interface ScoringGoal {
     assists: GoalAssist[];
     isHome: boolean;
     situationCode?: OpenUnion<'1551' | '0651' | '1331' | '0101' | '1451'>;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClipSharingUrl?: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClip?: number;
     homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
-    /** Absent when game=playoff; game=preseason; game=shootout. Low sample count */
     goalInGame?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClip?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClipFr?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipSharingUrlFr?: string;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipFr?: number;
 }
 export interface SeasonSeriesTeam {
@@ -1002,7 +983,7 @@ export interface ShiftEntry {
     duration: string | null;
     endTime: string;
     eventDescription: string | null;
-    eventNumber: number;
+    eventNumber: number | null;
     firstName: string;
     gameId: number;
     hexValue: string;
@@ -1015,7 +996,6 @@ export interface ShiftEntry {
     teamId: number;
     teamName: string;
     typeCode: number;
-    /** Low sample count */
     eventDetails?: string | null;
 }
 export interface ShootoutCompletePlay {
@@ -1072,38 +1052,23 @@ export interface ShotOnGoalPlay {
 export interface SeasonStatsSkater {
     playerId: number;
     teamId: number;
-    sweaterNumber: number;
+    sweaterNumber?: number;
     name: LocalizedString;
     position: string;
-    /** Low sample count */
     gamesPlayed?: number;
-    /** Low sample count */
     goals?: number;
-    /** Low sample count */
     assists?: number;
-    /** Low sample count */
     points?: number;
-    /** Low sample count */
     plusMinus?: number;
-    /** Low sample count */
     pim?: number;
-    /** Low sample count */
     avgPoints?: number;
-    /** Low sample count */
     avgTimeOnIce?: string;
-    /** Low sample count */
     gameWinningGoals?: number;
-    /** Low sample count */
     shots?: number;
-    /** Low sample count */
     shootingPctg?: number;
-    /** Low sample count */
     faceoffWinningPctg?: number;
-    /** Low sample count */
     powerPlayGoals?: number;
-    /** Low sample count */
     blockedShots?: number;
-    /** Low sample count */
     hits?: number;
 }
 export interface SkatingLeadersLeader {
@@ -1113,7 +1078,6 @@ export interface SkatingLeadersLeader {
 }
 export interface StoppageDetails {
     reason: OpenUnion<'offside' | 'puck-frozen' | 'puck-in-netting' | 'goalie-stopped-after-sog' | 'puck-in-benches' | 'icing' | 'referee-or-linesman' | 'puck-in-crowd' | 'net-dislodged-offensive-skater' | 'tv-timeout' | 'hand-pass' | 'high-stick' | 'visitor-timeout' | 'objects-on-ice'>;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout */
     secondaryReason?: OpenUnion<'tv-timeout' | 'visitor-timeout'>;
 }
 export interface StoppagePlay {
@@ -1128,6 +1092,26 @@ export interface StoppagePlay {
     sortOrder: number;
     details: StoppageDetails;
 }
+/** The players on the ice right now, with their shift time on ice (`totalSOI`, seconds). */
+export interface SummaryIceSurface {
+    awayTeam: IceSurfaceTeam;
+    homeTeam: IceSurfaceTeam;
+}
+export interface IceSurfaceTeam {
+    forwards: IceSurfacePlayer[];
+    defensemen: IceSurfacePlayer[];
+    goalies: IceSurfacePlayer[];
+    /** Empty in every sample seen. */
+    penaltyBox: unknown[];
+}
+export interface IceSurfacePlayer {
+    playerId: number;
+    name: LocalizedString;
+    sweaterNumber: number;
+    positionCode: PositionCode;
+    headshot: string;
+    totalSOI: number;
+}
 export interface SummaryPenalty {
     periodDescriptor: PeriodDescriptor;
     penalties: PenaltyEntry[];
@@ -1156,9 +1140,9 @@ export interface SummaryThreeStar {
     goals?: number;
     assists?: number;
     points?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     goalsAgainstAverage?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     savePctg?: number;
 }
 export interface TakeawayDetails {
@@ -1192,3 +1176,177 @@ export interface TeamSeasonStats {
     goalsForPerGamePlayedRank: number;
     goalsAgainstPerGamePlayedRank: number;
 }
+export interface GameMeta {
+    teams: MetaTeam[];
+    seasonStates: GameMetaSeasonState;
+    gameState: GameState;
+}
+export interface GameMetaSeasonState {
+    date: string;
+    gameType: GameType;
+    season: number;
+}
+/** A team as `meta` endpoints describe it. */
+export interface MetaTeam {
+    name: LocalizedString;
+    tricode: string;
+    teamId: number;
+    teamSlug: string;
+}
+export interface PlayReplay {
+    id: number;
+    gameDate: string;
+    awayTeam: PlayReplayTeam;
+    homeTeam: PlayReplayTeam;
+    gameState: GameState;
+    gameType: GameType;
+    /** Only present when the event is a goal */
+    goal?: PlayReplayGoal;
+}
+export interface PlayReplayGoal {
+    periodDescriptor: PeriodDescriptor;
+    situationCode: string;
+    strength: string;
+    playerId: number;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    name: LocalizedString;
+    teamAbbrev: LocalizedString;
+    headshot: string;
+    highlightClip: number;
+    logoUrl: string;
+    highlightClipSharingUrl: string;
+    goalsToDate: number;
+    sweaterNumber: number;
+    awayScore: number;
+    homeScore: number;
+    leadingTeamAbbrev: LocalizedString;
+    timeInPeriod: string;
+    shotType: ShotType;
+    goalModifier: string;
+    assists: GoalAssist[];
+    pptReplayUrl: string;
+    homeTeamDefendingSide: OpenUnion<'left' | 'right'>;
+    isHome: boolean;
+    eventId: number;
+}
+export interface PlayReplayTeam {
+    id: number;
+    name: LocalizedString;
+    abbrev: string;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    logo: string;
+    darkLogo: string;
+}
+export interface Scoreboard {
+    focusedDate: string;
+    focusedDateCount: number;
+    gamesByDate: ScoreboardDate[];
+}
+export interface ScoreboardDate {
+    date: string;
+    games: ScoreboardGame[];
+}
+export interface ScoreboardGame {
+    id: number;
+    season: number;
+    gameType: GameType;
+    gameDate: string;
+    gameCenterLink: string;
+    venue: LocalizedString;
+    startTimeUTC: string;
+    easternUTCOffset: string;
+    venueUTCOffset: string;
+    tvBroadcasts: DailyScoresTvBroadcast[];
+    gameState: GameState;
+    gameScheduleState: GameScheduleState;
+    awayTeam: ScoreboardTeam;
+    homeTeam: ScoreboardTeam;
+    /** Absent before the game starts */
+    period?: number;
+    /** Absent before the game starts */
+    periodDescriptor?: PeriodDescriptor;
+    /** Only present while the game is live */
+    clock?: GameClock;
+    /** Absent before the game is played */
+    threeMinRecap?: string;
+    /** Absent before the game is played */
+    threeMinRecapFr?: string;
+    /** Only present before the game starts */
+    ticketsLink?: string;
+    /** Only present before the game starts */
+    ticketsLinkFr?: string;
+    /** Playoff games only */
+    seriesStatus?: ScoreboardSeriesStatus;
+}
+export interface ScoreboardSeriesStatus {
+    round: number;
+    seriesAbbrev: string;
+    game: number;
+    topSeedTeamAbbrev: string;
+    topSeedWins: number;
+    bottomSeedTeamAbbrev: string;
+    bottomSeedWins: number;
+}
+export interface ScoreboardTeam {
+    id: number;
+    name: LocalizedString;
+    commonName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    /** Absent before the game starts */
+    score?: number;
+    /** Only present while the game is live */
+    sog?: number;
+    logo: string;
+    /** Only present before the game starts */
+    record?: string;
+}
+/** A play from `wsc/play-by-play`. Flat, unlike {@link Play}: event details sit on the play itself. */
+export interface WscPlay {
+    id: number;
+    eventId: number;
+    period: number;
+    timeInPeriod: string;
+    secondsRemaining: number;
+    typeCode: number;
+    typeDescKey: OpenUnion<'shot-on-goal' | 'penalty' | 'goal' | 'period-start' | 'faceoff' | 'giveaway' | 'missed-shot' | 'takeaway' | 'blocked-shot' | 'hit' | 'delayed-penalty' | 'period-end' | 'game-end'>;
+    sortOrder: number;
+    shotType?: ShotType;
+    shootingPlayerId?: number;
+    goalieInNetId?: number;
+    eventOwnerTeamId?: number;
+    awaySOG?: number;
+    homeSOG?: number;
+    penaltyTypeCode?: string;
+    descKey?: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping'>;
+    duration?: number;
+    committedByPlayerId?: number;
+    drawnByPlayerId?: number;
+    goalModifier?: string;
+    strength?: string;
+    scoringPlayerId?: number;
+    assist1PlayerId?: number;
+    assist2PlayerId?: number;
+    awayScore?: number;
+    homeScore?: number;
+    strengthCode?: number;
+    goalCode?: number;
+    scoringPlayerTotal?: number;
+    assist1PlayerTotal?: number;
+    assist2PlayerTotal?: number;
+    situationCode?: string;
+    homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
+    utc?: string;
+    losingPlayerId?: number;
+    winningPlayerId?: number;
+    xCoord?: number;
+    yCoord?: number;
+    zoneCode?: ZoneCode;
+    playerId?: number;
+    reason?: OpenUnion<'hit-right-post' | 'wide-right' | 'blocked' | 'high-and-wide-right' | 'wide-left' | 'above-crossbar' | 'short' | 'high-and-wide-left' | 'teammate-blocked' | 'hit-crossbar' | 'hit-left-post'>;
+    blockingPlayerId?: number;
+    hittingPlayerId?: number;
+    hitteePlayerId?: number;
+}