Class: default
client/apis/InventoryAPI.default
Hierarchy
↳ default
Table of contents
Constructors
Properties
Methods
- getAssetOwners
- getPackageAssets
- getUserCollectibles
- getUserInventory
- getUserInventoryByAssetTypeId
- getUserItemsByTypeAndTargetId
- request
Constructors
constructor
+ new default(client
: default): default
Parameters:
Name | Type |
---|---|
client |
default |
Returns: default
Inherited from: default
Defined in: client/apis/InventoryAPI.ts:107
Properties
client
• client: default
Inherited from: default.client
Defined in: client/apis/BaseAPI.ts:25
options
• options: BaseAPIOptions
Inherited from: default.options
Defined in: client/apis/BaseAPI.ts:26
Methods
getAssetOwners
▸ getAssetOwners(options
: GetAssetOwnersOptions): Promise<GetAssetOwners>
Parameters:
Name | Type |
---|---|
options |
GetAssetOwnersOptions |
Returns: Promise<GetAssetOwners>
Defined in: client/apis/InventoryAPI.ts:149
getPackageAssets
▸ getPackageAssets(options
: GetPackageAssetsOptions): Promise<GetPackageAssets>
Parameters:
Name | Type |
---|---|
options |
GetPackageAssetsOptions |
Returns: Promise<GetPackageAssets>
Defined in: client/apis/InventoryAPI.ts:115
getUserCollectibles
▸ getUserCollectibles(options
: GetUserCollectiblesOptions): Promise<GetUserCollectibles>
Parameters:
Name | Type |
---|---|
options |
GetUserCollectiblesOptions |
Returns: Promise<GetUserCollectibles>
Defined in: client/apis/InventoryAPI.ts:126
getUserInventory
▸ getUserInventory(options
: GetUserInventoryOptions): Promise<GetUserInventory>
Parameters:
Name | Type |
---|---|
options |
GetUserInventoryOptions |
Returns: Promise<GetUserInventory>
Defined in: client/apis/InventoryAPI.ts:161
getUserInventoryByAssetTypeId
▸ getUserInventoryByAssetTypeId(options
: GetUserInventoryByAssetTypeIdOptions): Promise<GetUserInventoryByAssetTypeId>
Parameters:
Name | Type |
---|---|
options |
GetUserInventoryByAssetTypeIdOptions |
Returns: Promise<GetUserInventoryByAssetTypeId>
Defined in: client/apis/InventoryAPI.ts:173
getUserItemsByTypeAndTargetId
▸ getUserItemsByTypeAndTargetId(options
: GetUserItemsByTypeAndTargetIdOptions): Promise<GetUserItemsByTypeAndTargetId>
Parameters:
Name | Type |
---|---|
options |
GetUserItemsByTypeAndTargetIdOptions |
Returns: Promise<GetUserItemsByTypeAndTargetId>
Defined in: client/apis/InventoryAPI.ts:138
request
▸ request(options
: BaseAPIRequestOptions): Promise<RESTResponseDataType>
Parameters:
Name | Type |
---|---|
options |
BaseAPIRequestOptions |
Returns: Promise<RESTResponseDataType>
Inherited from: default
Defined in: client/apis/BaseAPI.ts:33