InventoryApi
Import
Import
Constructors
Constructor
-
Parameters
-
Optional configuration: Configuration
-
basePath: string = ...
-
axios: AxiosInstance = ...
Returns InventoryApi
-
Methods
Add Inventory Item
-
Parameters
-
requestParameters: InventoryApiAddInventoryItemRequest
Request parameters.
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<InventoryResponse, any>>
-
Delete Inventory Item
-
Delete a player's inventory item.
Parameters
-
requestParameters: InventoryApiDeleteInventoryItemRequest
Request parameters.
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>
-
Get Player Inventory
-
Get a list of inventory for a player. Results ordered by ascending
playersInventoryItemId
.playersIventoryItemIds
andinventoryItemIds
filters are optional, if not given all items will be returned. If both are given an item must match both to be returned.Parameters
-
requestParameters: InventoryApiGetPlayerInventoryRequest
Request parameters.
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<PlayerInventoryResponse, any>>
-
Update Inventory Item
-
Update a player's inventory item.
Parameters
-
requestParameters: InventoryApiUpdateInventoryItemRequest
Request parameters.
-
Optional options: RawAxiosRequestConfig<any>
Returns Promise<AxiosResponse<InventoryResponse, any>>
-
Add an item to a player's inventory.
Add inventory item
{RequiredError}
InventoryApi