Skip to content

Module: client/apis/CatalogAPI

Table of contents

Classes

Type aliases

Type aliases

FavoriteAsset

Ƭ FavoriteAsset: unknown

Defined in: client/apis/CatalogAPI.ts:111

FavoriteAssetOptions

Ƭ FavoriteAssetOptions: object

Type declaration:

Name Type
assetId number
userId number

Defined in: client/apis/CatalogAPI.ts:107

FavoriteBundle

Ƭ FavoriteBundle: unknown

Defined in: client/apis/CatalogAPI.ts:130

FavoriteBundleOptions

Ƭ FavoriteBundleOptions: object

Type declaration:

Name Type
bundleId number
userId number

Defined in: client/apis/CatalogAPI.ts:126

GetAppStoreExclusiveBundles

Ƭ GetAppStoreExclusiveBundles: object

Type declaration:

Name Type
data ProductDetails[]

Defined in: client/apis/CatalogAPI.ts:82

GetAppStoreExclusiveBundlesOptions

Ƭ GetAppStoreExclusiveBundlesOptions: object

Type declaration:

Name Type
appStoreType iOS | GooglePlay | Xbox | Amazon

Defined in: client/apis/CatalogAPI.ts:79

GetAssetBundles

Ƭ GetAssetBundles: object

Type declaration:

Name Type
data { bundleType: string ; creator: { id: number ; name: string ; type: string } ; creatorType: number ; description: string ; id: number ; items: { id: number ; name: string ; owned: boolean ; type: string }[] ; name: string ; product: ProductDetails }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/CatalogAPI.ts:22

GetAssetBundlesOptions

Ƭ GetAssetBundlesOptions: object

Type declaration:

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

Defined in: client/apis/CatalogAPI.ts:16

GetAssetFavoriteCount

Ƭ GetAssetFavoriteCount: number

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

GetAssetFavoriteCountOptions

Ƭ GetAssetFavoriteCountOptions: object

Type declaration:

Name Type
assetId number

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

GetAssetToCategory

Ƭ GetAssetToCategory: Record<string, number>

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

GetAssetToSubCategory

Ƭ GetAssetToSubCategory: GetAssetToCategory

Defined in: client/apis/CatalogAPI.ts:76

GetBundleDetails

Ƭ GetBundleDetails: GetAssetBundles[data][0]

Defined in: client/apis/CatalogAPI.ts:48

GetBundleDetailsOptions

Ƭ GetBundleDetailsOptions: object

Type declaration:

Name Type
bundleId number

Defined in: client/apis/CatalogAPI.ts:45

GetBundleFavoriteCount

Ƭ GetBundleFavoriteCount: number

Defined in: client/apis/CatalogAPI.ts:92

GetBundleFavoriteCountOptions

Ƭ GetBundleFavoriteCountOptions: object

Type declaration:

Name Type
bundleId number

Defined in: client/apis/CatalogAPI.ts:89

GetBundleRecommendationsByBundleId

Ƭ GetBundleRecommendationsByBundleId: object

Type declaration:

Name Type
data GetAssetBundles[data]

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

GetBundleRecommendationsByBundleIdOptions

Ƭ GetBundleRecommendationsByBundleIdOptions: object

Type declaration:

Name Type
bundleId number
numItems? number

Defined in: client/apis/CatalogAPI.ts:49

GetCategories

Ƭ GetCategories: GetAssetToCategory

Defined in: client/apis/CatalogAPI.ts:77

GetMultiBundleDetails

Ƭ GetMultiBundleDetails: GetAssetBundles[data]

Defined in: client/apis/CatalogAPI.ts:59

GetMultiBundleDetailsOptions

Ƭ GetMultiBundleDetailsOptions: object

Type declaration:

Name Type
bundleIds number[]

Defined in: client/apis/CatalogAPI.ts:56

GetSelfFavoriteBundle

Ƭ GetSelfFavoriteBundle: object

Type declaration:

Name Type
bundleId number
created string
userId number

Defined in: client/apis/CatalogAPI.ts:121

GetSelfFavoriteBundleOptions

Ƭ GetSelfFavoriteBundleOptions: object

Type declaration:

Name Type
bundleId number
userId number

Defined in: client/apis/CatalogAPI.ts:117

GetSubCategories

Ƭ GetSubCategories: GetAssetToCategory

Defined in: client/apis/CatalogAPI.ts:78

GetUserBundles

Ƭ GetUserBundles: GetAssetBundles

Defined in: client/apis/CatalogAPI.ts:66

GetUserBundlesByType

Ƭ GetUserBundlesByType: GetUserBundles

Defined in: client/apis/CatalogAPI.ts:70

GetUserBundlesByTypeOptions

Ƭ GetUserBundlesByTypeOptions: GetUserBundlesOptions & { bundleType: BodyParts | AvatarAnimations | string }

Defined in: client/apis/CatalogAPI.ts:67

GetUserBundlesOptions

Ƭ GetUserBundlesOptions: object

Type declaration:

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

Defined in: client/apis/CatalogAPI.ts:60

GetUserFavoriteAsset

Ƭ GetUserFavoriteAsset: object

Type declaration:

Name Type
assetId number
created string
userId number

Defined in: client/apis/CatalogAPI.ts:102

GetUserFavoriteAssetOptions

Ƭ GetUserFavoriteAssetOptions: object

Type declaration:

Name Type
assetId number
userId number

Defined in: client/apis/CatalogAPI.ts:98

ProductDetails

Ƭ ProductDetails: object

Type declaration:

Name Type
id number
isForSale boolean
isPublicDomain boolean
premiumPricing object
premiumPricing.premiumDiscountPercentage number
premiumPricing.premiumPriceInRobux number
priceInRobux number
type string

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

RemoveFavoriteBundle

Ƭ RemoveFavoriteBundle: unknown

Defined in: client/apis/CatalogAPI.ts:116

RemoveFavoriteBundleOptions

Ƭ RemoveFavoriteBundleOptions: object

Type declaration:

Name Type
bundleId number
userId number

Defined in: client/apis/CatalogAPI.ts:112

RemoveSelfAssetFavorite

Ƭ RemoveSelfAssetFavorite: unknown

Defined in: client/apis/CatalogAPI.ts:97

RemoveSelfAssetFavoriteOptions

Ƭ RemoveSelfAssetFavoriteOptions: object

Type declaration:

Name Type
assetId number
userId number

Defined in: client/apis/CatalogAPI.ts:93

UnpackBundle

Ƭ UnpackBundle: unknown

Defined in: client/apis/CatalogAPI.ts:74

UnpackBundleOptions

Ƭ UnpackBundleOptions: object

Type declaration:

Name Type
bundleId number

Defined in: client/apis/CatalogAPI.ts:71