@mojito-inc/loyalty-cli

🧪 Mojito Loyalty CLI

@mojito-inc/loyalty-cli is a command-line tool to interact with the Mojito Loyalty Platform.
It supports authentication, mission & reward handling, claims, redemptions, and leaderboard queries – all from your terminal.

• 🔗 https://getmojito.com/loyalty
• 📚 Docs: https://loyaltydocs.getmojito.com/
• 📧 Support: [e-mail]

📦 Installation

• Before installing, make sure Node.js is available in your system.

  Install Node.js:
  https://nodejs.org/en/download/

  Verify installation:

  node -v
  npm -v 
  

• Install CLI:

  npm install @mojito-inc/loyalty-cli
  

• Install CLI (If globally required):

  npm install -g @mojito-inc/loyalty-cli
  

• Run the CLI:

  Once installed successfully, you can access the CLI tool via mojito loyalty in your terminal.

  mojito-loyalty --help
  

⚙️ Global Options

You can specify the environment using:

--env <env>  Specify environment: dev, staging, sandbox, or prod (default: prod)

🔑 Authentication Commands

fetchSignMessage

Fetch the sign message for a user:

mojito-loyalty fetchSignMessage <walletAddress> -k <apiKey>

generateJWT

Generate a JWT token:

mojito-loyalty generateJWT <walletAddress> <signature> <message> -k <apiKey>

🎯 Mission Commands

getMissions

Fetch missions for a user:

mojito-loyalty getMissions <tenantId> <user_reference> -k <apiKey> [options]

Options:

• --status <status>: Mission status (default: AVAILABLE)
• --missionId <id>
• --sortBy <field>: Sort field (default: created_at)
• --order <asc|desc>: Sort order (default: desc)
• --limit <n>: Number of results (default: 10)
• --offset <n>: Pagination offset (default: 0)

fetchMission

Fetch mission details by ID:

mojito-loyalty fetchMission <missionId> -k <apiKey>

🧾 Claim Commands

initiateClaim

Initiate a claim process:

mojito-loyalty initiateClaim <missionId> <userReference> -k <apiKey>

getClaimStatus

Get claim status:

mojito-loyalty getClaimStatus <tenantId> <missionId> <userId> <claimId> -k <apiKey>

🎁 Reward Commands

getRewards

Fetch rewards for a user:

mojito-loyalty getRewards <tenantId> <user_reference> -k <apiKey> [options]

Options:

• --status <status> (default: AVAILABLE)
• --sortBy <field> (default: created_at)
• --order <asc|desc> (default: desc)
• --limit <n> (default: 10)
• --offset <n> (default: 0)

fetchReward

Fetch reward details by ID:

mojito-loyalty fetchReward <rewardId> -k <apiKey>

initiateReward

Initiate reward redemption:

mojito-loyalty initiateReward <rewardId> <userReference> <walletAddress> -k <apiKey>

getRedeemStatus

Fetch reward redemption status:

mojito-loyalty getRedeemStatus <tenantId> <rewardId> <userId> <redeemId> -k <apiKey>

🧮 User Credits

getUserCredits

Get user’s available credit points:

mojito-loyalty getUserCredits <tenantId> <user_reference> -k <apiKey>

🏆 Leaderboard

getLeaderboard

Fetch leaderboard data:

mojito-loyalty getLeaderboard <tenantId> -k <apiKey> [options]

Options:

• --sort <field> (default: Points)
• --date-range <range> (default: ALLTIME)
• --limit <n> (default: 10)
• --offset <n> (default: 0)

💳 Transactions

getTransactions

Fetch user transaction history:

mojito-loyalty getTransactions <tenantId> <userReference> -k <apiKey> [options]

Options:

• --date-range <range> (default: ALLTIME)
• --limit <n> (default: 10)
• --offset <n> (default: 0)

📞 Support

• Docs: https://loyaltydocs.getmojito.com/
• Email: [e-mail]