generateNotification method
Future<DynamiteResponse<ApiGenerateNotificationResponseApplicationJson, void> >
generateNotification({
- required String userId,
- required ApiGenerateNotificationRequestApplicationJson $body,
- 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:
apiVersion
Defaults to"v2"
.userId
ID of the user.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
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 userId,
required ApiGenerateNotificationRequestApplicationJson $body,
ApiGenerateNotificationApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $generateNotification_Request(
userId: userId,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
$body: $body,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $generateNotification_Serializer();
return _i1.ResponseConverter<ApiGenerateNotificationResponseApplicationJson, void>(_serializer).convert(_response);
}