gamesheet_sdk.teams.schedule.update module¶
Update functions and raw handlers for schedule resources.
- gamesheet_sdk.teams.schedule.update.update_calendar_occurrence(session, occurrence_id, payload, *, update_future=False, timeout=15.0)[source]¶
Update a calendar occurrence and return validated CalendarEventCreated model.
- Parameters:
session (BaseAuthenticatedSession) – Authenticated session instance.
occurrence_id (str) – UUID of the occurrence to update.
payload (dict[str, Any]) – Dictionary containing fields to update.
update_future (bool) – If True, updates this and all future occurrences.
timeout (float) – Request timeout in seconds.
- Returns:
CalendarEventCreated – Validated response model.
- Raises:
GameSheetError – If the server returns an error.
- Return type:
- gamesheet_sdk.teams.schedule.update.update_calendar_occurrence_raw(session, occurrence_id, payload, *, update_future=False, timeout=15.0)[source]¶
Execute raw HTTP PUT request to update an occurrence via PUT /api/calendar/occurrences/{occurrence_id}.
- Parameters:
session (BaseAuthenticatedSession) – Authenticated session instance.
occurrence_id (str) – Identifier of the occurrence to update.
update_future (bool) – Whether to update this and all future occurrences (default: False).
timeout (float) – Request timeout in seconds.
- Returns:
dict[str, Any] – Parsed JSON response from the API.
- Raises:
AuthenticationError – If the user is not authenticated (401).
GameSheetError – If the server returns an error or malformed response.
- Return type:
- gamesheet_sdk.teams.schedule.update.update_event(session, occurrence_id, *, title=None, notes=None, location_name=None, start_date=None, end_date=None, rrule=None, update_future=False, timeout=15.0)[source]¶
Update a non-game calendar event occurrence.
- Parameters:
session (BaseAuthenticatedSession) – Authenticated session instance.
occurrence_id (str) – Occurrence identifier (UUID).
title (str | None) – Event title.
notes (str | None) – Event notes / description.
location_name (str | None) – Venue / location name.
start_date (str | None) – ISO formatted start datetime (UTC).
end_date (str | None) – ISO formatted end datetime (UTC).
rrule (str | None) – RRULE recurrence rule string.
update_future (bool) – Update future occurrences if recurring.
timeout (float) – Request timeout in seconds.
- Returns:
CalendarEventCreated – Validated response model.
- Return type:
- gamesheet_sdk.teams.schedule.update.update_game(session, game_id, *, team_id=None, season_id=None, division_id=None, opposing_team_id=None, opposing_division=None, association_id=None, league_id=None, home_flag=None, date_time=None, end_time=None, game_number=None, game_type=None, location=None, scorekeeper_name=None, scorekeeper_phone=None, broadcast_provider=None, time_zone_name=None, time_zone_offset=None, timeout=15.0)[source]¶
Update a scheduled game via the teams schedule-game endpoint.
- Parameters:
session (BaseAuthenticatedSession) – Authenticated session instance.
opposing_team_id (int | str | None) – Opposing team identifier.
opposing_division (int | str | None) – Opposing division identifier.
home_flag (bool | None) – Whether the team is the home team.
date_time (str | None) – Start date/time (e.g. ‘2026-08-24T15:00’).
end_time (str | None) – End time (e.g. ‘16:15’).
game_number (str | None) – Game number.
game_type (str | None) – Game type.
location (str | None) – Game location / venue.
scorekeeper_name (str | None) – Scorekeeper name.
scorekeeper_phone (str | None) – Scorekeeper phone.
broadcast_provider (str | None) – Broadcast provider key.
time_zone_name (str | None) – IANA timezone name.
time_zone_offset (int | None) – Timezone offset in minutes.
timeout (float) – Request timeout in seconds.
- Returns:
UpdatedGameResult – Result containing updated game details.
- Return type:
- gamesheet_sdk.teams.schedule.update.update_practice(session, occurrence_id, *, title=None, start_date=None, end_date=None, notes=None, location_name=None, rrule=None, update_future=False, timeout=15.0)[source]¶
Update a practice occurrence.
- Parameters:
session (BaseAuthenticatedSession) – Authenticated session instance.
occurrence_id (str) – Identifier of the occurrence to update.
title (str | None) – Practice title.
start_date (str | None) – ISO start datetime string.
end_date (str | None) – ISO end datetime string.
notes (str | None) – Practice notes or description.
location_name (str | None) – Venue or location address.
rrule (str | None) – Recurrence rule.
update_future (bool) – If True, update this and future occurrences.
timeout (float) – Request timeout in seconds.
- Returns:
CalendarEventCreated – Updated occurrence details model.
- Return type:
- gamesheet_sdk.teams.schedule.update.update_schedule_game_raw(session, game_id, payload, *, timeout=15.0)[source]¶
Execute raw HTTP PUT request to update a scheduled game via PUT /api/schedule-game/{game_id}.
- Parameters:
- Returns:
dict[str, Any] – Parsed JSON response from the API.
- Raises:
AuthenticationError – If the user is not authenticated (401).
GameSheetError – If the server returns an error or malformed response.
- Return type: