unbanActor method
Future<DynamiteResponse<BanUnbanActorResponseApplicationJson, void> >
unbanActor({
- required String token,
- required int banId,
- BanUnbanActorApiVersion? apiVersion,
- bool? oCSAPIRequest,
Unban 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
banId
ID of the ban to be removed.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Unban successfully or not found
See:
- $unbanActor_Request for the request send by this method.
- $unbanActor_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<BanUnbanActorResponseApplicationJson, void>> unbanActor({
required String token,
required int banId,
BanUnbanActorApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $unbanActor_Request(
token: token,
banId: banId,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $unbanActor_Serializer();
return _i1.ResponseConverter<BanUnbanActorResponseApplicationJson, void>(_serializer).convert(_response);
}