Takaro - v0.6.0
    Preparing search index...

    Function ShopActionApiFp

    • ShopActionApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          shopActionControllerCreate(
              shopActionCreateDTO?: ShopActionCreateDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopActionOutputDTOAPI>,
          >;
          shopActionControllerGetAvailable(
              gameServerId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopActionOutputArrayDTOAPI>,
          >;
          shopActionControllerGetExecutions(
              id: string,
              success?: any,
              eventSearchInputDTO?: EventSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<EventOutputArrayDTOAPI>,
          >;
          shopActionControllerGetOne(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopActionOutputDTOAPI>,
          >;
          shopActionControllerRemove(
              id: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
          >;
          shopActionControllerSearch(
              shopActionSearchInputDTO?: ShopActionSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopActionOutputArrayDTOAPI>,
          >;
          shopActionControllerUpdate(
              id: string,
              shopActionUpdateDTO?: ShopActionUpdateDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ShopActionOutputDTOAPI>,
          >;
      }

      • shopActionControllerCreate: function
        • Required permissions: MANAGE_MODULES
          OperationId: ShopActionControllerCreate

          Parameters

          • OptionalshopActionCreateDTO: ShopActionCreateDTO

            ShopActionCreateDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • shopActionControllerGetAvailable: function
        • Get available shop actions for a game server (from installed modules) Required permissions: READ_MODULES
          OperationId: ShopActionControllerGetAvailable

          Parameters

          • gameServerId: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • shopActionControllerGetExecutions: function
        • Required permissions: READ_MODULES
          OperationId: ShopActionControllerGetExecutions

          Parameters

          • id: string
          • Optionalsuccess: any
          • OptionaleventSearchInputDTO: EventSearchInputDTO

            EventSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • shopActionControllerGetOne: function
        • Required permissions: READ_MODULES
          OperationId: ShopActionControllerGetOne

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • shopActionControllerRemove: function
        • Required permissions: MANAGE_MODULES
          OperationId: ShopActionControllerRemove

          Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • shopActionControllerSearch: function
      • shopActionControllerUpdate: function
        • Required permissions: MANAGE_MODULES
          OperationId: ShopActionControllerUpdate

          Parameters

          • id: string
          • OptionalshopActionUpdateDTO: ShopActionUpdateDTO

            ShopActionUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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