deleteGroupMembers method

Future<MmStatusOK?> deleteGroupMembers(String groupId, MmDeleteGroupMembersRequest mmDeleteGroupMembersRequest)

Removes members from a custom group

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

Parameters:

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

• MmDeleteGroupMembersRequest mmDeleteGroupMembersRequest (required):

Implementation

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