ucc-sdk/README.md

UnchainedCarrot SDK

# 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

<dl>
<dt><a href="#rfbm">rfbm</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#user">user</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#track">track</a> : <code>object</code></dt>
<dd></dd>
<dt><a href="#payments">payments</a> : <code>object</code></dt>
<dd></dd>
</dl>

## Typedefs

<dl>
<dt><a href="#AssociatedAccount">AssociatedAccount</a> : <code>Object</code></dt>
<dd><p>AssociatedAccount Type.</p>
</dd>
<dt><a href="#NewReferralMember">NewReferralMember</a> : <code>Object</code></dt>
<dd><p>NewReferralMember Type.</p>
</dd>
<dt><a href="#MemberSummary">MemberSummary</a> : <code>Object</code></dt>
<dd><p>MemberSummary Type.</p>
</dd>
<dt><a href="#PayoutSettings">PayoutSettings</a> : <code>Object</code></dt>
<dd><p>PayoutSettings Type.</p>
</dd>
<dt><a href="#SocialMediaProfiles">SocialMediaProfiles</a> : <code>Object</code></dt>
<dd><p>SocialMediaProfiles Type.</p>
</dd>
<dt><a href="#ReferralProgramMember">ReferralProgramMember</a> : <code>Object</code></dt>
<dd><p>ReferralProgramMember Type.</p>
</dd>
<dt><a href="#ReferralProgramMemberResult">ReferralProgramMemberResult</a> : <code>Object</code></dt>
<dd><p>ReferralProgramMember Type.</p>
</dd>
<dt><a href="#PayoutSettings">PayoutSettings</a> : <code>Object</code></dt>
<dd><p>PayoutSettings Type.</p>
</dd>
<dt><a href="#SocialMediaProfiles">SocialMediaProfiles</a> : <code>Object</code></dt>
<dd><p>SocialMediaProfiles Type.</p>
</dd>
<dt><a href="#ReferralProgramMember">ReferralProgramMember</a> : <code>Object</code></dt>
<dd><p>ReferralProgramMember Type.</p>
</dd>
<dt><a href="#ReferralProgramMemberResult">ReferralProgramMemberResult</a> : <code>Object</code></dt>
<dd><p>ReferralProgramMember Type.</p>
</dd>
<dt><a href="#PayoutSettings">PayoutSettings</a> : <code>Object</code></dt>
<dd><p>PayoutSettings Type.</p>
</dd>
<dt><a href="#SocialMediaProfiles">SocialMediaProfiles</a> : <code>Object</code></dt>
<dd><p>SocialMediaProfiles Type.</p>
</dd>
<dt><a href="#ReferralProgramMember">ReferralProgramMember</a> : <code>Object</code></dt>
<dd><p>ReferralProgramMember Type.</p>
</dd>
<dt><a href="#ReferralProgramMemberResult">ReferralProgramMemberResult</a> : <code>Object</code></dt>
<dd><p>ReferralProgramMember Type.</p>
</dd>
<dt><a href="#ReferralProgram">ReferralProgram</a> : <code>Object</code></dt>
<dd><p>ReferralProgram Type.</p>
</dd>
<dt><a href="#ReferralMember">ReferralMember</a> : <code>Object</code></dt>
<dd><p>ReferralMember Type.</p>
</dd>
<dt><a href="#ReferralFriend">ReferralFriend</a> : <code>Object</code></dt>
<dd><p>ReferralFriend Type.</p>
</dd>
<dt><a href="#Referral">Referral</a> : <code>Object</code></dt>
<dd><p>Referral Type.</p>
</dd>
<dt><a href="#ReferralDetails">ReferralDetails</a> : <code>Object</code></dt>
<dd><p>ReferralDetails Type.</p>
</dd>
<dt><a href="#Initialization">Initialization</a> : <code>Object</code></dt>
<dd><p>Initialization Type.</p>
</dd>
<dt><a href="#TrackingEvent">TrackingEvent</a> : <code>Object</code></dt>
<dd><p>Tracking Event Type.</p>
</dd>
<dt><a href="#NewStoreCard">NewStoreCard</a> : <code>Object</code></dt>
<dd><p>NewStoreCard Type.</p>
</dd>
<dt><a href="#NewStoreCardResult">NewStoreCardResult</a> : <code>Object</code></dt>
<dd><p>NewStoreCard Result Type.</p>
</dd>
<dt><a href="#NewUserProfile">NewUserProfile</a> : <code>Object</code></dt>
<dd><p>NewUserProfile Type.</p>
</dd>
<dt><a href="#NewUserProfileResult">NewUserProfileResult</a> : <code>Object</code></dt>
<dd><p>NewUserProfileResult Type.</p>
</dd>
<dt><a href="#NewEngagement">NewEngagement</a> : <code>Object</code></dt>
<dd><p>NewEngagement Type.</p>
</dd>
<dt><a href="#SocialMediaProfiles">SocialMediaProfiles</a> : <code>Object</code></dt>
<dd><p>SocialMediaProfiles Type.</p>
</dd>
<dt><a href="#PhoneInfo">PhoneInfo</a> : <code>Object</code></dt>
<dd><p>PhoneInfo Type.</p>
</dd>
<dt><a href="#BrowserInfo">BrowserInfo</a> : <code>Object</code></dt>
<dd><p>BrowserInfo Type.</p>
</dd>
<dt><a href="#PersonalData">PersonalData</a> : <code>Object</code></dt>
<dd><p>PersonalData Type.</p>
</dd>
<dt><a href="#UserProfile">UserProfile</a> : <code>Object</code></dt>
<dd><p>UserProfile Type.</p>
</dd>
<dt><a href="#UserProfileResult">UserProfileResult</a> : <code>Object</code></dt>
<dd><p>UserProfileResult Type.</p>
</dd>
<dt><a href="#NewOptIn">NewOptIn</a> : <code>Object</code></dt>
<dd><p>NewOptIn Type.</p>
</dd>
<dt><a href="#NewOptOut">NewOptOut</a> : <code>Object</code></dt>
<dd><p>NewOptOut Type.</p>
</dd>
</dl>

