update method

Future<Hold> update(Hold request, String matterId, String holdId, { String? $fields, })

Updates the scope (organizational unit or accounts) and query parameters of a hold.

You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.

request - The metadata request object.

Request parameters:

matterId - The matter ID.

holdId - The ID of the hold.

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

Completes with a Hold.

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<Hold> update(
  Hold request,
  core.String matterId,
  core.String holdId, {
  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/matters/' +
      commons.escapeVariable('$matterId') +
      '/holds/' +
      commons.escapeVariable('$holdId');

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