@buclepay/node 0.1.0 → 0.1.1

package/README.md

@@ -37,11 +37,11 @@ app.post('/webhooks/buclepay', express.raw({ type: 'application/json' }), (req,
 
 ## bucleScore: reward your best customers
 
-Each payer has a bucleScore built from all their payments on buclePay. **You never see the score or the history.** You see the customer's **level (1–4)** only if they chose to show it to you, and you use it to give rewards: discounts (1–50%), free charges (1–3), gifts, priority or early access.
+Each payer has a bucleScore built from all their payments on buclePay. **You never see the score or the history.** You see the customer's **level**: Spark, Glow, Shine or Star (1–4) only if they chose to show it to you, and you use it to give rewards: discounts (1–50%), free charges (1–3), gifts, priority or early access.
 
 ```js
 await bp.perks.create({ min_level: 3, kind: 'discount_pct', value: 10, title: '10% off your renewal' });
-const { data } = await bp.customers.perks('cus_…'); // { level_shared, level, perks }
+const { data } = await bp.customers.perks('cus_…'); // { level_shared, level: 3, level_name: 'Shine', perks }
 ```
 
 The level is for rewards only. Never use it to deny service, ask for deposits, offer credit or installments, or charge differently.

package/index.d.ts

@@ -72,9 +72,11 @@ export interface BuclePayEvent {
 }
 
 export type PerkKind = 'discount_pct' | 'free_period' | 'gift' | 'priority' | 'early_access' | 'custom';
-export interface Perk { id: string; object: 'perk'; min_level: 1 | 2 | 3 | 4; kind: PerkKind; value: number | null; title: string }
+/** bucleScore levels: 1 Spark · 2 Glow · 3 Shine · 4 Star. */
+export type LevelName = 'Spark' | 'Glow' | 'Shine' | 'Star';
+export interface Perk { id: string; object: 'perk'; min_level: 1 | 2 | 3 | 4; min_level_name: LevelName; kind: PerkKind; value: number | null; title: string }
 export interface PerkParams { min_level: 1 | 2 | 3 | 4; kind: PerkKind; /** discount_pct 1–50 · free_period 1–3 · the rest take no value */ value?: number; title: string }
-export interface CustomerPerks { object: 'customer_perks'; customer: string; /** the customer agreed to show you their level */ level_shared: boolean; level: 1 | 2 | 3 | 4 | null; perks: Perk[] }
+export interface CustomerPerks { object: 'customer_perks'; customer: string; /** the customer agreed to show you their level */ level_shared: boolean; level: 1 | 2 | 3 | 4 | null; level_name: LevelName | null; perks: Perk[] }
 
 export class BuclePay {
   constructor(apiKey: string, opts?: { baseUrl?: string; timeoutMs?: number; fetch?: typeof fetch });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buclepay/node",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "buclePay for Node: create payment links, read subscriptions, verify webhooks and manage bucleScore rewards. No dependencies.",
   "type": "module",
   "main": "./index.js",