Skip to content

Module: client/apis/InventoryAPI

Table of contents

Classes

Type aliases

Type aliases

GetAssetOwners

Ƭ GetAssetOwners: object

Type declaration:

Name Type
data object
data.created string
data.id number
data.owner object
data.owner.id number
data.owner.name string
data.owner.type User | string
data.serialNumber number
data.updated string
nextPageCursor string
previousPageCursor string

Defined in: client/apis/InventoryAPI.ts:53

GetAssetOwnersOptions

Ƭ GetAssetOwnersOptions: object

Type declaration:

Name Type
assetId number
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

Defined in: client/apis/InventoryAPI.ts:47

GetPackageAssets

Ƭ GetPackageAssets: object

Type declaration:

Name Type
assetIds number[]

Defined in: client/apis/InventoryAPI.ts:8

GetPackageAssetsOptions

Ƭ GetPackageAssetsOptions: object

Type declaration:

Name Type
packageId number

Defined in: client/apis/InventoryAPI.ts:5

GetUserCollectibles

Ƭ GetUserCollectibles: object

Type declaration:

Name Type
data { assetId: number ; assetStock: number ; buildersClubMembershipType: None | string ; name: string ; originalPrice: number ; recentAveragePrice: number ; serialNumber: number ; userAssetId: number }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/InventoryAPI.ts:18

GetUserCollectiblesOptions

Ƭ GetUserCollectiblesOptions: object

Type declaration:

Name Type
assetType? Image | TShirt | Audio | Mesh | Lua | HTML | Text | Hat | Place | Model | Shirt | Pants | Decal | Avatar | Head | Face | Gear | Badge | GroupEmblem | Animation | Arms | Legs | Torso | RightArm | LeftArm | LeftLeg | RightLeg | Package | YouTubeVideo | GamePass | App | Code | Plugin | SolidModel | MeshPart | HairAccessory | NeckAccessory | ShoulderAccessory | FrontAccessory | BackAccessory | WaistAccessory | ClimbAnimation | DeathAnimation | FallAnimation | IdleAnimation | JumpAnimation | RunAnimation | SwimAnimation | WalkAnimation | PoseAnimation | LocalizationTableManifest | LocalizationTableTranslation | EmoteAnimation | Video | TexturePack
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
userId number

Defined in: client/apis/InventoryAPI.ts:11

GetUserInventory

Ƭ GetUserInventory: object

Type declaration:

Name Type
data { assetId: number ; assetType: GetUserCollectiblesOptions[assetType] ; created: string ; name: string }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/InventoryAPI.ts:75

GetUserInventoryByAssetTypeId

Ƭ GetUserInventoryByAssetTypeId: object

Type declaration:

Name Type
data { assetId: number ; assetName: string ; created: string ; owner: { buildersClubMembershipType: None | string ; userId: number ; username: string } ; serialNumber: number ; updated: string ; userAssetId: number }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/InventoryAPI.ts:88

GetUserInventoryByAssetTypeIdOptions

Ƭ GetUserInventoryByAssetTypeIdOptions: Omit<GetUserInventoryOptions, assetTypes> & { assetTypeId: number }

Defined in: client/apis/InventoryAPI.ts:85

GetUserInventoryOptions

Ƭ GetUserInventoryOptions: object

Type declaration:

Name Type
assetTypes GetUserCollectiblesOptions[assetType][]
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
userId number

Defined in: client/apis/InventoryAPI.ts:68

GetUserItemsByTypeAndTargetId

Ƭ GetUserItemsByTypeAndTargetId: object

Type declaration:

Name Type
data { Id: number ; InstanceId: number ; Name: string ; Type: GetUserItemsByTypeAndTargetIdOptions[itemType] }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/InventoryAPI.ts:37

GetUserItemsByTypeAndTargetIdOptions

Ƭ GetUserItemsByTypeAndTargetIdOptions: object

Type declaration:

Name Type
itemTargetId number
itemType Asset | GamePass | Badge | Bundle
userId number

Defined in: client/apis/InventoryAPI.ts:32