@nuskin/ns-loyalty-web NPM

ns-loyalty-web

This library handles the interaction with the service layer for retrieving information about the loyalty program and the user's loyalty information.

Installing

All that is needed for adding this to your project is including the library in your package.json like so:

npm i @nuskin/ns-loyalty-web

yarn add @nuskin/ns-loyalty-web

How to use in your project.

Once you have imported the library into your project, you can use it like you see here:

import webLoyalty from '@nuskin/ns-loyalty-web'

webLoyalty.getAllLoyaltyInfo().then(response => {
    .
    .
    .
});

Please note: all functions are asynchronous, so make sure you handle the expected response appropriately.

Now you have a loyalty object which can be used for making one of the following requests:

getRewardsPoints
loyaltyCanOptIn
loyaltyOptIn
loyaltyOptOut
getViewedTandC
setUserViewedTandC

getRewardsPoints

Gets the loyalty rewards points.

Returns a Loyalty data in the following form:

{
    "buckets": {
        "withinSeven": [],
        "withinThirty": 0,
        "longTerm": 0
    },
    "optInStatus": true,
    "soonestExpiring": {
        "pointsToExpire": 0,
        "expirationDate": ""
    },
    "user": {
        "adrParticipant": "NO",
        "entityType": "DIST",
        "titleParticipant": "NO"
    },
    "userTier": {
        "name": "T1",
        "purchaseIncrement": 2500,
        "minSpend": 2500,
        "purchaseRatio": 0.05,
        "redemptionLimit": 0.6,
        "daysToExpire": 90,
        "spendWithinPeriod": null,
        "tierThreshold": null
    },
    "wallet": {
        "available": 0,
        "spent": 0,
        "spentInPeriod": 0,
        "expired": 0,
        "lifetimePointsEarned": 0
    }
}