list method

Future<GetOrderNotesResponse> list (
  1. String proposalId,
  2. {String pqlQuery,
  3. String $fields}
)

Get all the notes associated with a proposal

Request parameters:

proposalId - The proposalId to get notes for. To search across all proposals specify order_id = '-' as part of the URL.

pqlQuery - Query string to retrieve specific notes. To search the text contents of notes, please use syntax like "WHERE note.note = "foo" or "WHERE note.note LIKE "%bar%"

$fields - Selector specifying which fields to include in a partial response.

Completes with a GetOrderNotesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GetOrderNotesResponse> list(core.String proposalId,
    {core.String pqlQuery, core.String $fields}) {
  var _url;
  var _queryParams = new core.Map<core.String, core.List<core.String>>();
  var _uploadMedia;
  var _uploadOptions;
  var _downloadOptions = commons.DownloadOptions.Metadata;
  var _body;

  if (proposalId == null) {
    throw new core.ArgumentError("Parameter proposalId is required.");
  }
  if (pqlQuery != null) {
    _queryParams["pqlQuery"] = [pqlQuery];
  }
  if ($fields != null) {
    _queryParams["fields"] = [$fields];
  }

  _url =
      'proposals/' + commons.Escaper.ecapeVariable('$proposalId') + '/notes';

  var _response = _requester.request(_url, "GET",
      body: _body,
      queryParams: _queryParams,
      uploadOptions: _uploadOptions,
      uploadMedia: _uploadMedia,
      downloadOptions: _downloadOptions);
  return _response.then((data) => new GetOrderNotesResponse.fromJson(data));
}