$delete_Request method

@experimental Request $delete_Request({ bool? oCSAPIRequest, })

Trigger the deletion of the current user account.

This endpoint requires password confirmation.

Returns a DynamiteRequest backing the delete operation. 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 for a method executing this request and parsing the response.
• $delete_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $delete_Request({bool? oCSAPIRequest}) {
  const _path = '/ocs/v2.php/apps/drop_account/api/v1/account';
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('delete', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i5.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}