getEditableFieldsForUser method

Future<DynamiteResponse<UsersGetEditableFieldsForUserResponseApplicationJson, void>> getEditableFieldsForUser({ required String userId, bool? oCSAPIRequest, })

Get a list of fields that are editable for a user.

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: Editable fields for user returned

See:

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

Implementation

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

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