list method

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

Lists the user's customer accounts.

Request parameters:

pageSize - The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive).

pageToken - A token specifying which result page to return. This field has custom validations in ListCustomersRequestValidator

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

Completes with a CustomerListCustomersResponse.

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<CustomerListCustomersResponse> list({
  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],
  };

  const url_ = 'v1/customers';

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