destroy method

Future<DynamiteResponse<ContextDestroyResponseApplicationJson, void>> destroy({ required int contextId, bool? oCSAPIRequest, })

api v2 Delete an existing context and return it.

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:

• contextId ID of the context.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: returning the full context information
• 500
• 404: Not found

See:

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

Implementation

Future<_i1.DynamiteResponse<ContextDestroyResponseApplicationJson, void>> destroy({
  required int contextId,
  bool? oCSAPIRequest,
}) async {
  final _request = $destroy_Request(
    contextId: contextId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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