banActor method

Future<DynamiteResponse<BanBanActorResponseApplicationJson, void>> banActor({
  1. required String token,
  2. required BanBanActorRequestApplicationJson $body,
  3. BanBanActorApiVersion? apiVersion,
  4. bool? oCSAPIRequest,
})

Ban an actor or IP address.

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: Ban successfully
  • 400: Actor information is invalid

See:

Implementation

Future<_i1.DynamiteResponse<BanBanActorResponseApplicationJson, void>> banActor({
  required String token,
  required BanBanActorRequestApplicationJson $body,
  BanBanActorApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $banActor_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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