resendWelcomeMessage method
Future<DynamiteResponse<UsersResendWelcomeMessageResponseApplicationJson, void> >
resendWelcomeMessage({})
Resend the welcome message.
This endpoint requires password confirmation.
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:
userId
ID if the user.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Resent welcome message successfully
See:
- $resendWelcomeMessage_Request for the request send by this method.
- $resendWelcomeMessage_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<UsersResendWelcomeMessageResponseApplicationJson, void>> resendWelcomeMessage({
required String userId,
bool? oCSAPIRequest,
}) async {
final _request = $resendWelcomeMessage_Request(
userId: userId,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $resendWelcomeMessage_Serializer();
final _rawResponse =
await _i1.ResponseConverter<UsersResendWelcomeMessageResponseApplicationJson, void>(_serializer)
.convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}