Function ShopCategoryApiFactory

Returns {
    shopCategoryControllerBulkAssign(
        shopCategoryBulkAssignDTO?: ShopCategoryBulkAssignDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    shopCategoryControllerCreate(
        shopCategoryCreateDTO?: ShopCategoryCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>;
    shopCategoryControllerGetAll(
        gameServerId?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputArrayDTOAPI>;
    shopCategoryControllerGetOne(
        id: string,
        gameServerId?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>;
    shopCategoryControllerMove(
        id: string,
        shopCategoryMoveDTO?: ShopCategoryMoveDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>;
    shopCategoryControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    shopCategoryControllerSearch(
        shopCategorySearchInputDTO?: ShopCategorySearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputArrayDTOAPI>;
    shopCategoryControllerUpdate(
        id: string,
        shopCategoryUpdateDTO?: ShopCategoryUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>;
}

• shopCategoryControllerBulkAssign: function

  • shopCategoryControllerBulkAssign(
        shopCategoryBulkAssignDTO?: ShopCategoryBulkAssignDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    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 AxiosPromise<void>

    Throws

• shopCategoryControllerCreate: function

  • shopCategoryControllerCreate(
        shopCategoryCreateDTO?: ShopCategoryCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>

    Create a new shop category Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: ShopCategoryControllerCreate

    Parameters

    • OptionalshopCategoryCreateDTO: ShopCategoryCreateDTO

      ShopCategoryCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopCategoryOutputDTOAPI>

    Throws

• shopCategoryControllerGetAll: function

  • shopCategoryControllerGetAll(
        gameServerId?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputArrayDTOAPI>

    Get all shop categories
    OperationId: ShopCategoryControllerGetAll

    Parameters

    • OptionalgameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopCategoryOutputArrayDTOAPI>

    Throws

• shopCategoryControllerGetOne: function

  • shopCategoryControllerGetOne(
        id: string,
        gameServerId?: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>

    Get a shop category by id
    OperationId: ShopCategoryControllerGetOne

    Parameters

    • id: string
    • OptionalgameServerId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopCategoryOutputDTOAPI>

    Throws

• shopCategoryControllerMove: function

  • shopCategoryControllerMove(
        id: string,
        shopCategoryMoveDTO?: ShopCategoryMoveDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>

    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 AxiosPromise<ShopCategoryOutputDTOAPI>

    Throws

• shopCategoryControllerRemove: function

  • shopCategoryControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Delete a shop category Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: ShopCategoryControllerRemove

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• shopCategoryControllerSearch: function

  • shopCategoryControllerSearch(
        shopCategorySearchInputDTO?: ShopCategorySearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputArrayDTOAPI>

    Search shop categories
    OperationId: ShopCategoryControllerSearch

    Parameters

    • OptionalshopCategorySearchInputDTO: ShopCategorySearchInputDTO

      ShopCategorySearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopCategoryOutputArrayDTOAPI>

    Throws

• shopCategoryControllerUpdate: function

  • shopCategoryControllerUpdate(
        id: string,
        shopCategoryUpdateDTO?: ShopCategoryUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopCategoryOutputDTOAPI>

    Update a shop category Required permissions: MANAGE_SHOP_LISTINGS
    OperationId: ShopCategoryControllerUpdate

    Parameters

    • id: string
    • OptionalshopCategoryUpdateDTO: ShopCategoryUpdateDTO

      ShopCategoryUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopCategoryOutputDTOAPI>

    Throws