ucc-sdk v1.32.27

UCC SDK

Installation

For Browser

<script src="https://unpkg.com/ucc-sdk"></script>

For Node or Webpack

npm install ucc-sdk
yarn add ucc-sdk

const uccSdk = require('ucc-sdk');
import * as uccSdk from 'ucc-sdk';

Usage

Initialize the UCC-SDK

uccSdk.track.initialize({
  customerId: "your_customer_id", // Customer ObjectId from MongoDB, Required
  projectId: 'your_project_id', // Defaults to App Host if Not Provided
  apiKey: 'live_soon_to_be_deprecated', // Optional
  pageId: 'your_landing_page_id', // Optional
  stage: 'dev' // Defaults to dev but Possible Values are 'dev' or 'prod'
});

Submit Page Event

For Vannilla JS
window.addEventListener('load', () => {
  uccSdk.track.pageEvent();
});

For VUE JS (Vue Router)
router.afterEach(() => {
  uccSdk.track.pageEvent();
});

Submit Tracking Event

uccSdk.track.submitEvent({
  event: 'BUTTON_CLICKED', // event name preferrable in caps and underscore for spaces
  data: { code: true, ninja: false, assassin: true }, // event data is free object that accepts any properties
  user: { name: 'code assassin' }, // if user is present else defaults to browser fingerprint result
  type: 'track', // defaults to track if not supplied. eligible values are: track, engagement, interaction & experience
});

Access All Methods on the Global uccSdk

uccSdk.namespace.any(); // Scroll below for namespace and associated methods

Objects

Typedefs

rfbm : object

Kind: global namespace

• rfbm : object
  • .associateFriend(referralId, userId) ⇒ Promise.<any>
  • .confirmReferral(referralId) ⇒ Promise.<any>
  • .createNewReferralMember(newReferralMember) ⇒ Promise.<MemberSummary>
  • .findReferralProgramMember(programId, application, userId) ⇒ Promise.<ReferralProgramMember>
  • .getMemberByAssociatedAccount(externalSystem, externalUserId, programId) ⇒ Promise.<ReferralProgramMemberResult>
  • .getMemberByFriend(userId, programId) ⇒ Promise.<ReferralProgramMemberResult>
  • .getMemberByUserId(programId, userId) ⇒ Promise.<ReferralProgramMemberResult>
  • .getMemberReferralStatistics(programId, memberId) ⇒ Promise.<any>
  • .getReferralDetails(referralId) ⇒ Promise.<ReferralDetails>

rfbm.associateFriend(referralId, userId) ⇒ Promise.<any>

Associate Friend.

Kind: static method of rfbm Returns: Promise.<any> - Associate Friend Result

rfbm.confirmReferral(referralId) ⇒ Promise.<any>

Confirm Referral.

Kind: static method of rfbm Returns: Promise.<any> - Confirm Referral Result

rfbm.createNewReferralMember(newReferralMember) ⇒ Promise.<MemberSummary>

Create A New Referral Member.

Kind: static method of rfbm Returns: Promise.<MemberSummary> - New Referral Result

rfbm.findReferralProgramMember(programId, application, userId) ⇒ Promise.<ReferralProgramMember>

Find Referral Program Member.

Kind: static method of rfbm Returns: Promise.<ReferralProgramMember> - Get Referral Program Member Result

rfbm.getMemberByAssociatedAccount(externalSystem, externalUserId, programId) ⇒ Promise.<ReferralProgramMemberResult>

Get Member By Associated Account

Kind: static method of rfbm Returns: Promise.<ReferralProgramMemberResult> - Get Member By Associated Account Result

rfbm.getMemberByFriend(userId, programId) ⇒ Promise.<ReferralProgramMemberResult>

Get Member By Friend.

Kind: static method of rfbm Returns: Promise.<ReferralProgramMemberResult> - Get Member By Friend Result

rfbm.getMemberByUserId(programId, userId) ⇒ Promise.<ReferralProgramMemberResult>

