Class ItemApi

ItemApi - object-oriented interface

Export

ItemApi

Hierarchy

BaseAPI
- ItemApi

Index

Constructors

Properties

axios basePath configuration

Methods

itemControllerFindOne itemControllerSearch

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

itemControllerFindOne

itemControllerFindOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ItemOutputDTOAPI, any>>
Required permissions: READ_ITEMS
OperationId: ItemControllerFindOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ItemOutputDTOAPI, any>>
Throws
Memberof
ItemApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22968

itemControllerSearch

itemControllerSearch(
itemSearchInputDTO?: ItemSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ItemOutputArrayDTOAPI, any>>
Search items Required permissions: READ_ITEMS
OperationId: ItemControllerSearch
Parameters
- OptionalitemSearchInputDTO: ItemSearchInputDTO
  ItemSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ItemOutputArrayDTOAPI, any>>
Throws
Memberof
ItemApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22982