Rise TypeScript SDK

The Rise TypeScript SDK provides convenient access to the Rise Platform API from TypeScript and JavaScript applications.

Installation

npm install rise-ai-sdk

Prerequisites

Before using the Rise TypeScript SDK, ensure you have the following:

Choosing an Authentication Method

• Use API keys for server-side applications and scripts that require direct access to your Rise account.
• Use OAuth for applications that need to integrate with multiple merchant accounts or require delegated access.

Runtime Requirements

• Node.js 16 or higher - The SDK requires Node.js version 16.0.0 or later.

Authentication

The SDK supports two authentication methods:

API Key Authentication

• API Key - A valid API key from your Rise account
• Account ID - Your Rise account identifier

OAuth Authentication

• Client ID - Your application's client ID (also known as App ID)
• Client Secret - Your application's client secret
• Instance ID - The merchant's instance ID (obtained during app installation)
• OAuth tokens are valid for 4 hours and automatically refresh
• Requires completing the app installation flow

For more information on OAuth authentication and the app installation flow, see the Rise Platform Documentation.

Reference

A full API reference for this library is available here.

Usage

API Key Authentication

import { RiseSDKClient } from 'rise-ai-sdk';

const sdk = RiseSDKClient.withApiKey({
  token: 'IST.xxx.yyy.zzz',
  accountId: 'your-account-id'
});

OAuth Authentication

OAuth tokens are valid for 4 hours.

import { RiseSDKClient } from 'rise-ai-sdk';

const sdk = await RiseSDKClient.withOAuth({
  clientId: 'your-app-id',
  clientSecret: 'your-app-secret',
  instanceId: 'instance-id'
});

API Overview

The SDK provides access to the following APIs:

Gift Cards

Manage gift cards, including creating, retrieving, and querying gift cards.

const newCard = await sdk.giftCards.createGiftCard({
  giftCard: {
    initialValue: '100',
    sourceInfo: {
        type: 'MANUAL',
        manualOptions: {
            note: 'new gift card'
        }
    }
  }
});

const newGeneratedGiftcardID = newCard.data.giftCard?.id;

const newGeneratedGiftcard = await sdk.giftCards.getGiftCard(newGeneratedGiftcardID);

const cards = await sdk.giftCards.queryGiftCards({
  query: {
    cursorPaging: {
        limit: 10
    }
  }
});

Wallets

Manage customer wallets and their associated gift cards.

const wallet = await sdk.wallets.getOrCreateWallet({
  customerReference: {
    email: '[email protected]',
    sourceChannelId: 'channel-id',
    sourceTenantId: 'tenant-id',
    sourceCustomerId: 'customer-id'
  }
});

const wallets = await sdk.wallets.queryWallets({
    query: {
      paging: {
        limit: 10
      }
    }
});

Wallet Actions

Manage wallet actions such as issuing store credit, rewards, and refunds.

const action = await sdk.walletActions.createWalletAction({
  walletAction: {
    walletId: 'wallet-id',
    amount: '5000',
    type: 'REWARD',
    storeCreditContext: {
        sourceChannelId: 'channel-id',
        sourceTenantId: 'tenant-id'
    }
  }
});

const actions = await sdk.walletActions.queryWalletActions({
  query: {
    paging: {
      limit: 10
    }
  }
});

Recipients

Manage gift card recipients.

const recipient = await sdk.recipients.createRecipient({
  recipient: {
    email: '[email protected]',
    name: 'John Doe',
    giftCardId: 'giftcard-id'
  }
});

const recipients = await sdk.recipients.queryRecipients({
  query: {
    cursorPaging: {
        limit: 5
    }
  }
});

Transactions

Query transaction history.

const transactions = await sdk.transactions.queryTransactions({
    query: {
        cursorPaging: {
            limit: 5
        }
    }
});