deactivate method

Future<ClientUser> deactivate(
  1. DeactivateClientUserRequest request,
  2. String name, {
  3. String? $fields,
})

Deactivates an existing client user.

The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.

request - The metadata request object.

Request parameters:

name - Required. Format: buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId} Value must have pattern ^buyers/\[^/\]+/clients/\[^/\]+/users/\[^/\]+$.

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

Completes with a ClientUser.

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<ClientUser> deactivate(
  DeactivateClientUserRequest 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') + ':deactivate';

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