TypeScript SDK

npm install @perkstar/api-client

import { PerkstarClient } from "@perkstar/api-client";

const perkstar = new PerkstarClient({
  apiKey: process.env.PERKSTAR_API_KEY!,
  userAgent: "MyOdooConnector/1.0",
});

const context = await perkstar.marketplace.ping();
console.log(context.data.organization.name);

const perkstar = new PerkstarClient({
  oauthAccessToken: accessToken,
});

const result = await perkstar.marketplace.accrue(
  {
    identifier: { external_ref: "odoo:4:partner:981" },
    card_id: "card_123",
    transaction: {
      type: "STAMP",
      delta: 1,
      external_transaction_id: "odoo:4:pos_order:94721",
    },
  },
  {
    idempotencyKey: "odoo:4:pos_order:94721:loyalty",
  },
);

console.log(result.enrollment.balance);

for await (const customer of perkstar.customers.list({ limit: 100 })) {
  await syncCustomer(customer);
}

import {
  PerkstarRateLimitError,
  PerkstarValidationError,
} from "@perkstar/api-client";

try {
  await postLoyalty();
} catch (error) {
  if (error instanceof PerkstarValidationError) {
    console.error(error.code, error.requestId);
    return;
  }
  if (error instanceof PerkstarRateLimitError) {
    throw error; // let the durable job retry later
  }
  throw error;
}

import { verifyWebhookSignature } from "@perkstar/api-client/webhooks";

const event = verifyWebhookSignature({
  payload: rawBody,
  signature: signatureHeader,
  secret: process.env.PERKSTAR_WEBHOOK_SECRET!,
});