deleteNotification method

Future<DynamiteResponse<EndpointDeleteNotificationResponseApplicationJson, void>> deleteNotification({ required int id, EndpointDeleteNotificationApiVersion? apiVersion, bool? oCSAPIRequest, })

Delete a notification.

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:

• 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_Request for the request send by this method.
• $deleteNotification_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<EndpointDeleteNotificationResponseApplicationJson, void>> deleteNotification({
  required int id,
  EndpointDeleteNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $deleteNotification_Request(
    id: id,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $deleteNotification_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<EndpointDeleteNotificationResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}