list method

Future<AccountstatusesListResponse> list(String merchantId, { List<String>? destinations, int? maxResults, String? name, String? pageToken, String? $fields, })

Lists the statuses of the sub-accounts in your Merchant Center account.

Request parameters:

merchantId - The ID of the managing account. This must be a multi-client account.

destinations - If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

maxResults - The maximum number of account statuses to return in the response, used for paging.

name - If set, only the accounts with the given name (case sensitive) will be returned.

pageToken - The token returned by the previous request.

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

Completes with a AccountstatusesListResponse.

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

  final url_ = commons.escapeVariable('$merchantId') + '/accountstatuses';

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