patch method

Future<Membership> patch(Membership request, String name, { String? updateMask, bool? useAdminAccess, String? $fields, })

Updates a membership.

For an example, see Update a user's membership in a space. Supports the following types of authentication:

App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access field in the request.

request - The metadata request object.

Request parameters:

name - Identifier. Resource name of the membership, assigned by the server. Format: spaces/{space}/members/{member} Value must have pattern ^spaces/\[^/\]+/members/\[^/\]+$.

updateMask - Required. The field paths to update. Separate multiple values with commas or use * to update all field paths. Currently supported field paths: - role

useAdminAccess - Optional. When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires the chat.admin.memberships OAuth 2.0 scope.

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

Completes with a Membership.

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<Membership> patch(
  Membership request,
  core.String name, {
  core.String? updateMask,
  core.bool? useAdminAccess,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (updateMask != null) 'updateMask': [updateMask],
    if (useAdminAccess != null) 'useAdminAccess': ['${useAdminAccess}'],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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