close method

Future<UserList> close(
  1. CloseUserListRequest request,
  2. String name, {
  3. String? $fields,
})

Changes the status of a user list to CLOSED.

This prevents new users from being added to the user list.

request - The metadata request object.

Request parameters:

name - Required. The name of the user list to close. See UserList.name Value must have pattern ^buyers/\[^/\]+/userLists/\[^/\]+$.

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

Completes with a UserList.

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<UserList> close(
  CloseUserListRequest 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') + ':close';

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