deleteGroup method

Future<MmStatusOK?> deleteGroup(
  1. String groupId
)

Deletes a custom group

Soft deletes a custom group. ##### Permissions Must have custom_group_delete permission for the given group. Minimum server version: 6.3

Parameters:

  • String groupId (required): The ID of the group.

Implementation

Future<MmStatusOK?> deleteGroup(
  String groupId,
) async {
  final response = await deleteGroupWithHttpInfo(
    groupId,
  );
  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;
}