list method

Future<PostalCodesListResponse> list(
  1. String profileId, {
  2. String? $fields,
})

Retrieves a list of postal codes.

Request parameters:

profileId - User profile ID associated with this request. Value must have pattern ^\[^/\]+$.

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

Completes with a PostalCodesListResponse.

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<PostalCodesListResponse> list(
  core.String profileId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'userprofiles/' + core.Uri.encodeFull('$profileId') + '/postalCodes';

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