Class ItemsApi

ItemsApi - object-oriented interface

Export

ItemsApi

Hierarchy

BaseAPI
- ItemsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getItems getItemUserData getResumeItems updateItemUserData

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getItems

getItems(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: ItemsApiGetItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets items based on a query.

Throws
Memberof
ItemsApi
- Defined in generated-client/api/items-api.ts:1740

getItemUserData

getItemUserData(requestParameters, options?): Promise<AxiosResponse<UserItemDataDto, any>>
Parameters
- requestParameters: ItemsApiGetItemUserDataRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto, any>>
Summary
Get Item User Data.

Throws
Memberof
ItemsApi
- Defined in generated-client/api/items-api.ts:1728

getResumeItems

getResumeItems(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: ItemsApiGetResumeItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets items based on a query.

Throws
Memberof
ItemsApi
- Defined in generated-client/api/items-api.ts:1752

updateItemUserData

updateItemUserData(requestParameters, options?): Promise<AxiosResponse<UserItemDataDto, any>>
Parameters
- requestParameters: ItemsApiUpdateItemUserDataRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserItemDataDto, any>>
Summary
Update Item User Data.

Throws
Memberof
ItemsApi
- Defined in generated-client/api/items-api.ts:1764