list method

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

Lists the regions in your Merchant Center account.

Request parameters:

merchantId - Required. The id of the merchant for which to list region definitions.

pageSize - The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

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

Completes with a ListRegionsResponse.

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<ListRegionsResponse> list(
  core.String merchantId, {
  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_ = commons.escapeVariable('$merchantId') + '/regions';

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