softDeleteTeamWithHttpInfo method

Future<Response> softDeleteTeamWithHttpInfo(String teamId, { bool? permanent, })

Delete a team

Soft deletes a team, by marking the team as deleted in the database. Soft deleted teams will not be accessible in the user interface. Optionally use the permanent query parameter to hard delete the team for compliance reasons. As of server version 5.0, to use this feature ServiceSettings.EnableAPITeamDeletion must be set to true in the server's configuration. ##### Permissions Must have the manage_team permission.

Note: This method returns the HTTP Response.

Parameters:

• String teamId (required): Team GUID

• bool permanent: Permanently delete the team, to be used for compliance reasons only. As of server version 5.0, ServiceSettings.EnableAPITeamDeletion must be set to true in the server's configuration.

Implementation

Future<Response> softDeleteTeamWithHttpInfo(
  String teamId, {
  bool? permanent,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/teams/{team_id}'.replaceAll('{team_id}', teamId);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <MmQueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (permanent != null) {
    queryParams.addAll(_queryParams('', 'permanent', permanent));
  }

  const contentTypes = <String>[];

  return apiClient.invokeAPI(
    path,
    'DELETE',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}