pause method

Future<Proposal> pause(
  1. PauseProposalDealsRequest request,
  2. String accountId,
  3. String proposalId, {
  4. String? $fields,
})

Update given deals to pause serving.

This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, please call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

request - The metadata request object.

Request parameters:

accountId - Account ID of the buyer.

proposalId - The proposal_id of the proposal containing the deals.

$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> pause(
  PauseProposalDealsRequest 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') +
      '/finalizedProposals/' +
      commons.escapeVariable('$proposalId') +
      ':pause';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return Proposal.fromJson(_response as core.Map<core.String, core.dynamic>);
}