disableBot method

Future<DynamiteResponse<BotDisableBotResponseApplicationJson, void>> disableBot({ required String token, required int botId, BotDisableBotApiVersion? apiVersion, bool? oCSAPIRequest, })

Disables a bot.

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
• botId ID of the bot.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Bot disabled successfully
• 400: Disabling bot errored

See:

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

Implementation

Future<_i1.DynamiteResponse<BotDisableBotResponseApplicationJson, void>> disableBot({
  required String token,
  required int botId,
  BotDisableBotApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $disableBot_Request(
    token: token,
    botId: botId,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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