Get Member By User Id.

Kind: static method of rfbm Returns: Promise.<ReferralProgramMemberResult> - Get Member By User Id Result

rfbm.getMemberReferralStatistics(programId, memberId) ⇒ Promise.<any>

Get Member Referral Statistics

Kind: static method of rfbm Returns: Promise.<any> - Get Member Referral Statistics Result

rfbm.getReferralDetails(referralId) ⇒ Promise.<ReferralDetails>

Get Referral Details

Kind: static method of rfbm Returns: Promise.<ReferralDetails> - Get Referral Details Result

user : object

Kind: global namespace

• user : object
  • .createStoreCard(newStoreCard) ⇒ Promise.<NewStoreCardResult>
  • .create(newUserProfile) ⇒ Promise.<NewUserProfileResult>
  • .engagedWith(userId, newEngagement) ⇒ Promise.<any>
  • .getUserByAssociatedAccount(externalSystem, externalUserId) ⇒ Promise.<UserProfileResult>
  • .optIn(userId, customerId, newOptIn) ⇒ Promise.<any>
  • .optOut(userId, customerId, newOptOut) ⇒ Promise.<any>

user.createStoreCard(newStoreCard) ⇒ Promise.<NewStoreCardResult>

Create Store Card.

Kind: static method of user Returns: Promise.<NewStoreCardResult> - New Store Card Result

user.create(newUserProfile) ⇒ Promise.<NewUserProfileResult>

Create A New User Profile.

Kind: static method of user Returns: Promise.<NewUserProfileResult> - New User Profile Result

user.engagedWith(userId, newEngagement) ⇒ Promise.<any>

Add A New Engagement.

Kind: static method of user Returns: Promise.<any> - New Engagement Result

user.getUserByAssociatedAccount(externalSystem, externalUserId) ⇒ Promise.<UserProfileResult>

Get User By Associated Account

Kind: static method of user Returns: Promise.<UserProfileResult> - Get User By Associated Account Result

user.optIn(userId, customerId, newOptIn) ⇒ Promise.<any>

Add A New Opt In.

Kind: static method of user Returns: Promise.<any> - New Opt In Result

user.optOut(userId, customerId, newOptOut) ⇒ Promise.<any>

Add A New Opt In.

Kind: static method of user Returns: Promise.<any> - New Opt In Result

track : object

Kind: global namespace

• track : object
  • .invokeWebhook(webhookUrl, data) ⇒ Promise.<any>
  • .pageEvent() ⇒ Promise.<any>
  • .initialize(initialization) ⇒ boolean
  • .submitEvent(trackingEvent) ⇒ Promise.<any>

track.invokeWebhook(webhookUrl, data) ⇒ Promise.<any>

Invoke Webhook

Kind: static method of track Returns: Promise.<any> - Web Tracking Response

track.pageEvent() ⇒ Promise.<any>

Send UCC Web Page Event.

Kind: static method of track Returns: Promise.<any> - Web Tracking Response

track.initialize(initialization) ⇒ boolean

Initialize UCC Web Tracking.

Kind: static method of track Returns: boolean - Web Tracking Init Response

track.submitEvent(trackingEvent) ⇒ Promise.<any>

Send UCC Web Tracking Event.

Kind: static method of track Returns: Promise.<any> - Web Tracking Response

payments : object

Kind: global namespace

• payments : object
  • .cancelDeposit(customerId, depositId) ⇒ Promise.<any>
  • .createDeposit(customerId, chainName, userId, currency, amount, tokenSymbol, events) ⇒ Promise.<any>
  • .getDeposit(customerId, depositId) ⇒ Promise.<any>
  • .getHotWallets(customerId, usage) ⇒ Promise.<any>
  • .updateDeposit(customerId, depositId, txHash) ⇒ Promise.<any>

payments.cancelDeposit(customerId, depositId) ⇒ Promise.<any>

Cancel Crypto Deposit

Kind: static method of payments Returns: Promise.<any> - Cancel Crypto Deposit Response

