Class ShopListingApi

ShopListingApi - object-oriented interface

Export

ShopListingApi

Hierarchy

BaseAPI
- ShopListingApi

Index

Constructors

constructor

new ShopListingApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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?: ShopListingCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopListingOutputDTOAPI>>
Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopListingControllerCreate
Parameters
- OptionalshopListingCreateDTO: ShopListingCreateDTO
  ShopListingCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputDTOAPI>>
Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21720

shopListingControllerDelete

shopListingControllerDelete(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopListingControllerDelete
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21734

shopListingControllerGetOne

shopListingControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopListingOutputDTOAPI>>
OperationId: ShopListingControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputDTOAPI>>
Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21748

shopListingControllerImportListings

shopListingControllerImportListings(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopListingControllerImportListings
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21761

shopListingControllerSearch

shopListingControllerSearch(
shopListingSearchInputDTO?: ShopListingSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopListingOutputArrayDTOAPI>>
OperationId: ShopListingControllerSearch
Parameters
- OptionalshopListingSearchInputDTO: ShopListingSearchInputDTO
  ShopListingSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputArrayDTOAPI>>
Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21775

shopListingControllerUpdate

shopListingControllerUpdate(
    id: string,
    shopListingUpdateDTO?: ShopListingUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopListingOutputDTOAPI>>
Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopListingControllerUpdate
Parameters
- id: string
- OptionalshopListingUpdateDTO: ShopListingUpdateDTO
  ShopListingUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopListingOutputDTOAPI>>
Throws
Memberof
ShopListingApi
- Defined in packages/lib-apiclient/src/generated/api.ts:21793

Class ShopListingApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShopListingApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

shopListingControllerCreate

Parameters

Returns Promise<AxiosResponse<ShopListingOutputDTOAPI>>

Throws

Memberof

shopListingControllerDelete

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

shopListingControllerGetOne

Parameters

Returns Promise<AxiosResponse<ShopListingOutputDTOAPI>>

Throws

Memberof

shopListingControllerImportListings

Parameters

Returns Promise<AxiosResponse<APIOutput>>

Throws

Memberof

shopListingControllerSearch

Parameters

Returns Promise<AxiosResponse<ShopListingOutputArrayDTOAPI>>

Throws

Memberof

shopListingControllerUpdate

Parameters

Returns Promise<AxiosResponse<ShopListingOutputDTOAPI>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration