Class FilterApi

FilterApi - object-oriented interface

Export

FilterApi

Hierarchy (view full)

BaseAPI
- FilterApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getFilters

getFilters(collectionId, tagsSort?, search?, options?): Promise<AxiosResponse<GetFiltersResponse, any>>
Parameters
- collectionId: number
- OptionaltagsSort: generated.GetFiltersTagsSortEnum
- Optionalsearch: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetFiltersResponse, any>>
Throws
Memberof
FilterApi
- Defined in src/generated/api.ts:5630