addHeldAccounts method

Future<AddHeldAccountsResponse> addHeldAccounts(
  1. AddHeldAccountsRequest request,
  2. String matterId,
  3. String holdId, {
  4. String? $fields,
})

Adds accounts to a hold.

Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.

request - The metadata request object.

Request parameters:

matterId - The matter ID.

holdId - The hold ID.

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

Completes with a AddHeldAccountsResponse.

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<AddHeldAccountsResponse> addHeldAccounts(
  AddHeldAccountsRequest 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>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v1/matters/' +
      commons.escapeVariable('$matterId') +
      '/holds/' +
      commons.escapeVariable('$holdId') +
      ':addHeldAccounts';

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