deleteCalendarEvent method
Delete an event.
Hard delete (no soft-delete / trash). Cascades to any reminder tasks the platform created from this event.
Parameters:
-
String id (required): Event id.
-
String accountId (required): Connected-account id (snake_case in this platform — the rest of the SpatioAPI uses
accountId). Required for single-event operations. -
String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
Implementation
Future<CalendarOperationResult?> deleteCalendarEvent(String id, String accountId, { String? xWorkspaceID, }) async {
final response = await deleteCalendarEventWithHttpInfo(id, accountId, xWorkspaceID: xWorkspaceID, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'CalendarOperationResult',) as CalendarOperationResult;
}
return null;
}