list method

Future<Segments> list({
  1. int? maxResults,
  2. int? startIndex,
  3. String? $fields,
})

Lists segments to which the user has access.

Request parameters:

maxResults - The maximum number of segments to include in this response.

startIndex - An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.

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

Completes with a Segments.

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<Segments> list({
  core.int? maxResults,
  core.int? startIndex,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (maxResults != null) 'max-results': ['${maxResults}'],
    if (startIndex != null) 'start-index': ['${startIndex}'],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'management/segments';

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