Javascript SDK Community Connect SDK and Tools Javascript SDK

Class ProductActionResource

Updated: March 10, 2021

Contents

Classes

ProductActionResource: The ProductActionResource class provides methods to access the
Action objects for a product.
ProductVersionResource ⇐ GenericResource: The ProductVersionResource class provides methods to access the
Version objects for a product.
ProductConfigurationResource ⇐ GenericResource: The ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.
ProductParameterResource ⇐ GenericResource: The ProductParameterResource class provides methods to access the
Productpameter objects for a product.
ProductConnectionsResource ⇐ GenericResource: The ProductConnectionsResource class provides methods to access the
ProductConnection objects for a product.
ProductUsageRuleResource ⇐ GenericResource: The ProductUsageRulesResource class provides methods to access the
ProductUsageRule objects for a product.
ProductResource ⇐ GenericResource: 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.

Param	Type	Description
id	`string`	The unique identifier of the Action.
assetId	`string`	The 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

ProductVersionResource ⇐ GenericResource
- new ProductVersionResource(client, baseUri)
- .actions(id) ⇒ ProductActionResource

new ProductVersionResource(client, baseUri)

Creates a new instance of the ProductVersionResource class.

Returns: ProductVersionResource – An instance of the ProductVersionResource class.

Param	Type	Description
client	`ConnectClient`	An instance of the ConnectClient class.
baseUri	`string`	The 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.

Param	Type	Description
id	`string`	The 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

ProductParameterResource ⇐ `GenericResource`

The ProductParameterResource class provides methods to access the
Productpameter objects for a product.

Kind: global class
Extends: GenericResource
Category: Resources

ProductConnectionsResource ⇐ `GenericResource`

The ProductConnectionsResource class provides methods to access the
ProductConnection objects for a product.

Kind: global class
Extends: GenericResource
Category: Resources

ProductUsageRuleResource ⇐ `GenericResource`

The ProductUsageRulesResource class provides methods to access the
ProductUsageRule 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

ProductResource ⇐ GenericResource
- new ProductResource(client)
- .actions(id) ⇒ ProductActionResource
- .versions(id) ⇒ ProductVersionResource
- .configurations(id) ⇒ ProductConfigurationResource
- .parameters(id) ⇒ ProductParameterResource
- .connections(id) ⇒ ProductConnectionsResource
- .usageRules(id) ⇒ ProductUsageRuleResource
- .getTemplates(id) ⇒ Array
- ~~.getParameters(id) ⇒ Array~~
- .getItems(id) ⇒ Array
- .getConnections(id) ⇒ Array

new ProductResource(client)

Creates a new instance of the ProductResource class.

Returns: ProductResource – An instance of the ProductResource class.

Param	Type	Description
client	`ConnectClient`	An 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.

Param	Type	Description
id	`string`	The 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.

Param	Type	Description
id	`string`	The 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.

Param	Type	Description
id	`string`	The unique identifier of the Product.

productResource.parameters(id) ⇒ `ProductParameterResource`

Returns an instance of the ProductParameterResource for a Product.

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

Param	Type	Description
id	`string`	The unique identifier of the Product.

productResource.connections(id) ⇒ `ProductConnectionsResource`

Returns an instance of the ProductConnectionsResource for a Product.

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

Param	Type	Description
id	`string`	The unique identifier of the Product.

productResource.usageRules(id) ⇒ `ProductUsageRuleResource`

Returns an instance of the ProductUsageRulesResource for a Product.

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