delete method

Future<DynamiteResponse<ApiDeleteResponseApplicationJson, void>> delete({ bool? oCSAPIRequest, })

Trigger the deletion of the current user account.

This endpoint requires password confirmation.

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:

• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 201: A confirmation by email is required. An email has been sent to the user
• 202: The user has been marked for deletion
• 401: Unable to get user from session
• 403: The user was not allowed to be deleted
• 400: The user has no email set up in it's account to send the confirmation email to
• 500: An exception was thrown when sending the user a confirmation email

See:

• $delete_Request for the request send by this method.
• $delete_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<ApiDeleteResponseApplicationJson, void>> delete({bool? oCSAPIRequest}) async {
  final _request = $delete_Request(
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $delete_Serializer();
  return _i1.ResponseConverter<ApiDeleteResponseApplicationJson, void>(_serializer).convert(_response);
}