Function ShopActionApiFactory

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

• shopActionControllerCreate: function

  • shopActionControllerCreate(
        shopActionCreateDTO?: ShopActionCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopActionOutputDTOAPI>

    Required permissions: MANAGE_MODULES
    OperationId: ShopActionControllerCreate

    Parameters

    • OptionalshopActionCreateDTO: ShopActionCreateDTO

      ShopActionCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopActionOutputDTOAPI>

    Throws

• shopActionControllerGetAvailable: function

  • shopActionControllerGetAvailable(
        gameServerId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopActionOutputArrayDTOAPI>

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

    Throws

• shopActionControllerGetExecutions: function

  • shopActionControllerGetExecutions(
        id: string,
        success?: any,
        eventSearchInputDTO?: EventSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<EventOutputArrayDTOAPI>

    Required permissions: READ_MODULES
    OperationId: ShopActionControllerGetExecutions

    Parameters

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

      EventSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<EventOutputArrayDTOAPI>

    Throws

• shopActionControllerGetOne: function

  • shopActionControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopActionOutputDTOAPI>

    Required permissions: READ_MODULES
    OperationId: ShopActionControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopActionOutputDTOAPI>

    Throws

• shopActionControllerRemove: function

  • shopActionControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_MODULES
    OperationId: ShopActionControllerRemove

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• shopActionControllerSearch: function

  • shopActionControllerSearch(
        shopActionSearchInputDTO?: ShopActionSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopActionOutputArrayDTOAPI>

    Search shop actions Required permissions: READ_MODULES
    OperationId: ShopActionControllerSearch

    Parameters

    • OptionalshopActionSearchInputDTO: ShopActionSearchInputDTO

      ShopActionSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopActionOutputArrayDTOAPI>

    Throws

• shopActionControllerUpdate: function

  • shopActionControllerUpdate(
        id: string,
        shopActionUpdateDTO?: ShopActionUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ShopActionOutputDTOAPI>

    Required permissions: MANAGE_MODULES
    OperationId: ShopActionControllerUpdate

    Parameters

    • id: string
    • OptionalshopActionUpdateDTO: ShopActionUpdateDTO

      ShopActionUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ShopActionOutputDTOAPI>

    Throws