patch method

Future<Member> patch(Member request, String groupKey, String memberKey, { String? $fields, })

Updates the membership properties of a user in the specified group.

This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

request - The metadata request object.

Request parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

memberKey - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

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

Completes with a Member.

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<Member> patch(
  Member request,
  core.String groupKey,
  core.String memberKey, {
  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_ = 'admin/directory/v1/groups/' +
      commons.escapeVariable('$groupKey') +
      '/members/' +
      commons.escapeVariable('$memberKey');

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