remove method

Future<DynamiteResponse<ApiRemoveResponseApplicationJson, void>> remove({
  1. required String version,
  2. required int fileId,
  3. bool? oCSAPIRequest,
})

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 to true.

Status codes:

  • 200: Reminder deleted successfully
  • 401: User not found
  • 404: Reminder not found

See:

Implementation

Future<DynamiteResponse<ApiRemoveResponseApplicationJson, void>> remove({
  required String version,
  required int fileId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = removeRaw(
    version: version,
    fileId: fileId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}