Takaro - v0.6.0
    Preparing search index...

    Function ShopCategoryApiFp

    • ShopCategoryApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

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

      • shopCategoryControllerBulkAssign: function
        • 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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • shopCategoryControllerCreate: function
        • Create a new shop category Required permissions: MANAGE_SHOP_LISTINGS
          OperationId: ShopCategoryControllerCreate

          Parameters

          • OptionalshopCategoryCreateDTO: ShopCategoryCreateDTO

            ShopCategoryCreateDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopCategoryOutputDTOAPI>,
          >

      • shopCategoryControllerGetAll: function
        • Get all shop categories
          OperationId: ShopCategoryControllerGetAll

          Parameters

          • OptionalgameServerId: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopCategoryOutputArrayDTOAPI>,
          >

      • shopCategoryControllerGetOne: function
        • Get a shop category by id
          OperationId: ShopCategoryControllerGetOne

          Parameters

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

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopCategoryOutputDTOAPI>,
          >

      • shopCategoryControllerMove: function
        • 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<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopCategoryOutputDTOAPI>,
          >

      • shopCategoryControllerRemove: function
        • Delete a shop category Required permissions: MANAGE_SHOP_LISTINGS
          OperationId: ShopCategoryControllerRemove

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • shopCategoryControllerSearch: function
      • shopCategoryControllerUpdate: function
        • 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<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopCategoryOutputDTOAPI>,
          >