gamesheet_sdk.teams.schedule.delete module

Deletion functions and raw handlers for schedule resources.

gamesheet_sdk.teams.schedule.delete.delete_calendar_event(session, event_id, *, timeout=15.0)[source]

Delete a calendar event and all of its occurrences.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • event_id (str) – Identifier of the calendar event series.

  • timeout (float) – Request timeout in seconds.

Returns:

ScheduleDeleteResult – Result of deletion containing success flag and message.

Return type:

ScheduleDeleteResult

gamesheet_sdk.teams.schedule.delete.delete_calendar_event_raw(session, event_id, *, timeout=15.0)[source]

Execute raw HTTP DELETE request to delete a calendar event series.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • event_id (str) – ID of the calendar event series to delete.

  • timeout (float) – Request timeout in seconds.

Returns:

dict[str, Any] – Parsed JSON response from the API.

Raises:
Return type:

dict[str, Any]

gamesheet_sdk.teams.schedule.delete.delete_calendar_occurrence(session, occurrence_id, *, delete_future=False, timeout=15.0)[source]

Delete a calendar occurrence (optionally including all future occurrences).

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • occurrence_id (str) – Identifier of the occurrence.

  • delete_future (bool) – If True, delete this and all future occurrences.

  • timeout (float) – Request timeout in seconds.

Returns:

ScheduleDeleteResult – Result of deletion containing success flag and message.

Return type:

ScheduleDeleteResult

gamesheet_sdk.teams.schedule.delete.delete_calendar_occurrence_raw(session, occurrence_id, *, delete_future=False, timeout=15.0)[source]

Execute raw HTTP DELETE request to delete a calendar occurrence.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • occurrence_id (str) – ID of the calendar occurrence to delete.

  • delete_future (bool) – Whether to delete this and all future occurrences.

  • timeout (float) – Request timeout in seconds.

Returns:

dict[str, Any] – Parsed JSON response from the API.

Raises:
Return type:

dict[str, Any]

gamesheet_sdk.teams.schedule.delete.delete_event(session, event_id, *, delete_future=False, all_occurrences=False, timeout=15.0)[source]

Delete a calendar event series or occurrence.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • event_id (str) – Identifier of the calendar event or occurrence.

  • delete_future (bool) – If True, delete this and all future occurrences.

  • all_occurrences (bool) – If True, delete the entire event series via /api/calendar/events.

  • timeout (float) – Request timeout in seconds.

Returns:

ScheduleDeleteResult – Result of deletion containing success flag and message.

Return type:

ScheduleDeleteResult

gamesheet_sdk.teams.schedule.delete.delete_game(session, game_id, *, timeout=15.0)[source]

Delete a scheduled game.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • game_id (str | int) – Identifier of the scheduled game.

  • timeout (float) – Request timeout in seconds.

Returns:

ScheduleDeleteResult – Result of deletion containing success flag and message.

Return type:

ScheduleDeleteResult

gamesheet_sdk.teams.schedule.delete.delete_practice(session, practice_id, *, delete_future=False, all_occurrences=False, timeout=15.0)[source]

Delete a practice calendar event series or occurrence.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • practice_id (str) – Identifier of the practice event or occurrence.

  • delete_future (bool) – If True, delete this and all future occurrences.

  • all_occurrences (bool) – If True, delete the entire practice series via /api/calendar/events.

  • timeout (float) – Request timeout in seconds.

Returns:

ScheduleDeleteResult – Result of deletion containing success flag and message.

Return type:

ScheduleDeleteResult

gamesheet_sdk.teams.schedule.delete.delete_schedule_game_raw(session, game_id, *, timeout=15.0)[source]

Execute raw HTTP DELETE request to delete a scheduled game via DELETE /api/schedule-game/{game_id}.

Parameters:

  • session (BaseAuthenticatedSession) – Authenticated session instance.

  • game_id (str | int) – ID of the scheduled game to delete.

  • timeout (float) – Request timeout in seconds.

Returns:

dict[str, Any] – Parsed JSON response from the API.

Raises:
Return type:

dict[str, Any]