listBans method

Future<DynamiteResponse<BanListBansResponseApplicationJson, void>> listBans({ required String token, BanListBansApiVersion? apiVersion, bool? oCSAPIRequest, })

List the bans of a conversation.

Required capability: ban-v1.

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 "v1".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: List all bans

See:

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

Implementation

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

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