Class SearchApi

SearchApi - object-oriented interface

Hierarchy

BaseAPI
- SearchApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new SearchApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): SearchApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SearchApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:38

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getSearchHints

getSearchHints(
requestParameters: SearchApiGetSearchHintsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SearchHintResult, any, {}>>
Parameters
- requestParameters: SearchApiGetSearchHintsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SearchHintResult, any, {}>>

Throws
- Defined in generated-client/api/search-api.ts:326