gamesheet_sdk.admin.games.brackets module¶

Bracket and general game list operations.

gamesheet_sdk.admin.games.brackets.list_completed(session, season_id)[source]¶

Return every completed game in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401. :param session: An authenticated Session. :type session: Session :param season_id: The season identifier whose completed games to list. :type season_id: str :returns: A list of Game, in the order the server returned them. The list may be empty if the

season has no completed games.

Return type:: list[Game]

gamesheet_sdk.admin.games.brackets.list_brackets(session, season_id)[source]¶

Return every bracket game in the specified season.

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

Note

The brackets filter is based on the expected API pattern but has not been verified with real bracket data. If this returns unexpected results, the filter parameters may need adjustment.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier whose bracket games to list.

Returns:

A list of Game, in the order the server returned them. The list may be empty if the season has no bracket games.

Return type:

list[Game]

Raises:

AuthenticationError – If the server returns 401.
GameSheetError – For any other non-2xx response.

gamesheet_sdk.admin.games.brackets.get_game(session, season_id, game_id)[source]¶

Get a single game by ID.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401. :param session: An authenticated Session. :type session: Session :param season_id: The parent season identifier. :type season_id: str :param game_id: The game identifier to retrieve. :type game_id: int :returns: The Game with the specified ID. :rtype: Game :raises GameSheetError: For any other non-2xx response, including 404 if the game is not found.

Return type:: Game