activate method
Activates an existing client.
The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
request
- The metadata request object.
Request parameters:
name
- Required. Format:
buyers/{buyerAccountId}/clients/{clientAccountId}
Value must have pattern ^buyers/\[^/\]+/clients/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Client.
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<Client> activate(
ActivateClientRequest 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') + ':activate';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Client.fromJson(response_ as core.Map<core.String, core.dynamic>);
}