The ProductActionResource class provides methods to access the
Action objects for a product.
GenericResourceThe ProductVersionResource class provides methods to access the
Version objects for a product.
GenericResourceThe ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.
GenericResourceThe ProductParameterResource class provides methods to access the
Productpameter objects for a product.
GenericResourceThe ProductConnectionsResource class provides methods to access the
ProductConnection objects for a product.
GenericResourceThe ProductUsageRulesResource class provides methods to access the
ProductUsageRule objects for a product.
GenericResourceThe ProductResource class provides methods to access the products
endpoint of the Cloud Blue Connect API.
The ProductActionResource class provides methods to access the
Action objects for a product.
Kind: global class
Category: Resources
objectReturns 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. |
GenericResourceThe ProductVersionResource class provides methods to access the
Version objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResource
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. |
ProductActionResourceReturns 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. |
GenericResourceThe ProductConfigurationResource class provides methods to access the
ProductConfiguration objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResourceThe ProductParameterResource class provides methods to access the
Productpameter objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResourceThe ProductConnectionsResource class provides methods to access the
ProductConnection objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResourceThe ProductUsageRulesResource class provides methods to access the
ProductUsageRule objects for a product.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResourceThe ProductResource class provides methods to access the products
endpoint of the Cloud Blue Connect API.
Kind: global class
Extends: GenericResource
Category: Resources
GenericResource
ProductActionResourceProductVersionResourceProductConfigurationResourceProductParameterResourceProductConnectionsResourceProductUsageRuleResourceArrayArrayArrayArrayCreates 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. |
ProductActionResourceReturns 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. |
ProductVersionResourceReturns 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. |
ProductConfigurationResourceReturns 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. |
ProductParameterResourceReturns 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. |
ProductConnectionsResourceReturns 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. |
ProductUsageRuleResourceReturns an instance of the ProductUsageRulesResource for a Product.
Kind: instance method of ProductResource
Returns: ProductUsageRuleResource – An instance of the ProductUsageRuleResource
for the product.
| Param | Type | Description |
|---|---|---|
| id | string |
The unique identifier of the Product. |
ArrayReturns the list of Template objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array – The list of Template objects.
| Param | Type | Description |
|---|---|---|
| id | string |
The unique identifier of the Product. |
ArrayDeprecated
Returns the list of Parameter objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array – The list of Parameter objects.
| Param | Type | Description |
|---|---|---|
| id | string |
The unique identifier of the Product. |
ArrayReturns the list of ProductItem objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array – The list of ProductItem objects.
| Param | Type | Description |
|---|---|---|
| id | string |
The unique identifier of the Product. |
ArrayReturns the list of Connection objects configured for the Product.
Kind: instance method of ProductResource
Returns: Array – The list of Connection objects.
| Param | Type | Description |
|---|---|---|
| id | string |
The unique identifier of the Product. |