search method

Future<DynamiteResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders>> search({
  1. String? search,
  2. String? itemType,
  3. int? page,
  4. int? perPage,
  5. ShareesapiSearchShareType? shareType,
  6. ShareesapiSearchLookup? lookup,
  7. bool? oCSAPIRequest,
})

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 to 1.
  • perPage Limit amount of search results per page. Defaults to 200.
  • shareType Limit to specific share types.
  • lookup If a global lookup should be performed too. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Sharees search result returned
  • 400: Invalid search parameters

See:

  • searchRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<ShareesapiSearchResponseApplicationJson, ShareesapiShareesapiSearchHeaders>> search({
  String? search,
  String? itemType,
  int? page,
  int? perPage,
  ShareesapiSearchShareType? shareType,
  ShareesapiSearchLookup? lookup,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = searchRaw(
    search: search,
    itemType: itemType,
    page: page,
    perPage: perPage,
    shareType: shareType,
    lookup: lookup,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}