addToGroup method

Future<DynamiteResponse<UsersAddToGroupResponseApplicationJson, void>> addToGroup({ required String userId, String? groupid, bool? oCSAPIRequest, })

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:

• groupid ID of the group. Defaults to "".
• 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:

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

Implementation

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

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