generateNotification method

Future<DynamiteResponse<ApiGenerateNotificationResponseApplicationJson, void>> generateNotification({
  1. required String shortMessage,
  2. required String userId,
  3. String? longMessage,
  4. ApiGenerateNotificationApiVersion? apiVersion,
  5. bool? oCSAPIRequest,
})

Generate a notification for a user.

This endpoint requires admin access.

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:

  • shortMessage Subject of the notification.
  • longMessage Message of the notification. Defaults to ''.
  • apiVersion Defaults to v2.
  • userId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Notification generated successfully
  • 400: Generating notification is not possible
  • 404: User not found
  • 500

See:

Implementation

Future<DynamiteResponse<ApiGenerateNotificationResponseApplicationJson, void>> generateNotification({
  required String shortMessage,
  required String userId,
  String? longMessage,
  ApiGenerateNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = generateNotificationRaw(
    shortMessage: shortMessage,
    userId: userId,
    longMessage: longMessage,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}