list method

Future<ListHeldAccountsResponse> list(
  1. String matterId,
  2. String holdId, {
  3. String? $fields,
})

Lists the accounts covered by a hold.

This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the Admin SDK. to list the members of the organizational unit on hold.

Request parameters:

matterId - The matter ID.

holdId - The hold ID.

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

Completes with a ListHeldAccountsResponse.

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<ListHeldAccountsResponse> list(
  core.String matterId,
  core.String holdId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

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

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