remove method
Remove a reminder.
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:
version
fileId
ID of the file.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Reminder deleted successfully
- 401: Account not found
- 404: Reminder not found
See:
- $remove_Request for the request send by this method.
- $remove_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ApiRemoveResponseApplicationJson, void>> remove({
required String version,
required int fileId,
bool? oCSAPIRequest,
}) async {
final _request = $remove_Request(
version: version,
fileId: fileId,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $remove_Serializer();
return _i1.ResponseConverter<ApiRemoveResponseApplicationJson, void>(_serializer).convert(_response);
}