Module: client/apis/ItemConfigurationAPI
Table of contents
Classes
Type aliases
- CreateItemTag
- CreateItemTagOptions
- DeleteItemTag
- DeleteItemTagOptions
- GetCreatedAssets
- GetCreatedAssetsOptions
- GetItemTagsByItemIds
- GetItemTagsByItemIdsOptions
- GetItemTagsMetaData
- GetMultiCreatedAssetDetails
- GetMultiCreatedAssetDetailsOptions
- GetTagsByTagIds
- GetTagsByTagIdsOptions
- SearchTags
- SearchTagsOptions
Type aliases
CreateItemTag
Ƭ CreateItemTag: GetItemTagsByItemIds[data][0][itemTags][0]
Defined in: client/apis/ItemConfigurationAPI.ts:59
CreateItemTagOptions
Ƭ CreateItemTagOptions: object
Type declaration:
| Name | Type |
|---|---|
itemId |
number |
tagId |
string |
Defined in: client/apis/ItemConfigurationAPI.ts:55
DeleteItemTag
Ƭ DeleteItemTag: unknown
Defined in: client/apis/ItemConfigurationAPI.ts:68
DeleteItemTagOptions
Ƭ DeleteItemTagOptions: object
Type declaration:
| Name | Type |
|---|---|
itemTagId |
number |
Defined in: client/apis/ItemConfigurationAPI.ts:65
GetCreatedAssets
Ƭ GetCreatedAssets: object
Type declaration:
| Name | Type |
|---|---|
data |
{ assetId: number ; name: string }[] |
nextPageCursor |
string |
previousPageCursor |
string |
Defined in: client/apis/ItemConfigurationAPI.ts:11
GetCreatedAssetsOptions
Ƭ GetCreatedAssetsOptions: object
Type declaration:
| Name | Type |
|---|---|
assetType |
string |
groupId? |
number |
isArchived? |
boolean |
sortOrder? |
Asc | Desc |
Defined in: client/apis/ItemConfigurationAPI.ts:5
GetItemTagsByItemIds
Ƭ GetItemTagsByItemIds: object
Type declaration:
| Name | Type |
|---|---|
data |
{ id: string ; itemTags: { id: string ; tag: { localizedDisplayName: string ; name: string ; status: Success | string ; tagId: string } }[] }[] |
Defined in: client/apis/ItemConfigurationAPI.ts:41
GetItemTagsByItemIdsOptions
Ƭ GetItemTagsByItemIdsOptions: object
Type declaration:
| Name | Type |
|---|---|
itemIds |
number[] |
Defined in: client/apis/ItemConfigurationAPI.ts:38
GetItemTagsMetaData
Ƭ GetItemTagsMetaData: object
Type declaration:
| Name | Type |
|---|---|
enabledAssetTypes |
string[] |
isItemTagsFeatureEnabled |
boolean |
maximumItemTagsPerItem |
number |
Defined in: client/apis/ItemConfigurationAPI.ts:60
GetMultiCreatedAssetDetails
Ƭ GetMultiCreatedAssetDetails: { assetId: number ; assetType: string ; creatorTargetId: number ; creatorType: string ; description: string ; isArchived: boolean ; name: string ; price: number ; priceConfiguration: { premiumDiscountPercentage: number ; premiumPriceInRobux: number ; priceInRobux: number } ; status: string }[]
Defined in: client/apis/ItemConfigurationAPI.ts:22
GetMultiCreatedAssetDetailsOptions
Ƭ GetMultiCreatedAssetDetailsOptions: object
Type declaration:
| Name | Type |
|---|---|
assetIds |
number[] |
Defined in: client/apis/ItemConfigurationAPI.ts:19
GetTagsByTagIds
Ƭ GetTagsByTagIds: object
Type declaration:
| Name | Type |
|---|---|
data |
Omit<GetItemTagsByItemIds[data][0][itemTags][0], id>[] |
Defined in: client/apis/ItemConfigurationAPI.ts:72
GetTagsByTagIdsOptions
Ƭ GetTagsByTagIdsOptions: object
Type declaration:
| Name | Type |
|---|---|
tagIds |
number[] |
Defined in: client/apis/ItemConfigurationAPI.ts:69
SearchTags
Ƭ SearchTags: GetTagsByTagIds
Defined in: client/apis/ItemConfigurationAPI.ts:79
SearchTagsOptions
Ƭ SearchTagsOptions: object
Type declaration:
| Name | Type |
|---|---|
prefix |
string |
results |
number |
Defined in: client/apis/ItemConfigurationAPI.ts:75