deleteScheme method

Future<MmStatusOK?> deleteScheme(
  1. String schemeId
)

Delete a scheme

Soft deletes a scheme, by marking the scheme as deleted in the database. ##### Permissions Must have manage_system permission. Minimum server version: 5.0

Parameters:

  • String schemeId (required): ID of the scheme to delete

Implementation

Future<MmStatusOK?> deleteScheme(
  String schemeId,
) async {
  final response = await deleteSchemeWithHttpInfo(
    schemeId,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw MmApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'MmStatusOK',
    ) as MmStatusOK;
  }
  return null;
}