getNotification method

Future<DynamiteResponse<EndpointGetNotificationResponseApplicationJson, void>> getNotification({
  1. required int id,
  2. EndpointGetNotificationApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Get 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 Version of the API to use. 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 returned
  • 404: Notification not found

See:

Implementation

Future<DynamiteResponse<EndpointGetNotificationResponseApplicationJson, void>> getNotification({
  required int id,
  EndpointGetNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getNotificationRaw(
    id: id,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}