@jifeline/customer-products v0.3.0

Customer Products library

The Customer Products library is an implementation of the products domain within the Jifeline Customer API. With this library, after setting the config in the @jifeline/core auth module, the product catalogue of the service provider can be browsed. The product catalogue is available in different languages. To change the language, set the local through the i18n module of the core library.

Usage of the library

Import the customerProducts library to make use of the different features.

import { auth, i18n, Locale } from '@jifeline/core';
import { customerProducts } from '@jifeline/customer-products';

// Configure the core lib and authenticate by login in with connector / pin or username & password.
auth.configure(config);
auth.loginPin().subscribe();
auth.loginUsername().subscribe();

// Set the locale to the language in which the product catalogue is returned.
i18n.setLocale(Locale.en);

// After authentication - use the customer products library. Eg;
customerProducts
  .products
  .getAllProducts$()
  .subscribe();

Features

The Customer Products library provides the following features:

• product groups
• product bundles
• products
• product prerequisites
• favorite products

Product groups

The product groups feature gives access to all product groups of a given vehicle, defined by the vehicle model id and vehicle model variant id.

The following functions are supported:

• get product groups
• get all product groups

Product bundles

The product bundles feature gives access to all product bundles of a product group, defined by the product group id, vehicle model id, and vehicle model variant id.

The following functions are supported:

• get product bundles
• get all product bundles

Products

The product bundles feature gives access to all product bundles of a product group, defined by the product group id, vehicle model id, and vehicle model variant id.

The following functions are supported:

• get product bundles
• get all product bundles

Product prerequisites

The product prerequisites feature can check if a list of products (by id) has prerequisites. If a product has prerequisites, they can be fetched from the API. Next to this functionality, it is also possible to do some checks and modifications on the state of a prerequisite.

The following functions are supported:

• get product prerequisites
• get all product prerequisites
• has product prerequisites
• get prerequisite results
• all required prerequisites checked
• reset prerequisites selection
• select prerequisite

Favorite products

The favorite products feature has access to the favorite products of the current user. These favorite products can be managed using this feature; adding and removing a product from favorite products.

The following functions are supported:

• get favorite products
• get all favorite products
• add favorite product
• remove favorite product