platform-types 1.10.842 → 1.10.844
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/customer.d.ts +16 -0
- package/dist/maintenance.d.ts +11 -11
- package/dist/userActivity.d.ts +2 -2
- package/package.json +1 -1
package/dist/customer.d.ts
CHANGED
|
@@ -1704,6 +1704,22 @@ declare global {
|
|
|
1704
1704
|
* Operator wire only — the storefront response omits both.
|
|
1705
1705
|
*/
|
|
1706
1706
|
purchaseWithdrawalEraseComplete?: boolean;
|
|
1707
|
+
/**
|
|
1708
|
+
* RETURN and PURCHASE_WITHDRAWAL rows of this customer (or of an id folded
|
|
1709
|
+
* into it) whose credit-note voucher fingerprint (`ncAttempt.voucher`, which
|
|
1710
|
+
* carries the buyer document) this erasure REMOVEd. The rows, their credit
|
|
1711
|
+
* notes and the rest of the marker are kept. Both wires carry it, the
|
|
1712
|
+
* storefront's included: it counts the subject's own rows and no
|
|
1713
|
+
* operator-written text. Optional only so the field is additive.
|
|
1714
|
+
*/
|
|
1715
|
+
creditNoteMarkersErased?: number;
|
|
1716
|
+
/**
|
|
1717
|
+
* `false` when those rows could not be read or written to the end, so a
|
|
1718
|
+
* buyer document may remain. Re-issuing the erasure re-runs the step; BOTH
|
|
1719
|
+
* erasure handlers write a deduped `ERROR` row
|
|
1720
|
+
* (`CUSTOMER_ANONYMIZE_CREDIT_NOTE_MARKER_INCOMPLETE`).
|
|
1721
|
+
*/
|
|
1722
|
+
creditNoteMarkerEraseComplete?: boolean;
|
|
1707
1723
|
/**
|
|
1708
1724
|
* Storefront quote requests the subject sent signed in
|
|
1709
1725
|
* (`QUOTEREQUEST#{storeId}`), DELETED by this erasure — the whole row goes:
|
package/dist/maintenance.d.ts
CHANGED
|
@@ -16,14 +16,14 @@ declare global {
|
|
|
16
16
|
endsAt?: number;
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* A channel a maintenance broadcast can
|
|
19
|
+
* A channel a maintenance broadcast can leave the platform on.
|
|
20
20
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
21
|
+
* `'whatsapp'` is the platform's own WhatsApp number (a Meta-approved utility
|
|
22
|
+
* template). A stage with no sender configured for a channel refuses a
|
|
23
|
+
* broadcast naming it — `422 BROADCAST_CHANNEL_NOT_CONFIGURED`, before any
|
|
24
|
+
* claim or send — rather than counting messages nothing would deliver.
|
|
25
25
|
*/
|
|
26
|
-
type MaintenanceBroadcastChannel = 'email' | 'sms';
|
|
26
|
+
type MaintenanceBroadcastChannel = 'email' | 'sms' | 'whatsapp';
|
|
27
27
|
/**
|
|
28
28
|
* Per-user, per-channel opt-in for outbound platform broadcasts.
|
|
29
29
|
*
|
|
@@ -36,9 +36,9 @@ declare global {
|
|
|
36
36
|
*
|
|
37
37
|
* Absent key means the channel's DEFAULT applies, never `false`:
|
|
38
38
|
* `email` defaults ON for a user holding an admin-capable role and OFF for
|
|
39
|
-
* everyone else, and `sms`
|
|
40
|
-
* backfilling, and a store that has never opened the preference screen
|
|
41
|
-
* reaches its admins by email and nobody
|
|
39
|
+
* everyone else, and `sms` and `whatsapp` default OFF for everyone. So no row
|
|
40
|
+
* needs backfilling, and a store that has never opened the preference screen
|
|
41
|
+
* still reaches its admins by email and nobody on a handset.
|
|
42
42
|
*/
|
|
43
43
|
type UserBroadcastChannels = Partial<Record<MaintenanceBroadcastChannel, boolean>>;
|
|
44
44
|
/** `POST /platform/operations { mode: 'maintenance-broadcast' }`. */
|
|
@@ -76,8 +76,8 @@ declare global {
|
|
|
76
76
|
*
|
|
77
77
|
* ⚠️ It is still `queued`, NOT `delivered`, and the two diverge for reasons
|
|
78
78
|
* that live past the queue: a bounced or complained address is dropped by
|
|
79
|
-
* `sendEmail`'s suppression check, and the SMS
|
|
80
|
-
* consumer already accepted. Demo tenants are the one such filter pulled
|
|
79
|
+
* `sendEmail`'s suppression check, and the SMS or WhatsApp provider can
|
|
80
|
+
* reject a send the consumer already accepted. Demo tenants are the one such filter pulled
|
|
81
81
|
* FORWARD of the queue — they are excluded from enumeration entirely — so
|
|
82
82
|
* that a fleet-wide count is not inflated by tenants whose every message the
|
|
83
83
|
* transports would silently discard.
|
package/dist/userActivity.d.ts
CHANGED
|
@@ -991,8 +991,8 @@ declare global {
|
|
|
991
991
|
reason?: string;
|
|
992
992
|
}
|
|
993
993
|
/**
|
|
994
|
-
* A maintenance announcement that actually LEFT the platform — email
|
|
995
|
-
*
|
|
994
|
+
* A maintenance announcement that actually LEFT the platform — email, SMS
|
|
995
|
+
* and/or WhatsApp, per {@link MaintenanceBroadcastChannel}.
|
|
996
996
|
*
|
|
997
997
|
* ⚠️ Sibling of `PlatformMaintenanceToggledEvent`, never a replacement for
|
|
998
998
|
* it. The toggle changes what the product does; this records that people
|