pause method

Future<FinalizedDeal> pause(
  1. PauseFinalizedDealRequest request,
  2. String name, {
  3. String? $fields,
})

Pauses serving of the given finalized deal.

This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals.

request - The metadata request object.

Request parameters:

name - Required. Format: buyers/{accountId}/finalizedDeals/{dealId} Value must have pattern ^buyers/\[^/\]+/finalizedDeals/\[^/\]+$.

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

Completes with a FinalizedDeal.

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<FinalizedDeal> pause(
  PauseFinalizedDealRequest request,
  core.String name, {
  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_ = 'v1/' + core.Uri.encodeFull('$name') + ':pause';

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