find method
Find the LFP provider candidates in a given country.
Request parameters:
parent
- Required. The name of the parent resource under which the LFP
providers are found. Format:
accounts/{account}/omnichannelSettings/{omnichannel_setting}
.
Value must have pattern ^accounts/\[^/\]+/omnichannelSettings/\[^/\]+$
.
pageSize
- Optional. The maximum number of LfpProvider
resources to
return. The service returns fewer than this value if the number of lfp
providers is less that than the pageSize
. The default value is 50. The
maximum value is 1000; If a value higher than the maximum is specified,
then the pageSize
will default to the maximum.
pageToken
- Optional. A page token, received from a previous
FindLfpProviders
call. Provide the page token to retrieve the subsequent
page. When paginating, all other parameters provided to FindLfpProviders
must match the call that provided the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a FindLfpProvidersResponse.
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<FindLfpProvidersResponse> find(
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') + '/lfpProviders:find';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return FindLfpProvidersResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}