$deleteNotification_Request method

@experimental Request $deleteNotification_Request({ required int id, EndpointDeleteNotificationApiVersion? apiVersion, bool? oCSAPIRequest, })

Delete a notification.

Returns a DynamiteRequest backing the deleteNotification operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• apiVersion Defaults to "v2".
• id ID of the notification.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Notification deleted successfully
• 403: Deleting notification for impersonated user is not allowed
• 404: Notification not found

See:

• deleteNotification for a method executing this request and parsing the response.
• $deleteNotification_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $deleteNotification_Request({
  required int id,
  EndpointDeleteNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $id = _$jsonSerializers.serialize(id, specifiedType: const FullType(int));
  _parameters['id'] = $id;

  var $apiVersion =
      _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(EndpointDeleteNotificationApiVersion));
  $apiVersion ??= 'v2';
  _parameters['apiVersion'] = $apiVersion;

  final _path =
      _i4.UriTemplate('/ocs/v2.php/apps/notifications/api/{apiVersion}/notifications/{id}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('delete', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _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;
}