list method

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

List all the omnichannel settings for a given merchant.

Request parameters:

parent - Required. The parent, which owns this collection of omnichannel settings. Format: accounts/{account} Value must have pattern ^accounts/\[^/\]+$.

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

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

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

Completes with a ListOmnichannelSettingsResponse.

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<ListOmnichannelSettingsResponse> list(
  core.String parent, {
  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('$parent') +
      '/omnichannelSettings';

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