Class Inventory

Inventory

The Inventory class exposes specialized methods to help
developers to access the inventory (products, items etc).

Kind: global class
Category: Operations

• Inventory
  • new Inventory(client)
  • .getParametersByProduct(id) ⇒ Array
  • .getAssetParametersForFulfillmentByProduct(id) ⇒ Array
  • .getProductTemplates(id) ⇒ Array
  • .getProductAssetTemplates(id) ⇒ Array
  • .getProductActionLink(id, actionId, assetId) ⇒ Array
  • .searchProductParameters(productId, query) ⇒ Array

new Inventory(client)

Creates an instance of the Inventory class.

Returns: Inventory – An instance of the Inventory class.

Param	Type	Description
client	ConnectClient	An instance of the ConnectClient class.

inventory.getParametersByProduct(id) ⇒ Array

Retrieves the list of parameters configured for the product.

Kind: instance method of Inventory
Returns: Array – An array with the Parameter objects.

Param	Type	Description
id	string	The unique product identifier for which retrieve the parameters.

inventory.getAssetParametersForFulfillmentByProduct(id) ⇒ Array

Retrieves the list of parameters of scope asset and phase fulfillment configured for
the product.

Kind: instance method of Inventory
Returns: Array – An array with the Parameter objects.

Param	Type	Description
id	string	The unique product identifier for which retrieve the parameters.

inventory.getProductTemplates(id) ⇒ Array

Returns the list of templates configured for a product.

Kind: instance method of Inventory
Returns: Array – An array of Template objects.

Param	Type	Description
id	string	The unique identifier of the product.

inventory.getProductAssetTemplates(id) ⇒ Array

Returns the list of templates configured for a product with scope "asset".

Kind: instance method of Inventory
Returns: Array – An array of Template objects.

Param	Type	Description
id	string	The unique identifier of the product.

inventory.getProductActionLink(id, actionId, assetId) ⇒ Array

Returns the action link for a product action.

Kind: instance method of Inventory
Returns: Array – An array of Template objects.

Param	Type	Description
id	string	The unique identifier of the product.
actionId	string	The unique product action identifier.
assetId	string	The unique asset identifier.

inventory.searchProductParameters(productId, query) ⇒ Array

Search the parameters configured for a product.

Kind: instance method of Inventory
Returns: Array – An array with the Parameter objects.

Param	Type	Description
productId	string	The id of the product for which search parameters.
query	object	The filter query.