listSubaccounts method

Future<ListSubAccountsResponse> listSubaccounts(String provider, { int? pageSize, String? pageToken, String? $fields, })

List all sub-accounts for a given advanced account.

This is a convenience wrapper for the more powerful accounts.list method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

Request parameters:

provider - Required. The aggregation service provider. Format: accounts/{accountId} Value must have pattern ^accounts/\[^/\]+$.

pageSize - Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.

pageToken - Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the accounts.list request must match the call that provided the page token.

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

Completes with a ListSubAccountsResponse.

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<ListSubAccountsResponse> listSubaccounts(
  core.String provider, {
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'accounts/v1/' + core.Uri.encodeFull('$provider') + ':listSubaccounts';

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