common-model
Common-model is a utility that aims to be a shared package to facilitate data manipulation across different APIs.
Updating this README.md
Run npm run generateReadme
to parse the code for JSDoc comment blocks and recreate this README.md file.
Install
Run npm i @pillarwallet/common-models
Then npm i mongoose@5.x -E
Examples
Instantiate a model with options:
const options =
{
username: 'myUserName',
};
const { platform } = require('@pillarwallet/common-models');
// Create user model
const user = new platform.User(options);
API
Objects
-
AccessTokenBackup :
object
-
AccessTokenBackup model maps to a MongoDB collection and defines the shape of the document.
-
AccessTokenBlacklist :
object
-
AccessTokenBlacklist model maps to a MongoDB collection and defines the shape of the document.
-
Asset :
object
-
Asset model maps to a MongoDB collection and defines the shape of the document.
-
Badge :
object
-
Badge model maps to a MongoDB collection and defines the shape of the document.
-
BadgeAward :
object
-
BadgeAward model maps to a MongoDB collection and defines the shape of the document.
-
Blacklist :
object
-
Blacklist model maps to a MongoDB collection and defines the shape of the document.
-
BlacklistedUsernames :
object
-
BlacklistedUsernames model maps to a MongoDB collection and defines the shape of the document.
-
BtcDeposit :
object
-
BtcDeposit model maps to a MongoDB collection and defines the shape of the document.
-
Connection :
object
-
Connection model maps to a MongoDB collection and defines the shape of the document.
-
IpfsStorage :
object
-
IpfsStorage model maps to a MongoDB collection and defines the shape of the document.
-
Notification :
object
-
Notification model maps to a MongoDB collection and defines the shape of the document.
-
NotificationPreferences :
object
-
NotificationPreferences model maps to a MongoDB collection and defines the shape of the document.
-
NotificationType :
object
-
NotificationType model maps to a MongoDB collection and defines the shape of the document.
-
ReferralCampaign :
object
-
ReferralCampaign model maps to a MongoDB collection and defines the shape of the document.
-
ReferralDevice :
object
-
ReferralDevice model maps to a MongoDB collection and defines the shape of the document.
-
ReferralInvitation :
object
-
ReferralInvitation model maps to a MongoDB collection and defines the shape of the document.
-
ReferralTransaction :
object
-
ReferralTransaction model maps to a MongoDB collection and defines the shape of the document.
-
Register :
object
-
Register model
-
Story :
object
-
Story model maps to a MongoDB collection and defines the shape of the document.
-
StoryPage :
object
-
StoryPage model maps to a MongoDB collection and defines the shape of the document.
-
User :
object
-
User model maps to a MongoDB collection and defines the shape of the document.
-
UserFeatureFlags :
object
-
UserFeatureFlags model maps to a MongoDB collection and defines the shape of the document.
-
Wallet :
object
-
Wallet model maps to a MongoDB collection and defines the shape of the document.
object
AccessTokenBackup : AccessTokenBackup model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
AccessTokenBackup :
object
-
~userId :
String
-
~contactId :
String
-
~accessKey :
String
-
~userId :
String
AccessTokenBackup~userId : The user identifier.
Kind: inner property of AccessTokenBackup
Required:
String
AccessTokenBackup~contactId : The contact identifier.
Kind: inner property of AccessTokenBackup
Required:
String
AccessTokenBackup~accessKey : Unique identifier for each connection.
Kind: inner property of AccessTokenBackup
Required:
object
AccessTokenBlacklist : AccessTokenBlacklist model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
String
AccessTokenBlacklist~accessToken : A user's valid access token.
Kind: inner property of AccessTokenBlacklist
Required:
object
Asset : Asset model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Asset :
object
-
~address :
String
-
~decimals :
Number
-
~description :
String
-
~name :
String
-
~symbol :
String
-
~wallpaperUrl :
String
-
~iconUrl :
String
-
~iconMonoUrl :
String
-
~patternUrl :
String
-
~email :
String
~telegram~twitter-
~socialMedia :
Array
-
~website :
String
-
~whitepaper :
String
-
~isDefault :
Boolean
-
~isPreferred :
Boolean
-
~totalSupply :
String
-
~icos :
Array
-
~isSynthetixAsset :
Boolean
-
~address :
String
Asset~address : The smart contract address.
Kind: inner property of Asset
Unique:
Required:
Number
Asset~decimals : Refers to how divisible a token can be.
Kind: inner property of Asset
Required:
String
Asset~description : Simple description of one Token.
Kind: inner property of Asset
String
Asset~name : Name by which the token contract should be known.
Kind: inner property of Asset
Required:
Unique:
String
Asset~symbol : Symbol by which the token contract should be known, it is broadly equivalent to a stock ticker.
Kind: inner property of Asset
Required:
Unique:
String
Asset~wallpaperUrl : The token's predefined background image.
Kind: inner property of Asset
String
Asset~iconUrl : The token's predefined icon image.
Kind: inner property of Asset
String
Asset~iconMonoUrl : The token's predefined mono icon image.
Kind: inner property of Asset
String
Asset~patternUrl : The token's predefined icon image (bigger).
Kind: inner property of Asset
String
Asset~email : The token's email.
Kind: inner property of Asset
Asset~telegram
Deprecated
Kind: inner property of Asset
Asset~twitter
Deprecated
Kind: inner property of Asset
Array
Asset~socialMedia : The token's social media.
Kind: inner property of Asset
String
Asset~website : The token's website.
Kind: inner property of Asset
String
Asset~whitepaper : The token's whitepaper.
Kind: inner property of Asset
Boolean
Asset~isDefault : One flag to check if the Token is default on the wallet.
Kind: inner property of Asset
Boolean
Asset~isPreferred : A flag to indicate preferred tokens within the system.
Kind: inner property of Asset
String
Asset~totalSupply : Kind: inner property of Asset
Array
Asset~icos : Ico details of one Token.
Kind: inner property of Asset
Boolean
Asset~isSynthetixAsset : A boolean flag to indicate whether this is a Synthetix asset
Kind: inner property of Asset
object
Badge : Badge model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Badge :
object
-
~name :
String
-
~type :
String
-
~imageUrl :
String
-
~subtitle :
String
-
~description :
String
-
~selfAward :
Boolean
-
~name :
String
Badge~name : Name by which the badge should be known.
Kind: inner property of Badge
Required:
String
Badge~type : Badge type by which backend could find particular badge.
Kind: inner property of Badge
Required:
Unique:
String
Badge~imageUrl : Image url of the badge.
Kind: inner property of Badge
String
Badge~subtitle : Optional subtitle of the badge.
Kind: inner property of Badge
String
Badge~description : Simple description of one badge.
Kind: inner property of Badge
Boolean
Badge~selfAward : A flag to indicate if the badge could be self awarded.
Kind: inner property of Badge
object
BadgeAward : BadgeAward model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
BadgeAward :
object
-
~badge :
String
-
~badgeType :
String
-
~userId :
String
-
~walletId :
String
-
~badge :
String
BadgeAward~badge : Badge id.
Kind: inner property of BadgeAward
Required:
String
BadgeAward~badgeType : Badge type.
Kind: inner property of BadgeAward
Required:
String
BadgeAward~userId : User Id.
Kind: inner property of BadgeAward
Required:
String
BadgeAward~walletId : Wallet Id.
Kind: inner property of BadgeAward
Required:
object
Blacklist : Blacklist model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Blacklist :
object
-
~userId :
String
-
~targetUserId :
String
-
~userId :
String
Blacklist~userId : The user identifier.
Kind: inner property of Blacklist
Required:
String
Blacklist~targetUserId : The blacklisted user identifier.
Kind: inner property of Blacklist
Required:
object
BlacklistedUsernames : BlacklistedUsernames model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
String
BlacklistedUsernames~username : The blacklisted username.
Kind: inner property of BlacklistedUsernames
Unique:
Required:
object
BtcDeposit : BtcDeposit model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
BtcDeposit :
object
-
~status :
String
-
~nonce :
String
-
~txHash :
String
-
~ethereumTxHash :
String
-
~method :
String
-
~amount :
Number
-
~exchangeRate :
Number
-
~slippage :
Number
-
~sender :
String
-
~destination :
String
-
~gateway :
String
-
~nHash :
String
-
~signature :
String
-
~vOut :
Number
-
~confirmations :
Number
-
~status :
String
BtcDeposit~status : The status of the deposit [awaiting, received, submitted].
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~nonce : The nonce of the deposit.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~txHash : Hash of the transaction.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~ethereumTxHash : Hash of the ethereum transaction.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~method : The method [mint, burn].
Kind: inner property of BtcDeposit
Required:
Number
BtcDeposit~amount : The transaction amount.
Kind: inner property of BtcDeposit
Number
BtcDeposit~exchangeRate : The minimum exchange rate.
Kind: inner property of BtcDeposit
Number
BtcDeposit~slippage : The maximum slippage.
Kind: inner property of BtcDeposit
String
BtcDeposit~sender : The sender address.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~destination : The destination address.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~gateway : The gateway address.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~nHash : The deposit nhash.
Kind: inner property of BtcDeposit
Required:
String
BtcDeposit~signature : The deposit signature.
Kind: inner property of BtcDeposit
Required:
Number
BtcDeposit~vOut : The deposit vOut.
Kind: inner property of BtcDeposit
Required:
Number
BtcDeposit~confirmations : The number of confirmations.
Kind: inner property of BtcDeposit
Required:
object
Connection : Connection model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Connection :
object
-
~userId :
String
-
~accessKey :
String
-
~status :
String
-
~sourceIdentityKey :
String
-
~targetIdentityKey :
String
-
~targetUserId :
String
-
~direction :
String
-
~version :
String
-
~userId :
String
Connection~userId : The user identifier.
Kind: inner property of Connection
Required:
String
Connection~accessKey : Unique identifier for each connection.
Kind: inner property of Connection
Required:
String
Connection~status : The status of each connection.
Kind: inner property of Connection
Required:
String
Connection~sourceIdentityKey : The sourceIdentityKey of each connection.
Kind: inner property of Connection
Unique:
String
Connection~targetIdentityKey : The targetIdentityKey of each connection.
Kind: inner property of Connection
Unique:
String
Connection~targetUserId : The target user identifier.
Kind: inner property of Connection
String
Connection~direction : The direction of the connection.
Kind: inner property of Connection
String
Connection~version : Connections supoort version.
Kind: inner property of Connection
object
IpfsStorage : IpfsStorage model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
IpfsStorage :
object
-
~walletId :
String
-
~storageId :
String
-
~secretKey :
String
-
~walletId :
String
IpfsStorage~walletId : The id of the wallet.
Kind: inner property of IpfsStorage
Required:
String
IpfsStorage~storageId : The id of the IPFS storage.
Kind: inner property of IpfsStorage
Required:
Unique:
String
IpfsStorage~secretKey : Secret key for the IPFS storage.
Kind: inner property of IpfsStorage
Required:
Unique:
object
Notification : Notification model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Notification :
object
String
Notification~type : The type of one notification.
Kind: inner property of Notification
Required:
Object
Notification~meta : Additional important information about one notification.
Kind: inner property of Notification
Required:
Object
Notification~payload : The content of one notification.
Kind: inner property of Notification
Required:
object
NotificationPreferences : NotificationPreferences model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
NotificationPreferences :
object
-
~userId :
String
-
~newOffer :
Boolean
-
~newReceipt :
Boolean
-
~paymentConfirmation :
Boolean
-
~paymentStatusUpdate :
Boolean
-
~profileUpdate :
Boolean
-
~fundsDeposit :
Boolean
-
~transactionEvent :
Boolean
-
~userId :
String
NotificationPreferences~userId : The user identifier.
Kind: inner property of NotificationPreferences
Required:
Unique:
Boolean
NotificationPreferences~newOffer : One flag for newOffer notification.
Kind: inner property of NotificationPreferences
Required:
Boolean
NotificationPreferences~newReceipt : One flag for newReceipt notification.
Kind: inner property of NotificationPreferences
Required:
Boolean
NotificationPreferences~paymentConfirmation : One flag for paymentConfirmation notification.
Kind: inner property of NotificationPreferences
Required:
Boolean
NotificationPreferences~paymentStatusUpdate : One flag for paymentStatusUpdate notification.
Kind: inner property of NotificationPreferences
Required:
Boolean
NotificationPreferences~profileUpdate : One flag for profileUpdate notification.
Kind: inner property of NotificationPreferences
Required:
Boolean
NotificationPreferences~fundsDeposit : One flag for fundsDeposit notification.
Kind: inner property of NotificationPreferences
Required:
Boolean
NotificationPreferences~transactionEvent : One flag for transactionEvent notification.
Kind: inner property of NotificationPreferences
Required:
object
NotificationType : NotificationType model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
NotificationType :
object
String
NotificationType~type : The type of one notification.
Kind: inner property of NotificationType
Required:
Unique:
String
NotificationType~name : The name of one notification.
Kind: inner property of NotificationType
Required:
Object
NotificationType~actions : Actions related with one notification.
Kind: inner property of NotificationType
Required:
object
ReferralCampaign : ReferralCampaign model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
ReferralCampaign :
object
-
~name :
String
-
~token :
String
-
~contractAddress :
String
-
~wallet :
Object
-
~logoUrl :
String
-
~badges :
Boolean
-
~isActive :
Boolean
-
~relatedCampaigns :
[ 'Array' ].<String>
-
~name :
String
ReferralCampaign~name : Name of the campaign.
Kind: inner property of ReferralCampaign
Required:
Unique:
String
ReferralCampaign~token : Default token issued for the campaign.
Kind: inner property of ReferralCampaign
Required:
String
ReferralCampaign~contractAddress : Contract address of the default token.
Kind: inner property of ReferralCampaign
Required:
Object
ReferralCampaign~wallet : The reward wallet.
Kind: inner property of ReferralCampaign
Required:
String
ReferralCampaign~logoUrl : Logo URL to S3.
Kind: inner property of ReferralCampaign
Boolean
ReferralCampaign~badges : Flag indicating if the campaign should issue badges.
Kind: inner property of ReferralCampaign
Boolean
ReferralCampaign~isActive : Flag indicating if the campaign is active.
Kind: inner property of ReferralCampaign
[ 'Array' ].<String>
ReferralCampaign~relatedCampaigns : An array of related campaigns.
Kind: inner property of ReferralCampaign
object
ReferralDevice : ReferralDevice model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
ReferralDevice :
object
-
~deviceInfo :
String
-
~deviceOs :
String
-
~firstInstall :
String
-
~deviceInfo :
String
ReferralDevice~deviceInfo : Device info stored as checksum.
Kind: inner property of ReferralDevice
Unique:
Required:
String
ReferralDevice~deviceOs : Device OS.
Kind: inner property of ReferralDevice
Required:
String
ReferralDevice~firstInstall : Flag for first install.
Kind: inner property of ReferralDevice
Required:
object
ReferralInvitation : ReferralInvitation model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
ReferralInvitation :
object
Number
ReferralInvitation~amount : Default amount to reward.
Kind: inner property of ReferralInvitation
String
ReferralInvitation~userId : The user identifier of the inviter.
Kind: inner property of ReferralInvitation
Required:
String
ReferralInvitation~email : Email of the invited person.
Kind: inner property of ReferralInvitation
String
ReferralInvitation~phone : Phone of the invited person.
Kind: inner property of ReferralInvitation
Boolean
ReferralInvitation~claimed : Flag indicating if the user claimed the reward.
Kind: inner property of ReferralInvitation
String
ReferralInvitation~invitedUserId : The user identifier of the invited user.
Kind: inner property of ReferralInvitation
String
ReferralInvitation~token : Token generated by Platform-Core API, to validate Branch.io webhooks.
Kind: inner property of ReferralInvitation
Required:
Boolean
ReferralInvitation~partner : Flag indicating if it is a partner campaign.
Kind: inner property of ReferralInvitation
String
ReferralInvitation~campaign : The campaign identifier.
Kind: inner property of ReferralInvitation
Number
ReferralInvitation~amount : The amount to reward.
Kind: inner property of ReferralInvitation
Boolean
ReferralInvitation~notified : Flag indicating if the user has been notified when the campaign has been terminated.
Kind: inner property of ReferralInvitation
object
ReferralTransaction : ReferralTransaction model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
ReferralTransaction :
object
-
~name :
String
-
~ethAddress :
String
-
~txHash :
String
-
~amount :
Number
-
~asset :
String
-
~name :
String
ReferralTransaction~name : The status of the transaction [confirmed, failed].
Kind: inner property of ReferralTransaction
Required:
String
ReferralTransaction~ethAddress : Address of the user to be rewarded.
Kind: inner property of ReferralTransaction
Required:
String
ReferralTransaction~txHash : Hash of the transaction.
Kind: inner property of ReferralTransaction
Required:
Number
ReferralTransaction~amount : The amount of PLR for the reward.
Kind: inner property of ReferralTransaction
Required:
String
ReferralTransaction~asset : Asset symbol.
Kind: inner property of ReferralTransaction
object
Register : Register model
Kind: global namespace
-
Register :
object
-
~authorizationCode :
String
-
~nonce :
String
-
~nonceExpiry :
String
-
~publicKey :
String
-
~uuid :
String
-
~walletId :
String
-
~authorizationCode :
String
Register~authorizationCode : Authorisation code generated by platform-authentication
Kind: inner property of Register
String
Register~nonce : A one time code for a request between the wallet and platform-core
Kind: inner property of Register
Required:
String
Register~nonceExpiry : The expiry of the nonce
Kind: inner property of Register
Required:
String
Register~publicKey : The public key of a wallet
Kind: inner property of Register
Required:
String
Register~uuid : A random unique identifier used for the registration process
Kind: inner property of Register
Required:
String
Register~walletId : The ID of a wallet that's created as part of the registration flow
Kind: inner property of Register
object
Story : Story model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Story :
object
-
~shortTitle :
String
-
~imageUrl :
String
-
~imageMonoUrl :
String
-
~active :
Boolean
-
~topic :
String
-
~title :
String
-
~likes :
Number
-
~shortTitle :
String
Story~shortTitle : Short title of the story.
Kind: inner property of Story
Required:
String
Story~imageUrl : The story's preview image.
Kind: inner property of Story
String
Story~imageMonoUrl : The story's preview mono image.
Kind: inner property of Story
Boolean
Story~active : Flag to enable/disable the story preview.
Kind: inner property of Story
String
Story~topic : Topic for the story page.
Kind: inner property of Story
Required:
String
Story~title : Title of the story page.
Kind: inner property of Story
Required:
Number
Story~likes : Counter for the likes of a story page.
Kind: inner property of Story
object
StoryPage : StoryPage model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
StoryPage :
object
-
~storyId :
String
-
~pageNumber :
Number
-
~body :
String
-
~imageUrl :
String
-
~imageMonoUrl :
String
-
~layoutType :
String
-
~backgroundColor :
String
-
~textContrast :
String
-
~storyId :
String
StoryPage~storyId : ID of the story to which the page belongs.
Kind: inner property of StoryPage
Number
StoryPage~pageNumber : Number of the page in a story.
Kind: inner property of StoryPage
String
StoryPage~body : Body text of the story page.
Kind: inner property of StoryPage
String
StoryPage~imageUrl : The story's uploaded image.
Kind: inner property of StoryPage
String
StoryPage~imageMonoUrl : The story's uploaded mono image.
Kind: inner property of StoryPage
String
StoryPage~layoutType : Predefined layout type for the story page.
Kind: inner property of StoryPage
Required:
String
StoryPage~backgroundColor : Background color value.
Kind: inner property of StoryPage
String
StoryPage~textContrast : Text Contrast.
Kind: inner property of StoryPage
object
User : User model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
User :
object
-
~username :
String
-
~registrationId :
String
-
~firstName :
String
-
~lastName :
String
-
~email :
String
-
~isEmailVerified :
Boolean
-
~emailOneTimePassword :
String
-
~phone :
String
-
~isPhoneVerified :
Boolean
-
~phoneOneTimePassword :
String
-
~country :
String
-
~state :
String
-
~city :
String
-
~userSearchable :
Boolean
-
~tagline :
String
-
~taglineStatus :
Boolean
-
~profileImage :
String
-
~icoService :
Object
-
~status :
String
-
~secretId :
String
-
~betaProgramParticipant :
Boolean
-
~lastSeen :
Date
-
~username :
String
User~username : The username.
Kind: inner property of User
Required:
Unique:
String
User~registrationId : The user's registration Id.
Kind: inner property of User
String
User~firstName : The user's first name.
Kind: inner property of User
String
User~lastName : The user's last name.
Kind: inner property of User
String
User~email : The user's email.
Kind: inner property of User
Boolean
User~isEmailVerified : One flag to check user's email.
Kind: inner property of User
String
User~emailOneTimePassword : The user's email one time password.
Kind: inner property of User
String
User~phone : The user's phone.
Kind: inner property of User
Boolean
User~isPhoneVerified : One flag to check user's phone.
Kind: inner property of User
String
User~phoneOneTimePassword : The user's phone one time password.
Kind: inner property of User
String
User~country : The user's country.
Kind: inner property of User
String
User~state : The user's state.
Kind: inner property of User
String
User~city : The user's city.
Kind: inner property of User
Boolean
User~userSearchable : One flag to check if user is searchable.
Kind: inner property of User
String
User~tagline : The user's tagline.
Kind: inner property of User
Boolean
User~taglineStatus : One flag to check if user's tagline is displayable.
Kind: inner property of User
String
User~profileImage : The user's profileImage.
Kind: inner property of User
Object
User~icoService : Information related to the user's account with a service provider for ICOs.
Kind: inner property of User
String
User~status : The user status in the system.
Kind: inner property of User
String
User~secretId : The user secretId.
Kind: inner property of User
Required:
Boolean
User~betaProgramParticipant : One flag to check if user is beta program participant.
Kind: inner property of User
Date
User~lastSeen : A timestamp with user last activity
Kind: inner property of User
object
UserFeatureFlags : UserFeatureFlags model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
UserFeatureFlags :
object
-
~userId :
String
-
~smartWallet :
Boolean
-
~bitcoin :
Boolean
-
~userId :
String
UserFeatureFlags~userId : The user identifier.
Kind: inner property of UserFeatureFlags
Required:
Unique:
Boolean
UserFeatureFlags~smartWallet : One flag for Smart Wallet support.
Kind: inner property of UserFeatureFlags
Boolean
UserFeatureFlags~bitcoin : One flag for Bitcoin support.
Kind: inner property of UserFeatureFlags
object
Wallet : Wallet model maps to a MongoDB collection and defines the shape of the document.
Kind: global namespace
Param |
---|
schema |
-
Wallet :
object
-
~publicKey :
String
-
~userId :
String
-
~ethAddress :
String
-
~fcmToken :
String
-
~signalRegistrationId :
String
-
~bcxRegistered :
Boolean
-
~blocknativeRegistered :
Boolean
-
~type :
String
-
~disabled :
Boolean
-
~recovery :
Boolean
-
~publicKey :
String
Wallet~publicKey : The public Key of one user.
Kind: inner property of Wallet
Required:
String
Wallet~userId : The user identifier.
Kind: inner property of Wallet
Required:
String
Wallet~ethAddress : The ethereum address of one user.
Kind: inner property of Wallet
Required:
Unique:
String
Wallet~fcmToken : The fcm identifier of one user.
Kind: inner property of Wallet
String
Wallet~signalRegistrationId : The user's signal identifier.
Kind: inner property of Wallet
Boolean
Wallet~bcxRegistered : One flag to check BCX registration.
Kind: inner property of Wallet
Boolean
Wallet~blocknativeRegistered : One flag to check Blocknative address registration.
Kind: inner property of Wallet
String
Wallet~type : The type of the wallet.
Kind: inner property of Wallet
Boolean
Wallet~disabled : A flag indicating if the wallet is disabled or not.
Kind: inner property of Wallet
Required:
Boolean
Wallet~recovery : A flag indicating if the wallet is recovery wallet or not.
Kind: inner property of Wallet
Required: