ProductResource

Constructor

# new ProductResource(client) → {ProductResource}

Creates a new instance of the ProductResource class.

Parameters:

Name	Type	Description
`client`	ConnectClient	An instance of the ConnectClient class.

Returns:

An instance of the ProductResource class.

Type: ProductResource

Extends

GenericResource

Members

Type: string

# baseUri

Returns the base URI of the resource mapped by this class.

Overrides:

GenericResource#baseUri

Methods

# actions(id) → {ProductActionResource}

Returns an instance of the ProductActionResource for a Product.

Parameters:

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

Returns:

An instance of the ProductActionResource for the product.

Type: ProductActionResource

# configurations(id) → {ProductConfigurationResource}

Returns an instance of the ProductConfigurationResource for a ProductConfiguration.

Parameters:

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

Returns:

An instance of the ProductConfigurationResource for the product.

Type: ProductConfigurationResource

# connections(id) → {ProductConnectionsResource}

Returns an instance of the ProductConnectionsResource for a Product.

Parameters:

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

Returns:

An instance of the ProductParameterResource for the product.

Type: ProductConnectionsResource

# async create(obj) → {object}

Create a new resource.

Parameters:

Name	Type	Description
`obj`	object	The resource to create.

Overrides:

GenericResource#create

Returns:

The created resource.

Type: object

# async delete(id)

Delete a resource.

Parameters:

Name	Type	Description
`id`	string	The unique identifier of the resource to delete.

Overrides:

GenericResource#delete

# async fetch(url, options)

Fetch the URL and returns a response.

Parameters:

Name	Type	Description
`url`	string	the URL to fetch.
`options`	object	the request options.

Overrides:

GenericResource#fetch

# async get(id) → {object}

Retrieve a resource by its unique identifier.

Parameters:

Name	Type	Description
`id`	string	The unique identifier of the resource to retrieve.

Overrides:

GenericResource#get

Returns:

The resource.

Type: object

# async getConnections(id) → {Array}

Returns the list of Connection objects configured for the Product.

Parameters:

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

Returns:

The list of Connection objects.

Type: Array

# async getItems(id) → {Array}

Returns the list of ProductItem objects configured for the Product.

Parameters:

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

Returns:

The list of ProductItem objects.

Type: Array

# async getParameters(id) → {Array}

Returns the list of Parameter objects configured for the Product.

Parameters:

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

Deprecated:

since version 20 and will be removed in version 22.

Returns:

The list of Parameter objects.

Type: Array

# async getTemplates(id) → {Array}

Returns the list of Template objects configured for the Product.

Parameters:

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

Returns:

The list of Template objects.

Type: Array

# parameters(id) → {ProductParameterResource}

Returns an instance of the ProductParameterResource for a Product.

Parameters:

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

Returns:

An instance of the ProductParameterResource for the product.

Type: ProductParameterResource

# async search(filters) → {Array}

Search for a resource.

Parameters:

Name	Type	Description
`filters`	object	The query to send to the server as a RQL object.

Overrides:

GenericResource#search

Returns:

An array of resources that match the provided filters.

Type: Array

# async update(id, obj) → {object}

Update a resource.

Parameters:

Name	Type	Description
`id`	string	The unique identifier of the resource to update.
`obj`	object	The eventually partial resource to update.

Overrides:

GenericResource#update

Returns:

The updated resource.

Type: object

# usageRules(id) → {ProductUsageRuleResource}

Returns an instance of the ProductUsageRulesResource for a Product.

Parameters:

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

Returns:

An instance of the ProductUsageRuleResource for the product.

Type: ProductUsageRuleResource

# versions(id) → {ProductVersionResource}

Returns an instance of the ProductVersionResource for a Product.

Parameters:

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

Returns:

An instance of the ProductVersionResource for the product.

Type: ProductVersionResource