deleteNotification method

Future<DynamiteResponse<EndpointDeleteNotificationResponseApplicationJson, void>> deleteNotification({
  1. required int id,
  2. EndpointDeleteNotificationApiVersion? apiVersion,
  3. 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:

  • deleteNotificationRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<EndpointDeleteNotificationResponseApplicationJson, void>> deleteNotification({
  required int id,
  EndpointDeleteNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = deleteNotificationRaw(
    id: id,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}