clearHistory method

Future<DynamiteResponse<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>> clearHistory({ required String token, ChatClearHistoryApiVersion? apiVersion, bool? oCSAPIRequest, })

Clear the chat history.

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: History cleared successfully
• 202: History cleared successfully, but Matterbridge is configured, so the information can be replicated elsewhere
• 403: Missing permissions to clear history

See:

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

Implementation

Future<_i1.DynamiteResponse<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>> clearHistory({
  required String token,
  ChatClearHistoryApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $clearHistory_Request(
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $clearHistory_Serializer();
  return _i1.ResponseConverter<ChatClearHistoryResponseApplicationJson, ChatChatClearHistoryHeaders>(_serializer)
      .convert(_response);
}