list method

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

Lists proposals.

A filter expression using Cloud API list filtering syntax may be specified to filter the results.

Request parameters:

parent - Required. Parent that owns the collection of proposals Format: buyers/{accountId} Value must have pattern ^buyers/\[^/\]+$.

filter - Optional query string using the Cloud API list filtering syntax Supported columns for filtering are: * displayName * dealType * updateTime

  • state

pageSize - Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.

pageToken - The page token as returned from ListProposalsResponse.

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

Completes with a ListProposalsResponse.

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<ListProposalsResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/proposals';

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