Class ShopActionApi

ShopActionApi - object-oriented interface

Export

ShopActionApi

Hierarchy

BaseAPI
- ShopActionApi

Index

Constructors

constructor

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

shopActionControllerCreate

shopActionControllerCreate(
shopActionCreateDTO?: ShopActionCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
OperationId: ShopActionControllerCreate
Parameters
- OptionalshopActionCreateDTO: ShopActionCreateDTO
  ShopActionCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28446

shopActionControllerGetAvailable

shopActionControllerGetAvailable(
gameServerId: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopActionOutputArrayDTOAPI, any>>
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<AxiosResponse<ShopActionOutputArrayDTOAPI, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28460

shopActionControllerGetExecutions

shopActionControllerGetExecutions(
    id: string,
    success?: any,
    eventSearchInputDTO?: EventSearchInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ShopActionControllerGetExecutions
Parameters
- id: string
- Optionalsuccess: any
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28476

shopActionControllerGetOne

shopActionControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>
Required permissions: READ_MODULES
OperationId: ShopActionControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28495

shopActionControllerRemove

shopActionControllerRemove(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_MODULES
OperationId: ShopActionControllerRemove
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28509

shopActionControllerSearch

shopActionControllerSearch(
shopActionSearchInputDTO?: ShopActionSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopActionOutputArrayDTOAPI, any>>
Search shop actions Required permissions: READ_MODULES
OperationId: ShopActionControllerSearch
Parameters
- OptionalshopActionSearchInputDTO: ShopActionSearchInputDTO
  ShopActionSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopActionOutputArrayDTOAPI, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28523

shopActionControllerUpdate

shopActionControllerUpdate(
    id: string,
    shopActionUpdateDTO?: ShopActionUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>
Required permissions: MANAGE_MODULES
OperationId: ShopActionControllerUpdate
Parameters
- id: string
- OptionalshopActionUpdateDTO: ShopActionUpdateDTO
  ShopActionUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>
Throws
Memberof
ShopActionApi
- Defined in packages/lib-apiclient/src/generated/api.ts:28541

Class ShopActionApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShopActionApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

shopActionControllerCreate

Parameters

Returns Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>

Throws

Memberof

shopActionControllerGetAvailable

Parameters

Returns Promise<AxiosResponse<ShopActionOutputArrayDTOAPI, any>>

Throws

Memberof

shopActionControllerGetExecutions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Throws

Memberof

shopActionControllerGetOne

Parameters

Returns Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>

Throws

Memberof

shopActionControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Throws

Memberof

shopActionControllerSearch

Parameters

Returns Promise<AxiosResponse<ShopActionOutputArrayDTOAPI, any>>

Throws

Memberof

shopActionControllerUpdate

Parameters

Returns Promise<AxiosResponse<ShopActionOutputDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration