Class: default

client/apis/CatalogAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• favoriteAsset
• favoriteBundle
• getAppStoreExclusiveBundles
• getAssetBundles
• getAssetFavoriteCount
• getAssetToCategory
• getAssetToSubCategory
• getBundleDetails
• getBundleFavoriteCount
• getBundleRecommendationsByBundleId
• getCategories
• getMultiBundleDetails
• getSubCategories
• getUserBundles
• getUserBundlesByType
• getUserFavoriteAsset
• getUserFavoriteBundle
• removeAssetFavorite
• removeBundleFavorite
• request
• unpackBundle

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

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

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

favoriteAsset

▸ favoriteAsset(options: FavoriteAssetOptions): Promise<unknown>

Parameters:

Name	Type
options	FavoriteAssetOptions

Returns: Promise<unknown>

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

---

favoriteBundle

▸ favoriteBundle(options: FavoriteBundleOptions): Promise<unknown>

Parameters:

Name	Type
options	FavoriteBundleOptions

Returns: Promise<unknown>

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

---

getAppStoreExclusiveBundles

▸ getAppStoreExclusiveBundles(options: GetAppStoreExclusiveBundlesOptions): Promise<GetAppStoreExclusiveBundles>

Parameters:

Name	Type
options	GetAppStoreExclusiveBundlesOptions

Returns: Promise<GetAppStoreExclusiveBundles>

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

---

getAssetBundles

▸ getAssetBundles(options: GetAssetBundlesOptions): Promise<GetAssetBundles>

Parameters:

Name	Type
options	GetAssetBundlesOptions

Returns: Promise<GetAssetBundles>

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

---

getAssetFavoriteCount

▸ getAssetFavoriteCount(options: GetAssetFavoriteCountOptions): Promise<number>

Parameters:

Name	Type
options	GetAssetFavoriteCountOptions

Returns: Promise<number>

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

---

getAssetToCategory

▸ getAssetToCategory(): Promise<Record<string, number>>

Returns: Promise<Record<string, number>>

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

---

getAssetToSubCategory

▸ getAssetToSubCategory(): Promise<Record<string, number>>

Returns: Promise<Record<string, number>>

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

---

getBundleDetails

▸ getBundleDetails(options: GetBundleDetailsOptions): Promise<{ 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 }>

Parameters:

Name	Type
options	GetBundleDetailsOptions

Returns: Promise<{ 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 }>

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

---

getBundleFavoriteCount

▸ getBundleFavoriteCount(options: GetBundleFavoriteCountOptions): Promise<number>

Parameters:

Name	Type
options	GetBundleFavoriteCountOptions

Returns: Promise<number>

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

---

getBundleRecommendationsByBundleId

▸ getBundleRecommendationsByBundleId(options: GetBundleRecommendationsByBundleIdOptions): Promise<GetBundleRecommendationsByBundleId>

Parameters:

Name	Type
options	GetBundleRecommendationsByBundleIdOptions

Returns: Promise<GetBundleRecommendationsByBundleId>

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

---

getCategories

▸ getCategories(): Promise<Record<string, number>>

Returns: Promise<Record<string, number>>

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

---

getMultiBundleDetails

▸ getMultiBundleDetails(options: GetMultiBundleDetailsOptions): Promise<{ 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 }[]>

Parameters:

Name	Type
options	GetMultiBundleDetailsOptions

Returns: Promise<{ 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 }[]>

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

---

getSubCategories

▸ getSubCategories(): Promise<Record<string, number>>

Returns: Promise<Record<string, number>>

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

---

getUserBundles

▸ getUserBundles(options: GetUserBundlesOptions): Promise<GetAssetBundles>

Parameters:

Name	Type
options	GetUserBundlesOptions

Returns: Promise<GetAssetBundles>

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

---

getUserBundlesByType

▸ getUserBundlesByType(options: GetUserBundlesByTypeOptions): Promise<GetAssetBundles>

Parameters:

Name	Type
options	GetUserBundlesByTypeOptions

Returns: Promise<GetAssetBundles>

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

---

getUserFavoriteAsset

▸ getUserFavoriteAsset(options: GetUserFavoriteAssetOptions): Promise<GetUserFavoriteAsset>

Parameters:

Name	Type
options	GetUserFavoriteAssetOptions

Returns: Promise<GetUserFavoriteAsset>

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

---

getUserFavoriteBundle

▸ getUserFavoriteBundle(options: GetSelfFavoriteBundleOptions): Promise<GetSelfFavoriteBundle>

Parameters:

Name	Type
options	GetSelfFavoriteBundleOptions

Returns: Promise<GetSelfFavoriteBundle>

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

---

removeAssetFavorite

▸ removeAssetFavorite(options: RemoveSelfAssetFavoriteOptions): Promise<unknown>

Parameters:

Name	Type
options	RemoveSelfAssetFavoriteOptions

Returns: Promise<unknown>

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

---

removeBundleFavorite

▸ removeBundleFavorite(options: RemoveFavoriteBundleOptions): Promise<unknown>

Parameters:

Name	Type
options	RemoveFavoriteBundleOptions

Returns: Promise<unknown>

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

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

unpackBundle

▸ unpackBundle(options: UnpackBundleOptions): Promise<unknown>

Parameters:

Name	Type
options	UnpackBundleOptions

Returns: Promise<unknown>

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