payments.createDeposit(customerId, chainName, userId, currency, amount, tokenSymbol, events) ⇒ Promise.<any>

Create Crypto Deposit

Kind: static method of payments Returns: Promise.<any> - Create Crypto Deposit Response

payments.getDeposit(customerId, depositId) ⇒ Promise.<any>

Get Crypto Deposit

Kind: static method of payments Returns: Promise.<any> - Get Crypto Deposit Response

payments.getHotWallets(customerId, usage) ⇒ Promise.<any>

Get Customer Hot Wallets

Kind: static method of payments Returns: Promise.<any> - Get Customer Hot Wallets Response

payments.updateDeposit(customerId, depositId, txHash) ⇒ Promise.<any>

Update Crypto Deposit

Kind: static method of payments Returns: Promise.<any> - Update Crypto Deposit Response

AssociatedAccount : Object

AssociatedAccount Type.

Kind: global typedef Properties

NewReferralMember : Object

NewReferralMember Type.

Kind: global typedef Properties

MemberSummary : Object

MemberSummary Type.

Kind: global typedef Properties

PayoutSettings : Object

PayoutSettings Type.

Kind: global typedef Properties

SocialMediaProfiles : Object

SocialMediaProfiles Type.

Kind: global typedef Properties

ReferralProgramMember : Object

ReferralProgramMember Type.

Kind: global typedef Properties

ReferralProgramMemberResult : Object

ReferralProgramMember Type.

Kind: global typedef Properties

PayoutSettings : Object

PayoutSettings Type.

Kind: global typedef Properties

SocialMediaProfiles : Object

SocialMediaProfiles Type.

Kind: global typedef Properties

ReferralProgramMember : Object

ReferralProgramMember Type.

Kind: global typedef Properties

ReferralProgramMemberResult : Object

ReferralProgramMember Type.

Kind: global typedef Properties

PayoutSettings : Object

PayoutSettings Type.

Kind: global typedef Properties

SocialMediaProfiles : Object

SocialMediaProfiles Type.

Kind: global typedef Properties

ReferralProgramMember : Object

ReferralProgramMember Type.

Kind: global typedef Properties

ReferralProgramMemberResult : Object

ReferralProgramMember Type.

Kind: global typedef Properties

ReferralProgram : Object

ReferralProgram Type.

Kind: global typedef Properties

ReferralMember : Object

ReferralMember Type.

Kind: global typedef Properties

ReferralFriend : Object

ReferralFriend Type.

Kind: global typedef Properties

Referral : Object

Referral Type.

Kind: global typedef Properties

ReferralDetails : Object

ReferralDetails Type.

Kind: global typedef Properties

Initialization : Object

Initialization Type.

Kind: global typedef Properties

TrackingEvent : Object

Tracking Event Type.

Kind: global typedef Properties

NewStoreCard : Object

NewStoreCard Type.

Kind: global typedef Properties

NewStoreCardResult : Object

NewStoreCard Result Type.

Kind: global typedef Properties

NewUserProfile : Object

NewUserProfile Type.

Kind: global typedef Properties

NewUserProfileResult : Object

NewUserProfileResult Type.

Kind: global typedef Properties

NewEngagement : Object

NewEngagement Type.

Kind: global typedef Properties

SocialMediaProfiles : Object

SocialMediaProfiles Type.

Kind: global typedef Properties

PhoneInfo : Object

PhoneInfo Type.

Kind: global typedef Properties

BrowserInfo : Object

BrowserInfo Type.

Kind: global typedef Properties

PersonalData : Object

PersonalData Type.

Kind: global typedef Properties

UserProfile : Object

UserProfile Type.

Kind: global typedef Properties

UserProfileResult : Object

UserProfileResult Type.

Kind: global typedef Properties

NewOptIn : Object

NewOptIn Type.

Kind: global typedef Properties

NewOptOut : Object

NewOptOut Type.

Kind: global typedef Properties