getListedRooms method

Future<DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void>> getListedRooms({
  1. String? searchTerm,
  2. RoomGetListedRoomsApiVersion? apiVersion,
  3. 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:

  • getListedRoomsRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<RoomGetListedRoomsResponseApplicationJson, void>> getListedRooms({
  String? searchTerm,
  RoomGetListedRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getListedRoomsRaw(
    searchTerm: searchTerm,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}