platform-types 1.10.826 → 1.10.827

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.
@@ -143,7 +143,8 @@ declare global {
143
143
  * `purchase-withdrawal-received` mail is queued after the commit and
144
144
  * stamps `emailQueuedAt`, and the mail worker records `emailStatus`:
145
145
  * `sent`, or `not-sent` when the order's customer has no address to mail
146
- * or the send was refused for good (a suppressed address included).
146
+ * or the send was refused for good (a suppressed address included), or
147
+ * when an operator decided the request before the mail went out.
147
148
  */
148
149
  interface PurchaseWithdrawalAcknowledgement {
149
150
  /** Unix ms. */
package/dist/rma.d.ts CHANGED
@@ -144,6 +144,14 @@ declare global {
144
144
  warrantyEndsAt?: StatutoryInstant;
145
145
  /** The store's change-of-mind terms as they stood when requested. Set only on a `change-of-mind` request. */
146
146
  changeOfMind?: RmaChangeOfMindTerms;
147
+ /**
148
+ * Set only on a `shopper` request, in its create transaction (`shownAt`);
149
+ * the `return-request-received` mail then stamps `emailQueuedAt` and its
150
+ * worker `emailStatus`. Absent on an operator request, which mails nothing,
151
+ * and on a shopper request opened before the acknowledgement shipped — a
152
+ * missing `acknowledgement` is not an unsent one.
153
+ */
154
+ acknowledgement?: ReturnRequestAcknowledgement;
147
155
  /** Lowercase, rebuilt on every write. A row missing it is invisible to search. */
148
156
  search?: string;
149
157
  createdAt: number;
@@ -219,6 +227,15 @@ declare global {
219
227
  type RmaSource = (typeof RMA_SOURCES)[number];
220
228
  /** The flows a shopper's own return request can land in. */
221
229
  type ShopperReturnRequestFlow = Extract<ReturnFlow, 'warranty' | 'change-of-mind'>;
230
+ /**
231
+ * A shopper return request's acknowledgement — the purchase withdrawal's
232
+ * shape: `shownAt` (the `201` showed the request number), `emailQueuedAt`
233
+ * (the `return-request-received` mail was queued) and `emailStatus` (`sent`,
234
+ * or `not-sent` when the customer has no address, the send was refused for
235
+ * good, or an operator decided the request before the mail went out). The operator reads an undelivered acknowledgement off it; the
236
+ * shopper's view never carries it.
237
+ */
238
+ type ReturnRequestAcknowledgement = PurchaseWithdrawalAcknowledgement;
222
239
  /** The change-of-mind terms snapshotted onto a request, so a later policy edit does not rewrite them. */
223
240
  interface RmaChangeOfMindTerms {
224
241
  endsAt: StatutoryInstant;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "platform-types",
3
- "version": "1.10.826",
3
+ "version": "1.10.827",
4
4
  "description": "Shared wire and entity contracts for the platform.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",