deleteTask method

Future<DynamiteResponse<TextProcessingApiDeleteTaskResponseApplicationJson, void>> deleteTask({ required int id, bool? oCSAPIRequest, })

This endpoint allows to delete a scheduled task for a user.

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:

• id The id of the task.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Task returned
• 404: Task not found
• 500

See:

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

Implementation

Future<_i1.DynamiteResponse<TextProcessingApiDeleteTaskResponseApplicationJson, void>> deleteTask({
  required int id,
  bool? oCSAPIRequest,
}) async {
  final _request = $deleteTask_Request(
    id: id,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $deleteTask_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<TextProcessingApiDeleteTaskResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}