update method
Update the given proposal at the client known revision number.
If the server revision has advanced since the passed-in
proposal.proposal_revision
, an ABORTED
error message will be returned.
Only the buyer-modifiable fields of the proposal will be updated. Note
that the deals in the proposal will be updated to match the passed-in
copy. If a passed-in deal does not have a deal_id
, the server will
assign a new unique ID and create the deal. If passed-in deal has a
deal_id
, it will be updated to match the passed-in copy. Any existing
deals not present in the passed-in proposal will be deleted. It is an
error to pass in a deal with a deal_id
not present at head.
request
- The metadata request object.
Request parameters:
accountId
- Account ID of the buyer.
proposalId
- The unique ID of the proposal.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Proposal.
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<Proposal> update(
Proposal request,
core.String accountId,
core.String proposalId, {
core.String? $fields,
}) async {
final _body = convert.json.encode(request.toJson());
final _queryParams = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final _url = 'v2beta1/accounts/' +
commons.escapeVariable('$accountId') +
'/proposals/' +
commons.escapeVariable('$proposalId');
final _response = await _requester.request(
_url,
'PUT',
body: _body,
queryParams: _queryParams,
);
return Proposal.fromJson(_response as core.Map<core.String, core.dynamic>);
}