Class ShopListingApi

ShopListingApi - object-oriented interface

Export

ShopListingApi

Hierarchy

BaseAPI
- ShopListingApi

Index

Constructors

constructor

new ShopListingApi(configuration?, basePath?, axios?): ShopListingApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ShopListingApi
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: undefined | Configuration

Methods

shopListingControllerCreate

shopListingControllerCreate(shopListingCreateDTO?, options?): Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>
Required permissions: MANAGE_SHOP_LISTINGS
Parameters
- OptionalshopListingCreateDTO: ShopListingCreateDTO
  ShopListingCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20296

shopListingControllerDelete

shopListingControllerDelete(id, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_SHOP_LISTINGS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Delete

Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20310

shopListingControllerGetOne

shopListingControllerGetOne(id, options?): Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20324

shopListingControllerSearch

shopListingControllerSearch(shopListingSearchInputDTO?, options?): Promise<AxiosResponse<ShopListingOutputArrayDTOAPI, any>>
Parameters
- OptionalshopListingSearchInputDTO: ShopListingSearchInputDTO
  ShopListingSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20338

shopListingControllerUpdate

shopListingControllerUpdate(id, shopListingUpdateDTO?, options?): Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>
Required permissions: MANAGE_SHOP_LISTINGS
Parameters
- id: string
- OptionalshopListingUpdateDTO: ShopListingUpdateDTO
  ShopListingUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:20356

Class ShopListingApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShopListingApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

shopListingControllerCreate

Parameters

Returns Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>

Summary

Throws

Memberof

shopListingControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

shopListingControllerGetOne

Parameters

Returns Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>

Summary

Throws

Memberof

shopListingControllerSearch

Parameters

Returns Promise<AxiosResponse<ShopListingOutputArrayDTOAPI, any>>

Summary

Throws

Memberof

shopListingControllerUpdate

Parameters

Returns Promise<AxiosResponse<ShopListingOutputDTOAPI, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration