addNote method

Future<Note> addNote(AddNoteRequest request, String accountId, String proposalId, { String? $fields, })

Create a new note and attach it to the proposal.

The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.

request - The metadata request object.

Request parameters:

accountId - Account ID of the buyer.

proposalId - The ID of the proposal to attach the note to.

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

Completes with a Note.

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<Note> addNote(
  AddNoteRequest request,
  core.String accountId,
  core.String proposalId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2beta1/accounts/' +
      commons.escapeVariable('$accountId') +
      '/proposals/' +
      commons.escapeVariable('$proposalId') +
      ':addNote';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return Note.fromJson(response_ as core.Map<core.String, core.dynamic>);
}