Class ProductResource

Updated: March 5, 2020
Contents

Classes

ProductActionResource

The ProductActionResource class provides methods to access the
Action objects for a product.

ProductVersionResourceGenericResource

The ProductVersionResource class provides methods to access the
Version objects for a product.

ProductConfigurationResourceGenericResource

The ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.

ProductResourceGenericResource

The ProductResource class provides methods to access the products
endpoint of the Cloud Blue Connect API.

ProductActionResource

The ProductActionResource class provides methods to access the
Action objects for a product.

Kind: global class
Category: Resources

productActionResource.link(id, assetId) ⇒ object

Returns the ActionLink object for a product and asset.

Kind: instance method of ProductActionResource
Returns: object – The ActionLink object.

ParamTypeDescription
idstringThe unique identifier of the Action.
assetIdstringThe unique identifier of the Asset.

ProductVersionResource ⇐ GenericResource

The ProductVersionResource class provides methods to access the
Version objects for a product.

Kind: global class
Extends: GenericResource
Category: Resources

new ProductVersionResource(client, baseUri)

Creates a new instance of the ProductVersionResource class.

Returns: ProductVersionResource – An instance of the ProductVersionResource class.

ParamTypeDescription
clientConnectClientAn instance of the ConnectClient class.
baseUristringThe base uri for this resource.

productVersionResource.actions(id) ⇒ ProductActionResource

Returns an instance of the ProductActionResource class
to access the Action objects configured for a specific
version of a Product.

Kind: instance method of ProductVersionResource
Returns: ProductActionResource – The instance of the ProductActionResource
class for a product/version.

ParamTypeDescription
idstringThe unique identifier of the Version object for a Product.

ProductConfigurationResource ⇐ GenericResource

The ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.

Kind: global class
Extends: GenericResource
Category: Resources

ProductResource ⇐ GenericResource

The ProductResource class provides methods to access the products
endpoint of the Cloud Blue Connect API.

Kind: global class
Extends: GenericResource
Category: Resources

new ProductResource(client)

Creates a new instance of the ProductResource class.

Returns: ProductResource – An instance of the ProductResource class.

ParamTypeDescription
clientConnectClientAn instance of the ConnectClient class.

productResource.actions(id) ⇒ ProductActionResource

Returns an instance of the ProductActionResource for a Product.

Kind: instance method of ProductResource
Returns: ProductActionResource – An instance of the ProductActionResource
for the product.

ParamTypeDescription
idstringThe unique identifier of the Product.

productResource.versions(id) ⇒ ProductVersionResource

Returns an instance of the ProductVersionResource for a Product.

Kind: instance method of ProductResource
Returns: ProductVersionResource – An instance of the ProductVersionResource
for the product.

ParamTypeDescription
idstringThe unique identifier of the Product.

productResource.configurations(id) ⇒ ProductConfigurationResource

Returns an instance of the ProductConfigurationResource for a ProductConfiguration.

Kind: instance method of ProductResource
Returns: ProductConfigurationResource – An instance of the ProductConfigurationResource
for the product.

ParamTypeDescription
idstringThe unique identifier of the Product.

productResource.getTemplates(id) ⇒ Array

Returns the list of Template objects configured for the Product.

Kind: instance method of ProductResource
Returns: Array – The list of Template objects.

ParamTypeDescription
idstringThe unique identifier of the Product.

productResource.getParameters(id) ⇒ Array

Returns the list of Parameter objects configured for the Product.

Kind: instance method of ProductResource
Returns: Array – The list of Parameter objects.

ParamTypeDescription
idstringThe unique identifier of the Product.

productResource.getItems(id) ⇒ Array

Returns the list of ProductItem objects configured for the Product.

Kind: instance method of ProductResource
Returns: Array – The list of ProductItem objects.

ParamTypeDescription
idstringThe unique identifier of the Product.

productResource.getConnections(id) ⇒ Array

Returns the list of Connection objects configured for the Product.

Kind: instance method of ProductResource
Returns: Array – The list of Connection objects.

ParamTypeDescription
idstringThe unique identifier of the Product.
Is this page helpful?
Translate with Google
Copied to clipboard