getListedRooms method

Future<DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void>> getListedRooms({ String? searchTerm, RoomGetListedRoomsApiVersion? apiVersion, bool? oCSAPIRequest, })

Get listed rooms with optional search term.

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:

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

Status codes:

• 200: Return list of matching rooms

See:

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

Implementation

Future<_i1.DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void>> getListedRooms({
  String? searchTerm,
  RoomGetListedRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $getListedRooms_Request(
    searchTerm: searchTerm,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $getListedRooms_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<RoomGetListedRoomsResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}