editUser method
Future<DynamiteResponse<UsersEditUserResponseApplicationJson, void> >
editUser({
- required String userId,
- required UsersEditUserRequestApplicationJson $body,
- bool? oCSAPIRequest,
Update a value of the user's details.
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 of the user.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: User value edited successfully
See:
- $editUser_Request for the request send by this method.
- $editUser_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<UsersEditUserResponseApplicationJson, void>> editUser({
required String userId,
required UsersEditUserRequestApplicationJson $body,
bool? oCSAPIRequest,
}) async {
final _request = $editUser_Request(
userId: userId,
oCSAPIRequest: oCSAPIRequest,
$body: $body,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $editUser_Serializer();
return _i1.ResponseConverter<UsersEditUserResponseApplicationJson, void>(_serializer).convert(_response);
}