getGroups method

Future<DynamiteResponse<GroupsGetGroupsResponseApplicationJson, void>> getGroups({ String? search, int? limit, int? offset, bool? oCSAPIRequest, })

Get a list of groups.

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:

• search Text to search for. Defaults to "".
• limit Limit the amount of groups returned.
• offset Offset for searching for groups. Defaults to 0.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Groups returned

See:

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

Implementation

Future<_i1.DynamiteResponse<GroupsGetGroupsResponseApplicationJson, void>> getGroups({
  String? search,
  int? limit,
  int? offset,
  bool? oCSAPIRequest,
}) async {
  final _request = $getGroups_Request(
    search: search,
    limit: limit,
    offset: offset,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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