Class

ProductVersionResource

ProductVersionResource(client, baseUri) → {ProductVersionResource}

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

Constructor

# new ProductVersionResource(client, baseUri) → {ProductVersionResource}

Creates a new instance of the ProductVersionResource class.

Parameters:
Name Type Description
client ConnectClient

An instance of the ConnectClient class.

baseUri string

The base uri for this resource.

An instance of the ProductVersionResource class.

Extends

Members

string

# baseUri

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

Overrides:

Methods

# actions(id) → {ProductActionResource}

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

Parameters:
Name Type Description
id string

The unique identifier of the Version object for a Product.

The instance of the ProductActionResource class for a product/version.

# async create(obj) → {object}

Create a new resource.

Parameters:
Name Type Description
obj object

The resource to create.

Overrides:

The created resource.

object

# async delete(id)

Delete a resource.

Parameters:
Name Type Description
id string

The unique identifier of the resource to delete.

Overrides:

# 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:

# 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:

The resource.

object

Search for a resource.

Parameters:
Name Type Description
filters object

The query to send to the server as a RQL object.

Overrides:

An array of resources that match the provided filters.

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:

The updated resource.

object