Class: default

client/apis/ItemConfigurationAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• createItemTag
• deleteItemTag
• getCreatedAssets
• getItemTagsByItemIds
• getItemTagsMetaData
• getMultiCreatedAssets
• getTagsByTagIds
• request
• searchTags

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/ItemConfigurationAPI.ts:81

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

createItemTag

▸ createItemTag(options: CreateItemTagOptions): Promise<{ id: string ; tag: { localizedDisplayName: string ; name: string ; status: string ; tagId: string } }>

Parameters:

Name	Type
options	CreateItemTagOptions

Returns: Promise<{ id: string ; tag: { localizedDisplayName: string ; name: string ; status: string ; tagId: string } }>

Defined in: client/apis/ItemConfigurationAPI.ts:128

---

deleteItemTag

▸ deleteItemTag(options: DeleteItemTagOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteItemTagOptions

Returns: Promise<unknown>

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

---

getCreatedAssets

▸ getCreatedAssets(options: GetCreatedAssetsOptions): Promise<GetCreatedAssets>

Parameters:

Name	Type
options	GetCreatedAssetsOptions

Returns: Promise<GetCreatedAssets>

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

---

getItemTagsByItemIds

▸ getItemTagsByItemIds(options: GetItemTagsByItemIdsOptions): Promise<GetItemTagsByItemIds>

Parameters:

Name	Type
options	GetItemTagsByItemIdsOptions

Returns: Promise<GetItemTagsByItemIds>

Defined in: client/apis/ItemConfigurationAPI.ts:114

---

getItemTagsMetaData

▸ getItemTagsMetaData(): Promise<GetItemTagsMetaData>

Returns: Promise<GetItemTagsMetaData>

Defined in: client/apis/ItemConfigurationAPI.ts:141

---

getMultiCreatedAssets

▸ getMultiCreatedAssets(options: GetMultiCreatedAssetDetailsOptions): Promise<GetMultiCreatedAssetDetails>

Parameters:

Name	Type
options	GetMultiCreatedAssetDetailsOptions

Returns: Promise<GetMultiCreatedAssetDetails>

Defined in: client/apis/ItemConfigurationAPI.ts:101

---

getTagsByTagIds

▸ getTagsByTagIds(options: GetTagsByTagIdsOptions): Promise<GetTagsByTagIds>

Parameters:

Name	Type
options	GetTagsByTagIdsOptions

Returns: Promise<GetTagsByTagIds>

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

---

request

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

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

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

---

searchTags

▸ searchTags(options: SearchTagsOptions): Promise<GetTagsByTagIds>

Parameters:

Name	Type
options	SearchTagsOptions

Returns: Promise<GetTagsByTagIds>

Defined in: client/apis/ItemConfigurationAPI.ts:178