addToGroup method

Future<DynamiteResponse<UsersAddToGroupResponseApplicationJson, void>> addToGroup({
  1. required String userId,
  2. bool? oCSAPIRequest,
  3. UsersAddToGroupRequestApplicationJson? $body,
})

Add a user to a group.

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 to true.

Status codes:

  • 200: User added to group successfully

See:

Implementation

Future<_i1.DynamiteResponse<UsersAddToGroupResponseApplicationJson, void>> addToGroup({
  required String userId,
  bool? oCSAPIRequest,
  UsersAddToGroupRequestApplicationJson? $body,
}) async {
  final _request = $addToGroup_Request(
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
    $body: $body,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $addToGroup_Serializer();
  return _i1.ResponseConverter<UsersAddToGroupResponseApplicationJson, void>(_serializer).convert(_response);
}