generateNotification method

Future<DynamiteResponse<ApiGenerateNotificationResponseApplicationJson, void>> generateNotification({ required String shortMessage, required String userId, String? longMessage, ApiGenerateNotificationApiVersion? apiVersion, 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:

• $generateNotification_Request for the request send by this method.
• $generateNotification_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<ApiGenerateNotificationResponseApplicationJson, void>> generateNotification({
  required String shortMessage,
  required String userId,
  String? longMessage,
  ApiGenerateNotificationApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $generateNotification_Request(
    shortMessage: shortMessage,
    userId: userId,
    longMessage: longMessage,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

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