Class: module:api/ProductListsApi

module:api/ProductListsApi(apiClient)

new module:api/ProductListsApi(apiClient)

Constructs a new ProductListsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Source:

Methods

getProductLists(opts) → {Promise}

Retrieves all public product lists as defined by the given search term (email, first name, last name).

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
email String

The email address of the customer, the product lists belong to.

firstname String

The first name of the customer, the product lists belong to.

lastname String

The last name of the customer, the product lists belong to.

Source:
Returns:
Type
Promise

getProductListsByID(listId, opts) → {Promise}

Retrieves a public product list by id.

Parameters:
Name Type Description
listId String

The id of the list.

opts Object

Optional parameters

Properties
Name Type Description
expand Array.<String>
Source:
Returns:
Type
Promise

getProductListsByIDItems(listId, opts) → {Promise}

Retrieves the items of a public product list.

Parameters:
Name Type Description
listId String

The id of the list.

opts Object

Optional parameters

Properties
Name Type Description
expand Array.<String>
Source:
Returns:
Type
Promise

getProductListsByIDItemsByID(listId, itemId, opts) → {Promise}

Retrieves an item from a public product list.

Parameters:
Name Type Description
listId String

The id of the list.

itemId String

The id of the item.

opts Object

Optional parameters

Properties
Name Type Description
expand Array.<String>
Source:
Returns:
Type
Promise

getProductListsByIDItemsByIDWithHttpInfo(listId, itemId, opts) → {Promise}

Retrieves an item from a public product list.

Parameters:
Name Type Description
listId String

The id of the list.

itemId String

The id of the item.

opts Object

Optional parameters

Properties
Name Type Description
expand Array.<String>
Source:
Returns:

a Promise, with an object containing data of type module:models/PublicProductListItem and HTTP response

Type
Promise

getProductListsByIDItemsWithHttpInfo(listId, opts) → {Promise}

Retrieves the items of a public product list.

Parameters:
Name Type Description
listId String

The id of the list.

opts Object

Optional parameters

Properties
Name Type Description
expand Array.<String>
Source:
Returns:

a Promise, with an object containing data of type module:models/PublicProductListItemResult and HTTP response

Type
Promise

getProductListsByIDWithHttpInfo(listId, opts) → {Promise}

Retrieves a public product list by id.

Parameters:
Name Type Description
listId String

The id of the list.

opts Object

Optional parameters

Properties
Name Type Description
expand Array.<String>
Source:
Returns:

a Promise, with an object containing data of type module:models/PublicProductList and HTTP response

Type
Promise

getProductListsWithHttpInfo(opts) → {Promise}

Retrieves all public product lists as defined by the given search term (email, first name, last name).

Parameters:
Name Type Description
opts Object

Optional parameters

Properties
Name Type Description
email String

The email address of the customer, the product lists belong to.

firstname String

The first name of the customer, the product lists belong to.

lastname String

The last name of the customer, the product lists belong to.

Source:
Returns:

a Promise, with an object containing data of type module:models/PublicProductListResult and HTTP response

Type
Promise