platform-types 1.10.857 → 1.10.858

package/dist/auditEnvelope.d.ts

@@ -1,5 +1,5 @@
 declare global {
-    type EntityAuditEntity = 'PLAN' | 'STORE' | 'PAYMENT' | 'ORDER' | 'MERCADOPAGO' | 'INVOICE' | 'SUBSCRIPTION' | 'USER' | 'CUSTOMER' | 'INTEGRATION' | 'PLATFORM';
+    type EntityAuditEntity = 'PLAN' | 'STORE' | 'PAYMENT' | 'ORDER' | 'MERCADOPAGO' | 'INVOICE' | 'SUBSCRIPTION' | 'USER' | 'CUSTOMER' | 'INTEGRATION' | 'PLATFORM' | 'MSG_PACK';
     /** Existing business fields with independently projected public metadata. */
     interface EntityAuditHttpEntry {
         entity: EntityAuditEntity;

package/dist/cjs/messaging.js

@@ -8,7 +8,7 @@
  * modification, or distribution is strictly prohibited.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.STORE_MESSAGE_SKIP_REASONS = exports.STORE_MESSAGE_STATUSES = exports.MESSAGE_DELIVERY_STAMPS = exports.MESSAGE_LEDGER_KINDS = exports.MESSAGE_CREDITS_PER_CHANNEL = exports.MESSAGE_ALLOWANCE_UNLIMITED = exports.SMS_FALLBACK_CREDITS = exports.WHATSAPP_MESSAGE_CREDITS = exports.MESSAGE_LEDGER_OPERATOR_ONLY_FIELDS = void 0;
+exports.STORE_MESSAGE_SKIP_REASONS = exports.STORE_MESSAGE_STATUSES = exports.MESSAGE_DELIVERY_STAMPS = exports.MESSAGE_PACK_CURRENCY = exports.MESSAGE_LEDGER_KINDS = exports.MESSAGE_CREDITS_PER_CHANNEL = exports.MESSAGE_ALLOWANCE_UNLIMITED = exports.SMS_FALLBACK_CREDITS = exports.WHATSAPP_MESSAGE_CREDITS = exports.MESSAGE_LEDGER_OPERATOR_ONLY_FIELDS = void 0;
 /**
  * Fields a store's own ledger read drops from an `adjustment` entry: it is a
  * platform operator act, and its `actor`, `reason` and `refId` (the
@@ -41,7 +41,10 @@ exports.MESSAGE_LEDGER_KINDS = [
     'allowance-grant',
     'purchase',
     'adjustment',
+    'reversal',
 ];
+/** `MessagePack.currency` — the only one a pack is sold in. */
+exports.MESSAGE_PACK_CURRENCY = 'ARS';
 exports.MESSAGE_DELIVERY_STAMPS = [
     'delivered',
     'read',

package/dist/messaging.d.ts

@@ -14,8 +14,12 @@ declare global {
      * - `adjustment` — a MANAGER/SUPERVISOR correction of the bought balance,
      *   either sign, with `actor` and `reason` — operator-only, with its `refId`:
      *   the store's own ledger read drops them (`MESSAGE_LEDGER_OPERATOR_ONLY_FIELDS`).
+     * - `reversal` — a pack payment refunded or charged back: the credits its
+     *   `purchase` added are taken back (`credits` < 0, `refId` the provider
+     *   payment id). Credits already spent are not refused: the bought balance
+     *   goes below zero by the rest, and only this kind can take it there.
      */
-    type MessageLedgerKind = 'debit' | 'refund' | 'allowance-grant' | 'purchase' | 'adjustment';
+    type MessageLedgerKind = 'debit' | 'refund' | 'allowance-grant' | 'purchase' | 'adjustment' | 'reversal';
     /**
      * How a debited message ended, stamped on its `debit` entry by the sending
      * pipeline — the ONE field written after the entry lands. Absent means
@@ -51,7 +55,7 @@ declare global {
         /** The allowance period (`YYYY-MM`, Buenos Aires) the entry was written in. */
         period: string;
         createdAt: number;
-        /** The reservation a `debit`/`refund` belongs to, the purchase id, or the adjustment id. */
+        /** The reservation a `debit`/`refund` belongs to, the purchase id, the adjustment id, or a `reversal`'s payment id. */
         refId?: string;
         /** `debit` and `refund` only. */
         noticeType?: StoreMessageNotice;
@@ -71,7 +75,12 @@ declare global {
     }
     /** The store's credits right now, the period already rolled forward when it has ended. */
     interface MessageBalanceView {
-        /** Bought credits, never below zero. */
+        /**
+         * Bought credits. Below zero only after a pack payment was reversed when
+         * its credits were already spent (`reversal`): then nothing more is
+         * spent from it until a purchase brings it back up, and `available`
+         * counts it as `0`.
+         */
         balance: number;
         /** The current allowance period (`YYYY-MM`, Buenos Aires). */
         period: string;
@@ -80,7 +89,7 @@ declare global {
         allowanceUsed: number;
         /** `max(0, allowanceLimit - allowanceUsed)`; `-1` when unlimited. */
         allowanceLeft: number;
-        /** `allowanceLeft + balance` — what the next messages can spend; `-1` when unlimited. */
+        /** `allowanceLeft + max(0, balance)` — what the next messages can spend; `-1` when unlimited. */
         available: number;
     }
     /** One page of the ledger, newest first. `cursor` present only when more may follow. */
@@ -209,6 +218,74 @@ declare global {
         serviceOrderId?: string;
         messageNotices: MessageNoticeListItem[];
     }
+    /**
+     * One message pack of the platform catalogue (`MSG_PACK` / `PACK00n`), as a
+     * MANAGER reads it on `GET /platform/billing/message-packs`. Prices are the
+     * operator's: a reprice is a `PATCH`, never a release. A pack already paid
+     * keeps the credits it was bought with — the checkout freezes them.
+     */
+    interface MessagePack {
+        /** `PACK001`, `PACK002`, … — minted on create, never reused. */
+        packId: string;
+        name: string;
+        /** Whole credits the pack adds to the bought balance, 1–1 000 000. */
+        credits: number;
+        /** The price in centavos, at least 1 (MercadoPago refuses a zero price). */
+        priceCents: number;
+        currency: MessagePackCurrency;
+        /** An inactive pack is not listed to stores and cannot be checked out. */
+        active: boolean;
+        /** Ascending order on the store's list. */
+        displayOrder: number;
+        createdAt: number;
+        updatedAt: number;
+    }
+    /** The only currency a pack is sold in. */
+    type MessagePackCurrency = 'ARS';
+    /** A pack as a STORE reads it (`GET /message-credits?mode=packs`): active packs only, no bookkeeping. */
+    interface StoreMessagePack {
+        packId: string;
+        name: string;
+        credits: number;
+        priceCents: number;
+        currency: MessagePackCurrency;
+        displayOrder: number;
+    }
+    /** `POST /platform/billing/message-packs` (managerToken). */
+    interface MessagePackCreateRequest {
+        name: string;
+        credits: number;
+        priceCents: number;
+        /** Defaults to `ARS`, the only value accepted. */
+        currency?: MessagePackCurrency;
+        /** Defaults to `true`. */
+        active?: boolean;
+        /** Defaults to `0`. */
+        displayOrder?: number;
+        /** 10–500 characters, no personal data — lands on the permanent `AUDIT#MSG_PACK#` row. */
+        reason: string;
+    }
+    /** `PATCH /platform/billing/message-packs/{packId}` (managerToken): at least one field besides `reason`. */
+    interface MessagePackUpdateRequest {
+        name?: string;
+        credits?: number;
+        priceCents?: number;
+        active?: boolean;
+        displayOrder?: number;
+        /** 10–500 characters, no personal data — lands on the permanent `AUDIT#MSG_PACK#` row. */
+        reason: string;
+    }
+    /** `POST /subscription/message-packs/checkout` (adminToken). */
+    interface MessagePackCheckoutRequest {
+        packId: string;
+        successUrl: string;
+        cancelUrl: string;
+    }
+    /** The MercadoPago Checkout the store pays the pack on; redirect to `initPoint`. */
+    interface MessagePackCheckoutResult {
+        initPoint: string;
+        preferenceId: string;
+    }
     interface MessageCreditAdjustmentResult {
         storeId: string;
         /** The `adjustment` ledger entry. */
@@ -241,7 +318,9 @@ export declare const MESSAGE_CREDITS_PER_CHANNEL: {
     readonly whatsapp: 1;
     readonly sms: 3;
 };
-export declare const MESSAGE_LEDGER_KINDS: readonly ["debit", "refund", "allowance-grant", "purchase", "adjustment"];
+export declare const MESSAGE_LEDGER_KINDS: readonly ["debit", "refund", "allowance-grant", "purchase", "adjustment", "reversal"];
+/** `MessagePack.currency` — the only one a pack is sold in. */
+export declare const MESSAGE_PACK_CURRENCY: "ARS";
 export declare const MESSAGE_DELIVERY_STAMPS: readonly ["delivered", "read", "failed"];
 export declare const STORE_MESSAGE_STATUSES: readonly ["queued", "sending", "sent", "delivered", "read", "failed", "undelivered", "skipped"];
 export declare const STORE_MESSAGE_SKIP_REASONS: readonly ["switched-off", "no-consent", "no-phone", "no-credits", "not-configured", "messaging-disabled"];

package/dist/messaging.js

@@ -38,7 +38,10 @@ export const MESSAGE_LEDGER_KINDS = [
     'allowance-grant',
     'purchase',
     'adjustment',
+    'reversal',
 ];
+/** `MessagePack.currency` — the only one a pack is sold in. */
+export const MESSAGE_PACK_CURRENCY = 'ARS';
 export const MESSAGE_DELIVERY_STAMPS = [
     'delivered',
     'read',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "platform-types",
-	"version": "1.10.857",
+	"version": "1.10.858",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",