getDisabledUsersDetails method

Future<DynamiteResponse<UsersGetDisabledUsersDetailsResponseApplicationJson, void>> getDisabledUsersDetails({ int? limit, int? offset, bool? oCSAPIRequest, })

Get the list of disabled users and their details.

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:

• limit Limit the amount of users returned.
• offset Offset. Defaults to 0.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Disabled users details returned

See:

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

Implementation

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

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