gamesheet_sdk.admin.games.completed module

Completed game operations.

gamesheet_sdk.admin.games.completed.get_completed_game(session, season_id, game_id)[source]

Get a completed game with full details (JSON:API format).

Returns the full JSON:API response including rosters, goals, shots, penalties, and all related data. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

  • session (Session) – An authenticated Session.

  • season_id (str) – The parent season identifier.

  • game_id (str) – The game identifier to retrieve.

Returns:

dict[str, Any] – The full game data as a dictionary (JSON:API format with data/included/relationships).

Return type:

dict[str, Any]

gamesheet_sdk.admin.games.completed.download_completed_game_pdf(session, game_id, output_path)[source]

Download the PDF scoresheet for a completed game.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

  • session (Session) – An authenticated Session.

  • game_id (str) – The game identifier.

  • output_path (str) – File path where the PDF will be saved.