<a name="rfbm"></a>

## rfbm : <code>object</code>
**Kind**: global namespace

* [rfbm](#rfbm) : <code>object</code>
    * [.associateFriend(referralId, userId)](#rfbm.associateFriend) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.confirmReferral(referralId)](#rfbm.confirmReferral) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.createNewReferralMember(newReferralMember)](#rfbm.createNewReferralMember) ⇒ [<code>Promise.&lt;MemberSummary&gt;</code>](#MemberSummary)
    * [.findReferralProgramMember(programId, application, userId)](#rfbm.findReferralProgramMember) ⇒ [<code>Promise.&lt;ReferralProgramMember&gt;</code>](#ReferralProgramMember)
    * [.getMemberByAssociatedAccount(externalSystem, externalUserId, programId)](#rfbm.getMemberByAssociatedAccount) ⇒ [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult)
    * [.getMemberByFriend(userId, programId)](#rfbm.getMemberByFriend) ⇒ [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult)
    * [.getMemberByUserId(programId, userId)](#rfbm.getMemberByUserId) ⇒ [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult)
    * [.getMemberReferralStatistics(programId, memberId)](#rfbm.getMemberReferralStatistics) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getReferralDetails(referralId)](#rfbm.getReferralDetails) ⇒ [<code>Promise.&lt;ReferralDetails&gt;</code>](#ReferralDetails)

<a name="rfbm.associateFriend"></a>

### rfbm.associateFriend(referralId, userId) ⇒ <code>Promise.&lt;any&gt;</code>
Associate Friend.

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: <code>Promise.&lt;any&gt;</code> - Associate Friend Result

| Param | Type | Description |
| --- | --- | --- |
| referralId | <code>string</code> | Referral Id. |
| userId | <code>string</code> | User Id. |

<a name="rfbm.confirmReferral"></a>

### rfbm.confirmReferral(referralId) ⇒ <code>Promise.&lt;any&gt;</code>
Confirm Referral.

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: <code>Promise.&lt;any&gt;</code> - Confirm Referral Result

| Param | Type | Description |
| --- | --- | --- |
| referralId | <code>string</code> | Referral Id. |

<a name="rfbm.createNewReferralMember"></a>

### rfbm.createNewReferralMember(newReferralMember) ⇒ [<code>Promise.&lt;MemberSummary&gt;</code>](#MemberSummary)
Create A New Referral Member.

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: [<code>Promise.&lt;MemberSummary&gt;</code>](#MemberSummary) - New Referral Result

| Param | Type | Description |
| --- | --- | --- |
| newReferralMember | [<code>NewReferralMember</code>](#NewReferralMember) | New Referral Member. |

<a name="rfbm.findReferralProgramMember"></a>

### rfbm.findReferralProgramMember(programId, application, userId) ⇒ [<code>Promise.&lt;ReferralProgramMember&gt;</code>](#ReferralProgramMember)
Find Referral Program Member.

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: [<code>Promise.&lt;ReferralProgramMember&gt;</code>](#ReferralProgramMember) - Get Referral Program Member Result

| Param | Type | Description |
| --- | --- | --- |
| programId | <code>string</code> | Referral Program Id. |
| application | <code>string</code> | Application or External System. |
| userId | <code>string</code> | Referral Program User Id. |

<a name="rfbm.getMemberByAssociatedAccount"></a>

### rfbm.getMemberByAssociatedAccount(externalSystem, externalUserId, programId) ⇒ [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult)
Get Member By Associated Account

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult) - Get Member By Associated Account Result

| Param | Type | Description |
| --- | --- | --- |
| externalSystem | <code>string</code> | External System. |
| externalUserId | <code>string</code> | External User Id. |
| programId | <code>string</code> | Referral Program Id. |

<a name="rfbm.getMemberByFriend"></a>

### rfbm.getMemberByFriend(userId, programId) ⇒ [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult)
Get Member By Friend.

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult) - Get Member By Friend Result

| Param | Type | Description |
| --- | --- | --- |
| userId | <code>string</code> | user objectId. |
| programId | <code>string</code> | Referral Program Id. |

<a name="rfbm.getMemberByUserId"></a>

### rfbm.getMemberByUserId(programId, userId) ⇒ [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult)
Get Member By User Id.

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: [<code>Promise.&lt;ReferralProgramMemberResult&gt;</code>](#ReferralProgramMemberResult) - Get Member By User Id Result

| Param | Type | Description |
| --- | --- | --- |
| programId | <code>string</code> | Referral Program Id. |
| userId | <code>string</code> | auth0 ID. |

<a name="rfbm.getMemberReferralStatistics"></a>

### rfbm.getMemberReferralStatistics(programId, memberId) ⇒ <code>Promise.&lt;any&gt;</code>
Get Member Referral Statistics

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: <code>Promise.&lt;any&gt;</code> - Get Member Referral Statistics Result

| Param | Type | Description |
| --- | --- | --- |
| programId | <code>string</code> | Referral Program Id. |
| memberId | <code>string</code> | Referral Program Member Id. |

<a name="rfbm.getReferralDetails"></a>

### rfbm.getReferralDetails(referralId) ⇒ [<code>Promise.&lt;ReferralDetails&gt;</code>](#ReferralDetails)
Get Referral Details

**Kind**: static method of [<code>rfbm</code>](#rfbm)
**Returns**: [<code>Promise.&lt;ReferralDetails&gt;</code>](#ReferralDetails) - Get Referral Details Result

| Param | Type | Description |
| --- | --- | --- |
| referralId | <code>string</code> | Referral Id. |

<a name="user"></a>

## user : <code>object</code>
**Kind**: global namespace

* [user](#user) : <code>object</code>
    * [.createStoreCard(newStoreCard)](#user.createStoreCard) ⇒ [<code>Promise.&lt;NewStoreCardResult&gt;</code>](#NewStoreCardResult)
    * [.create(newUserProfile)](#user.create) ⇒ [<code>Promise.&lt;NewUserProfileResult&gt;</code>](#NewUserProfileResult)
    * [.engagedWith(userId, newEngagement)](#user.engagedWith) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getUserByAssociatedAccount(externalSystem, externalUserId)](#user.getUserByAssociatedAccount) ⇒ [<code>Promise.&lt;UserProfileResult&gt;</code>](#UserProfileResult)
    * [.optIn(userId, customerId, newOptIn)](#user.optIn) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.optOut(userId, customerId, newOptOut)](#user.optOut) ⇒ <code>Promise.&lt;any&gt;</code>

<a name="user.createStoreCard"></a>

### user.createStoreCard(newStoreCard) ⇒ [<code>Promise.&lt;NewStoreCardResult&gt;</code>](#NewStoreCardResult)
Create Store Card.

**Kind**: static method of [<code>user</code>](#user)
**Returns**: [<code>Promise.&lt;NewStoreCardResult&gt;</code>](#NewStoreCardResult) - New Store Card Result

| Param | Type | Description |
| --- | --- | --- |
| newStoreCard | [<code>NewStoreCard</code>](#NewStoreCard) | New Store Card |

<a name="user.create"></a>

### user.create(newUserProfile) ⇒ [<code>Promise.&lt;NewUserProfileResult&gt;</code>](#NewUserProfileResult)
Create A New User Profile.

**Kind**: static method of [<code>user</code>](#user)
**Returns**: [<code>Promise.&lt;NewUserProfileResult&gt;</code>](#NewUserProfileResult) - New User Profile Result

| Param | Type | Description |
| --- | --- | --- |
| newUserProfile | [<code>NewUserProfile</code>](#NewUserProfile) | New User Profile. |

<a name="user.engagedWith"></a>

### user.engagedWith(userId, newEngagement) ⇒ <code>Promise.&lt;any&gt;</code>
Add A New Engagement.

**Kind**: static method of [<code>user</code>](#user)
**Returns**: <code>Promise.&lt;any&gt;</code> - New Engagement Result

| Param | Type | Description |
| --- | --- | --- |
| userId | <code>string</code> | User ObjectID |
| newEngagement | [<code>NewEngagement</code>](#NewEngagement) | New Engagement. |

<a name="user.getUserByAssociatedAccount"></a>

### user.getUserByAssociatedAccount(externalSystem, externalUserId) ⇒ [<code>Promise.&lt;UserProfileResult&gt;</code>](#UserProfileResult)
Get User By Associated Account

**Kind**: static method of [<code>user</code>](#user)
**Returns**: [<code>Promise.&lt;UserProfileResult&gt;</code>](#UserProfileResult) - Get User By Associated Account Result

| Param | Type | Description |
| --- | --- | --- |
| externalSystem | <code>string</code> | External System. |
| externalUserId | <code>string</code> | External User Id. |

<a name="user.optIn"></a>

### user.optIn(userId, customerId, newOptIn) ⇒ <code>Promise.&lt;any&gt;</code>
Add A New Opt In.

**Kind**: static method of [<code>user</code>](#user)
**Returns**: <code>Promise.&lt;any&gt;</code> - New Opt In Result

| Param | Type | Description |
| --- | --- | --- |
| userId | <code>string</code> | User ObjectID |
| customerId | <code>string</code> | Customer ObjectID |
| newOptIn | [<code>NewOptIn</code>](#NewOptIn) | New Opt In. |

<a name="user.optOut"></a>

### user.optOut(userId, customerId, newOptOut) ⇒ <code>Promise.&lt;any&gt;</code>
Add A New Opt In.

**Kind**: static method of [<code>user</code>](#user)
**Returns**: <code>Promise.&lt;any&gt;</code> - New Opt In Result

| Param | Type | Description |
| --- | --- | --- |
| userId | <code>string</code> | User ObjectID |
| customerId | <code>string</code> | Customer ObjectID |
| newOptOut | [<code>NewOptOut</code>](#NewOptOut) | New Opt In. |

<a name="track"></a>

## track : <code>object</code>
**Kind**: global namespace

* [track](#track) : <code>object</code>
    * [.invokeWebhook(webhookUrl, data)](#track.invokeWebhook) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.pageEvent()](#track.pageEvent) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.initialize(initialization)](#track.initialize) ⇒ <code>boolean</code>
    * [.submitEvent(trackingEvent)](#track.submitEvent) ⇒ <code>Promise.&lt;any&gt;</code>

<a name="track.invokeWebhook"></a>

### track.invokeWebhook(webhookUrl, data) ⇒ <code>Promise.&lt;any&gt;</code>
Invoke Webhook

**Kind**: static method of [<code>track</code>](#track)
**Returns**: <code>Promise.&lt;any&gt;</code> - Web Tracking Response

| Param | Type | Description |
| --- | --- | --- |
| webhookUrl | <code>string</code> | webhookUrl |
| data | <code>object</code> | data |

<a name="track.pageEvent"></a>

### track.pageEvent() ⇒ <code>Promise.&lt;any&gt;</code>
Send UCC Web Page Event.

**Kind**: static method of [<code>track</code>](#track)
**Returns**: <code>Promise.&lt;any&gt;</code> - Web Tracking Response
<a name="track.initialize"></a>

### track.initialize(initialization) ⇒ <code>boolean</code>
Initialize UCC Web Tracking.

**Kind**: static method of [<code>track</code>](#track)
**Returns**: <code>boolean</code> - Web Tracking Init Response

| Param | Type | Description |
| --- | --- | --- |
| initialization | [<code>Initialization</code>](#Initialization) | initialization. |

<a name="track.submitEvent"></a>

### track.submitEvent(trackingEvent) ⇒ <code>Promise.&lt;any&gt;</code>
Send UCC Web Tracking Event.

**Kind**: static method of [<code>track</code>](#track)
**Returns**: <code>Promise.&lt;any&gt;</code> - Web Tracking Response

| Param | Type | Description |
| --- | --- | --- |
| trackingEvent | [<code>TrackingEvent</code>](#TrackingEvent) | trackingEvent. |

<a name="payments"></a>

## payments : <code>object</code>
**Kind**: global namespace

* [payments](#payments) : <code>object</code>
    * [.cancelDeposit(customerId, depositId)](#payments.cancelDeposit) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.createDeposit(customerId, chainName, userId, currency, amount, tokenSymbol, events)](#payments.createDeposit) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getDeposit(customerId, depositId)](#payments.getDeposit) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.getHotWallets(customerId, usage)](#payments.getHotWallets) ⇒ <code>Promise.&lt;any&gt;</code>
    * [.updateDeposit(customerId, depositId, txHash)](#payments.updateDeposit) ⇒ <code>Promise.&lt;any&gt;</code>

<a name="payments.cancelDeposit"></a>

### payments.cancelDeposit(customerId, depositId) ⇒ <code>Promise.&lt;any&gt;</code>
Cancel Crypto Deposit

**Kind**: static method of [<code>payments</code>](#payments)
**Returns**: <code>Promise.&lt;any&gt;</code> - Cancel Crypto Deposit Response

| Param | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | customerId |
| depositId | <code>string</code> | depositId |

<a name="payments.createDeposit"></a>

### payments.createDeposit(customerId, chainName, userId, currency, amount, tokenSymbol, events) ⇒ <code>Promise.&lt;any&gt;</code>
Create Crypto Deposit

**Kind**: static method of [<code>payments</code>](#payments)
**Returns**: <code>Promise.&lt;any&gt;</code> - Create Crypto Deposit Response

| Param | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | customerId |
| chainName | <code>string</code> | chainName |
| userId | <code>string</code> | userId |
| currency | <code>string</code> | currency |
| amount | <code>string</code> | amount |
| tokenSymbol | <code>string</code> | tokenSymbol |
| events | <code>Array.&lt;Object&gt;</code> | events |

<a name="payments.getDeposit"></a>

### payments.getDeposit(customerId, depositId) ⇒ <code>Promise.&lt;any&gt;</code>
Get Crypto Deposit

**Kind**: static method of [<code>payments</code>](#payments)
**Returns**: <code>Promise.&lt;any&gt;</code> - Get Crypto Deposit Response

| Param | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | customerId |
| depositId | <code>string</code> | depositId |

<a name="payments.getHotWallets"></a>

### payments.getHotWallets(customerId, usage) ⇒ <code>Promise.&lt;any&gt;</code>
Get Customer Hot Wallets

**Kind**: static method of [<code>payments</code>](#payments)
**Returns**: <code>Promise.&lt;any&gt;</code> - Get Customer Hot Wallets Response

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| customerId | <code>string</code> |  | customerId |
| usage | <code>string</code> | <code>&quot;ANY&quot;</code> | usage |

<a name="payments.updateDeposit"></a>

### payments.updateDeposit(customerId, depositId, txHash) ⇒ <code>Promise.&lt;any&gt;</code>
Update Crypto Deposit

**Kind**: static method of [<code>payments</code>](#payments)
**Returns**: <code>Promise.&lt;any&gt;</code> - Update Crypto Deposit Response

| Param | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | customerId |
| depositId | <code>string</code> | depositId |
| txHash | <code>string</code> | txHash |

<a name="AssociatedAccount"></a>

## AssociatedAccount : <code>Object</code>
AssociatedAccount Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| application | <code>string</code> | ucc application or external system. |
| userId | <code>string</code> | ucc application or external system userId. |

<a name="NewReferralMember"></a>

## NewReferralMember : <code>Object</code>
NewReferralMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | firstName. |
| lastName | <code>string</code> | lastName. |
| email | <code>string</code> | email. |
| phone | <code>string</code> | phone. |
| country | <code>string</code> | country. |
| password | <code>string</code> | password. |
| associatedAccount | [<code>AssociatedAccount</code>](#AssociatedAccount) | associatedAccount. |
| referralCode | <code>string</code> | referralCode. |
| referralProgramId | <code>string</code> | referralProgramId. |

<a name="MemberSummary"></a>

## MemberSummary : <code>Object</code>
MemberSummary Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| userProfileId | <code>string</code> | userProfileId. |
| auth0Id | <code>string</code> | auth0Id. |
| memberId | <code>string</code> | memberId. |
| referralLink | <code>string</code> | referralLink. |

<a name="PayoutSettings"></a>

## PayoutSettings : <code>Object</code>
PayoutSettings Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| blockchain | <code>string</code> | blockchain. |
| address | <code>string</code> | address. |

<a name="SocialMediaProfiles"></a>

## SocialMediaProfiles : <code>Object</code>
SocialMediaProfiles Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| username | <code>string</code> | username. |
| provider | <code>string</code> | provider. |

<a name="ReferralProgramMember"></a>

## ReferralProgramMember : <code>Object</code>
ReferralProgramMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | firstName. |
| lastName | <code>string</code> | lastName. |
| phone | <code>string</code> | phone. |
| country | <code>string</code> | country. |
| payoutSettings | [<code>Array.&lt;PayoutSettings&gt;</code>](#PayoutSettings) | payoutSettings. |
| socialMediaProfiles | [<code>Array.&lt;SocialMediaProfiles&gt;</code>](#SocialMediaProfiles) | socialMediaProfiles. |
| email | <code>string</code> | email. |

<a name="ReferralProgramMemberResult"></a>

## ReferralProgramMemberResult : <code>Object</code>
ReferralProgramMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| result | [<code>ReferralProgramMember</code>](#ReferralProgramMember) | referral member. |

<a name="PayoutSettings"></a>

## PayoutSettings : <code>Object</code>
PayoutSettings Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| blockchain | <code>string</code> | blockchain. |
| address | <code>string</code> | address. |

<a name="SocialMediaProfiles"></a>

## SocialMediaProfiles : <code>Object</code>
SocialMediaProfiles Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| username | <code>string</code> | username. |
| provider | <code>string</code> | provider. |

<a name="ReferralProgramMember"></a>

## ReferralProgramMember : <code>Object</code>
ReferralProgramMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | firstName. |
| lastName | <code>string</code> | lastName. |
| phone | <code>string</code> | phone. |
| country | <code>string</code> | country. |
| payoutSettings | [<code>Array.&lt;PayoutSettings&gt;</code>](#PayoutSettings) | payoutSettings. |
| socialMediaProfiles | [<code>Array.&lt;SocialMediaProfiles&gt;</code>](#SocialMediaProfiles) | socialMediaProfiles. |
| email | <code>string</code> | email. |

<a name="ReferralProgramMemberResult"></a>

## ReferralProgramMemberResult : <code>Object</code>
ReferralProgramMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| result | [<code>ReferralProgramMember</code>](#ReferralProgramMember) | referral member. |

<a name="PayoutSettings"></a>

## PayoutSettings : <code>Object</code>
PayoutSettings Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| blockchain | <code>string</code> | blockchain. |
| address | <code>string</code> | address. |

<a name="SocialMediaProfiles"></a>

## SocialMediaProfiles : <code>Object</code>
SocialMediaProfiles Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| username | <code>string</code> | username. |
| provider | <code>string</code> | provider. |

<a name="ReferralProgramMember"></a>

## ReferralProgramMember : <code>Object</code>
ReferralProgramMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | firstName. |
| lastName | <code>string</code> | lastName. |
| phone | <code>string</code> | phone. |
| country | <code>string</code> | country. |
| payoutSettings | [<code>Array.&lt;PayoutSettings&gt;</code>](#PayoutSettings) | payoutSettings. |
| socialMediaProfiles | [<code>Array.&lt;SocialMediaProfiles&gt;</code>](#SocialMediaProfiles) | socialMediaProfiles. |
| email | <code>string</code> | email. |

<a name="ReferralProgramMemberResult"></a>

## ReferralProgramMemberResult : <code>Object</code>
ReferralProgramMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| result | [<code>ReferralProgramMember</code>](#ReferralProgramMember) | referral member. |

<a name="ReferralProgram"></a>

## ReferralProgram : <code>Object</code>
ReferralProgram Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| title | <code>string</code> | referral program title |
| description | <code>string</code> | referral program description |

<a name="ReferralMember"></a>

## ReferralMember : <code>Object</code>
ReferralMember Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | referral member firstName |
| lastName | <code>string</code> | referral member lastName |

<a name="ReferralFriend"></a>

## ReferralFriend : <code>Object</code>
ReferralFriend Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | referred friend firstName |
| lastName | <code>string</code> | referred friend lastName |

<a name="Referral"></a>

## Referral : <code>Object</code>
Referral Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| program | [<code>ReferralProgram</code>](#ReferralProgram) | referral program |
| member | [<code>ReferralMember</code>](#ReferralMember) | referral member |
| friend- | [<code>ReferralFriend</code>](#ReferralFriend) | referred friend |

<a name="ReferralDetails"></a>

## ReferralDetails : <code>Object</code>
ReferralDetails Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| message | <code>string</code> | message |
| result | [<code>Referral</code>](#Referral) | result |

<a name="Initialization"></a>

## Initialization : <code>Object</code>
Initialization Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | UCC Customer ID. |
| projectId | <code>string</code> | UCC Project/Source ID. |
| apiKey | <code>string</code> | UCC Customer Api Key. |
| pageId | <code>string</code> | UCC Landing Page Object Id. |
| stage | <code>string</code> | UCC Stage. |

<a name="TrackingEvent"></a>

## TrackingEvent : <code>Object</code>
Tracking Event Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | UCC Customer ID. |
| projectId | <code>string</code> | UCC Project/Source ID. |
| event | <code>string</code> | Event Name - Find out from Project Manager. |
| data | <code>object</code> | Event Data - Find out from Project Manager. |
| user | <code>object</code> | User Data If Applicable. |
| type | <code>string</code> | Event Type If Applicable. Defaults to track |

<a name="NewStoreCard"></a>

## NewStoreCard : <code>Object</code>
NewStoreCard Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| walletProvider | <code>string</code> | walletProvider. |
| templateId | <code>string</code> | templateId. |
| customerId | <code>string</code> | customerId. |
| userId | <code>string</code> | userId. |

<a name="NewStoreCardResult"></a>

## NewStoreCardResult : <code>Object</code>
NewStoreCard Result Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| passTypeIdentifier | <code>string</code> | passTypeIdentifier. |
| serialNumber | <code>string</code> | serialNumber. |
| description | <code>string</code> | description. |

<a name="NewUserProfile"></a>

## NewUserProfile : <code>Object</code>
NewUserProfile Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | firstName. |
| lastName | <code>string</code> | lastName. |
| email | <code>string</code> | email. |
| phone | <code>string</code> | phone. |
| country | <code>string</code> | country. |
| password | <code>string</code> | password. |
| associatedAccount | [<code>AssociatedAccount</code>](#AssociatedAccount) | associatedAccount. |

<a name="NewUserProfileResult"></a>

## NewUserProfileResult : <code>Object</code>
NewUserProfileResult Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| userProfileId | <code>string</code> | userProfileId. |
| auth0Id | <code>string</code> | auth0Id. |

<a name="NewEngagement"></a>

## NewEngagement : <code>Object</code>
NewEngagement Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| customerId | <code>string</code> | customerId. |
| firstTimeOn | <code>string</code> | firstTimeOn. |

<a name="SocialMediaProfiles"></a>

## SocialMediaProfiles : <code>Object</code>
SocialMediaProfiles Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| username | <code>string</code> | username. |
| provider | <code>string</code> | provider. |

<a name="PhoneInfo"></a>

## PhoneInfo : <code>Object</code>
PhoneInfo Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| _id | <code>string</code> | _id |
| brand | <code>string</code> | brand |
| deviceId | <code>string</code> | deviceId |
| deviceLocale | <code>string</code> | deviceLocale |
| timeZone | <code>string</code> | timeZone |
| timeStamp | <code>string</code> | timeStamp |
| isTablet | <code>boolean</code> | isTablet |

<a name="BrowserInfo"></a>

## BrowserInfo : <code>Object</code>
BrowserInfo Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| _id | <code>string</code> | _id |
| timeStamp | <code>string</code> | timeStamp |
| userAgent | <code>string</code> | userAgent |

<a name="PersonalData"></a>

## PersonalData : <code>Object</code>
PersonalData Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| firstName | <code>string</code> | firstName |
| lastName | <code>string</code> | lastName |
| gender | <code>string</code> | gender |
| yearOfBirth | <code>string</code> | yearOfBirth |
| countryOfResidence | <code>string</code> | countryOfResidence |
| nationality | <code>string</code> | nationality |
| socialMedia | [<code>Array.&lt;SocialMediaProfiles&gt;</code>](#SocialMediaProfiles) | socialMedia |

<a name="UserProfile"></a>

## UserProfile : <code>Object</code>
UserProfile Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| _id | <code>string</code> | _id |
| blockchainAddress | <code>string</code> | blockchainAddress |
| personalData | [<code>PersonalData</code>](#PersonalData) | personalData |
| phoneInfo | [<code>Array.&lt;PhoneInfo&gt;</code>](#PhoneInfo) | phoneInfo |
| browserInfo | [<code>Array.&lt;BrowserInfo&gt;</code>](#BrowserInfo) | browserInfo |

<a name="UserProfileResult"></a>

## UserProfileResult : <code>Object</code>
UserProfileResult Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| count | <code>number</code> | count |
| result | [<code>Array.&lt;UserProfile&gt;</code>](#UserProfile) | result |

<a name="NewOptIn"></a>

## NewOptIn : <code>Object</code>
NewOptIn Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| productOrService | <code>string</code> | productOrService. |
| optedInOn | <code>string</code> | optedInOn. |
| optedInIpAddress | <code>string</code> | optedInIpAddress. |
| optedInUserAgent | <code>string</code> | optedInUserAgent. |
| optedInFormUrl | <code>string</code> | optedInFormUrl. |

<a name="NewOptOut"></a>

## NewOptOut : <code>Object</code>
NewOptOut Type.

**Kind**: global typedef
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| productOrService | <code>string</code> | productOrService. |
| optedOutOn | <code>string</code> | optedOutOn. |
| optedOutIpAddress | <code>string</code> | optedOutIpAddress. |