search method
Future<DynamiteResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders> >
search({})
Search for sharees.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
- search Text to search for. Defaults to
""
. itemType
Limit to specific item types.page
Page offset for searching. Defaults to1
.perPage
Limit amount of search results per page. Defaults to200
.shareType
Limit to specific share types.lookup
If a global lookup should be performed too. Defaults to0
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Sharees search result returned
- 400: Invalid search parameters
See:
- $search_Request for the request send by this method.
- $search_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders>> search({
String? search,
String? itemType,
int? page,
int? perPage,
ShareesapiSearchShareType? shareType,
ShareesapiSearchLookup? lookup,
bool? oCSAPIRequest,
}) async {
final _request = $search_Request(
search: search,
itemType: itemType,
page: page,
perPage: perPage,
shareType: shareType,
lookup: lookup,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $search_Serializer();
final _rawResponse =
await _i1.ResponseConverter<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders>(
_serializer,
).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}