Class ShopCategoryApi

ShopCategoryApi - object-oriented interface

Export

ShopCategoryApi

Hierarchy

BaseAPI
- ShopCategoryApi

Index

Constructors

constructor

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

shopCategoryControllerBulkAssign

shopCategoryControllerBulkAssign(
shopCategoryBulkAssignDTO?: ShopCategoryBulkAssignDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Bulk assign categories to multiple shop listings Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopCategoryControllerBulkAssign
Parameters
- OptionalshopCategoryBulkAssignDTO: ShopCategoryBulkAssignDTO
  ShopCategoryBulkAssignDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28193

shopCategoryControllerCreate

shopCategoryControllerCreate(
shopCategoryCreateDTO?: ShopCategoryCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Create a new shop category Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopCategoryControllerCreate
Parameters
- OptionalshopCategoryCreateDTO: ShopCategoryCreateDTO
  ShopCategoryCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28210

shopCategoryControllerGetAll

shopCategoryControllerGetAll(
gameServerId?: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopCategoryOutputArrayDTOAPI, any>>
Get all shop categories
OperationId: ShopCategoryControllerGetAll
Parameters
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopCategoryOutputArrayDTOAPI, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28224

shopCategoryControllerGetOne

shopCategoryControllerGetOne(
    id: string,
    gameServerId?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Get a shop category by id
OperationId: ShopCategoryControllerGetOne
Parameters
- id: string
- OptionalgameServerId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28239

shopCategoryControllerMove

shopCategoryControllerMove(
    id: string,
    shopCategoryMoveDTO?: ShopCategoryMoveDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Move a shop category to a different parent Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopCategoryControllerMove
Parameters
- id: string
- OptionalshopCategoryMoveDTO: ShopCategoryMoveDTO
  ShopCategoryMoveDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28254

shopCategoryControllerRemove

shopCategoryControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Delete a shop category Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopCategoryControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28272

shopCategoryControllerSearch

shopCategoryControllerSearch(
shopCategorySearchInputDTO?: ShopCategorySearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopCategoryOutputArrayDTOAPI, any>>
Search shop categories
OperationId: ShopCategoryControllerSearch
Parameters
- OptionalshopCategorySearchInputDTO: ShopCategorySearchInputDTO
  ShopCategorySearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopCategoryOutputArrayDTOAPI, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28286

shopCategoryControllerUpdate

shopCategoryControllerUpdate(
    id: string,
    shopCategoryUpdateDTO?: ShopCategoryUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Update a shop category Required permissions: MANAGE_SHOP_LISTINGS
OperationId: ShopCategoryControllerUpdate
Parameters
- id: string
- OptionalshopCategoryUpdateDTO: ShopCategoryUpdateDTO
  ShopCategoryUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>
Throws
Memberof
ShopCategoryApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28304

Class ShopCategoryApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShopCategoryApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

shopCategoryControllerBulkAssign

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

shopCategoryControllerCreate

Parameters

Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>

Throws

Memberof

shopCategoryControllerGetAll

Parameters

Returns Promise<AxiosResponse<ShopCategoryOutputArrayDTOAPI, any>>

Throws

Memberof

shopCategoryControllerGetOne

Parameters

Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>

Throws

Memberof

shopCategoryControllerMove

Parameters

Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>

Throws

Memberof

shopCategoryControllerRemove

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

shopCategoryControllerSearch

Parameters

Returns Promise<AxiosResponse<ShopCategoryOutputArrayDTOAPI, any>>

Throws

Memberof

shopCategoryControllerUpdate

Parameters

Returns Promise<AxiosResponse<ShopCategoryOutputDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration