list method

Future<ListGbpAccountsResponse> list(
  1. String parent, {
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

List the GBP accounts for a given merchant.

Request parameters:

parent - Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account}. Value must have pattern ^accounts/\[^/\]+$.

pageSize - Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

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

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

Completes with a ListGbpAccountsResponse.

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

  final url_ =
      'accounts/v1/' + core.Uri.encodeFull('$parent') + '/gbpAccounts';

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