updateEntitlements method

Future<ReaderEntitlements> updateEntitlements(ReaderEntitlements request, String name, { String? updateMask, String? $fields, })

Updates the reader entitlements for a publication reader.

The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.

request - The metadata request object.

Request parameters:

name - Output only. The resource name of the singleton. Value must have pattern ^publications/\[^/\]+/readers/\[^/\]+/entitlements$.

updateMask - Optional. The list of fields to update. Defaults to all fields.

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

Completes with a ReaderEntitlements.

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

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

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