Leal TypeScript SDK

Install

npm install @lealhq/leal

Your first call

Create a token at app.getleal.com/api_tokens, keep it in an environment variable, and hand it to the client once. Every request after that carries it for you.

import { LealClient } from "@lealhq/leal";

const leal = new LealClient({ token: process.env.LEAL_API_TOKEN });

const stores = await leal.stores.list();
console.log(stores[0].name);

A token reaches every store its owner belongs to. There is no separate sandbox yet, so build against a store you do not mind changing.

Common tasks

const customer = await leal.customers.create({
  account_id: storeId,
  customer: { first_name: "Ada", email: "ada@example.com" },
  card_id: cardId,
});

const card = customer.customer_cards[0];
console.log(card.apple_wallet_url, card.google_wallet_url);

const card = await leal.customerCards.stamp({
  account_id: storeId,
  customer_id: customerId,
  id: customerCardId,
  stamps: 1,
});

console.log(`${card.stamps_remaining} stamps to the next reward`);

await leal.customerCards.redeem({
  account_id: storeId,
  customer_id: customerId,
  id: customerCardId,
  reward_id: rewardId,
});

import { LealError } from "@lealhq/leal";

try {
  await leal.customerCards.stamp({ account_id: storeId, customer_id: customerId, id: customerCardId, stamps: 1 });
} catch (error) {
  if (error instanceof LealError && error.statusCode === 429) {
    // Wait for the number of seconds in the Retry-After header, then try again.
  }
  throw error;
}

Every endpoint is available, not just these. The TypeScript repository lists them all, and the API reference documents each field.

Rate limits and retries

Leal allows 300 requests per minute per API token. The client retries a failed request on its own, backing off between attempts, so a brief wobble does not need handling in your code. Go past the limit and you get a 429 carrying Retry-After in seconds. If you need a higher limit, ask us.