subscribeClients method

Future<AuctionPackage> subscribeClients(SubscribeClientsRequest request, String auctionPackage, { String? $fields, })

Subscribe the specified clients of the buyer to the auction package.

If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.

request - The metadata request object.

Request parameters:

auctionPackage - Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId} Value must have pattern ^buyers/\[^/\]+/auctionPackages/\[^/\]+$.

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

Completes with a AuctionPackage.

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<AuctionPackage> subscribeClients(
  SubscribeClientsRequest request,
  core.String auctionPackage, {
  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('$auctionPackage') + ':subscribeClients';

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