Class InventoriesApiWrapper

Hierarchy

BaseApiWrapper<InventoriesApi>
- InventoriesApiWrapper

Index

Constructors

constructor

Properties

Accessors

observers

Methods

Constructors

constructor

new InventoriesApiWrapper(accessToken: string, basePath?: string): InventoriesApiWrapper

Overrides BaseApiWrapper.constructor
- Defined in src/apis/inventoriesApiWrapper.ts:14
Parameters
- accessToken: string
- Optional basePath: string
Returns InventoriesApiWrapper

Properties

Protected Readonly api

api: InventoriesApi

Static type

type: string = "inventories"

Accessors

observers

get observers(): Observer[]

Inherited from BaseApiWrapper.observers
- Defined in src/apis/baseApiWrapper.ts:36
Returns Observer[]

Methods

getAccountCryptoCurrencyInventory

getAccountCryptoCurrencyInventory(req: AccountInventoryListQueries): Promise<InventoryListResponse>

- Defined in src/apis/inventoriesApiWrapper.ts:51
Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.

Parameters
- req: AccountInventoryListQueries
Returns Promise<InventoryListResponse>

getAccountNativeInventory

getAccountNativeInventory(req: GetAccountInventoryRequest): Promise<InventoryResponse>

- Defined in src/apis/inventoriesApiWrapper.ts:65
Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.

Parameters
- req: GetAccountInventoryRequest
Returns Promise<InventoryResponse>

getAccountNftInventory

getAccountNftInventory(req: AccountInventoryListQueries): Promise<InventoryListResponse>

- Defined in src/apis/inventoriesApiWrapper.ts:30
For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Retrieves the NFT assets of an existing account.

Parameters
- req: AccountInventoryListQueries
Returns Promise<InventoryListResponse>

getPlayerCryptoCurrencyInventory

getPlayerCryptoCurrencyInventory(req: PlayerInventoryListQueries): Promise<InventoryListResponse>

- Defined in src/apis/inventoriesApiWrapper.ts:37
Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.

Parameters
- req: PlayerInventoryListQueries
Returns Promise<InventoryListResponse>

getPlayerNativeInventory

getPlayerNativeInventory(req: GetPlayerInventoryRequest): Promise<InventoryResponse>

- Defined in src/apis/inventoriesApiWrapper.ts:58
Retrieves the native assets list of an existing player. Supply the unique player ID from either a player creation request or the player list, and Openfort will return the corresponding player information.

Parameters
- req: GetPlayerInventoryRequest
Returns Promise<InventoryResponse>

getPlayerNftInventory

getPlayerNftInventory(req: PlayerInventoryListQueries): Promise<InventoryListResponse>

- Defined in src/apis/inventoriesApiWrapper.ts:22
For development purposes only. Under higher load scenarios, this endpoint may be rate limited. Get NFTs list of player.

Parameters
- req: PlayerInventoryListQueries
Returns Promise<InventoryListResponse>

subscribe

subscribe(observer: Observer): void

Inherited from BaseApiWrapper.subscribe
- Defined in src/apis/baseApiWrapper.ts:32
Parameters
- observer: Observer
Returns void

Generated using TypeDoc