InventoryApi
Import
Import
Constructors
Constructor
-
Parameters
-
Optional configuration: Configuration
-
basePath: string = ...
-
axios: AxiosInstance = ...
Returns InventoryApi
-
Methods
Add Inventory Item
-
Parameters
-
projectId: string
ID of the project
-
playerId: string
ID of the player
-
Optional addInventoryRequest: AddInventoryRequest
-
Optional options: any
Returns Promise<AxiosResponse<InventoryResponse>>
-
Delete Inventory Item
-
Delete a player inventory item.
Parameters
-
projectId: string
-
playerId: string
-
playersInventoryItemId: string
-
Optional inventoryDeleteRequest: InventoryDeleteRequest
-
Optional options: any
Returns Promise<AxiosResponse<void>>
-
Get Player Inventory
-
Get a list of inventory for a player. Results ordered by Player Inventory Item ID ascending. Players inventory item ID and Inventory Item ID filters are optional, if not given all will be returned. If both are given an item must match both to be returned.
Parameters
-
projectId: string
ID of the project
-
playerId: string
ID of the player
-
Optional after: string
-
Optional limit: number
-
Optional playersInventoryItemIds: string[]
-
Optional inventoryItemIds: string[]
-
Optional options: any
Returns Promise<AxiosResponse<PlayerInventoryResponse>>
-
Update Inventory Item
-
Update a players inventory item.
Parameters
-
projectId: string
-
playerId: string
-
playersInventoryItemId: string
-
Optional inventoryRequestUpdate: InventoryRequestUpdate
-
Optional options: any
Returns Promise<AxiosResponse<InventoryResponse>>
-
Add an item to a player's inventory.
Add Inventory Item
{RequiredError}
InventoryApi