deleteRoom method

Future<DynamiteResponse<RoomDeleteRoomResponseApplicationJson, void>> deleteRoom({ required String token, RoomDeleteRoomApiVersion? apiVersion, bool? oCSAPIRequest, })

Delete a room.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• apiVersion Defaults to "v4".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Room successfully deleted
• 400: Deleting room is not possible

See:

• $deleteRoom_Request for the request send by this method.
• $deleteRoom_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<RoomDeleteRoomResponseApplicationJson, void>> deleteRoom({
  required String token,
  RoomDeleteRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $deleteRoom_Request(token: token, apiVersion: apiVersion, oCSAPIRequest: oCSAPIRequest);
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $deleteRoom_Serializer();
  return _i1.ResponseConverter<RoomDeleteRoomResponseApplicationJson, void>(_serializer).convert(_response);
}