platform-types 1.10.824 → 1.10.825

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.
@@ -106,9 +106,14 @@ declare global {
106
106
  purchaseWithdrawals?: OrderPurchaseWithdrawalView[];
107
107
  /** Whether the withdrawal window is open now — as on `StorefrontOrderView`. Always present. */
108
108
  purchaseWithdrawalEligibility: OrderPurchaseWithdrawalEligibility;
109
- /** Shopper-sourced return requests, newest first. Reserved — not attached yet. */
109
+ /**
110
+ * The order's shopper-sourced return requests (`source: 'shopper'`), any
111
+ * status, newest first. Absent when there are none, and — with
112
+ * `returnRequestEligibility` — when the store's return requests could not be
113
+ * read whole.
114
+ */
110
115
  returnRequests?: OrderReturnRequestView[];
111
- /** Reserved — not attached yet. */
116
+ /** Whether a return request can be opened now. Absent only when the return requests could not be read whole. */
112
117
  returnRequestEligibility?: OrderReturnRequestEligibility;
113
118
  contact: {
114
119
  /** The stored address, masked (e.g. `j***@d***.com`). */
@@ -136,9 +136,14 @@ declare global {
136
136
  delivery?: OrderDeliveryView;
137
137
  purchaseWithdrawals?: OrderPurchaseWithdrawalView[];
138
138
  purchaseWithdrawalEligibility?: OrderPurchaseWithdrawalEligibility;
139
- /** Shopper-sourced return requests, newest first. Reserved — not attached yet. */
139
+ /**
140
+ * The order's shopper-sourced return requests (`source: 'shopper'`), any
141
+ * status, newest first. Absent when there are none, and — with
142
+ * `returnRequestEligibility` — when the store's return requests could not be
143
+ * read whole.
144
+ */
140
145
  returnRequests?: OrderReturnRequestView[];
141
- /** Reserved — not attached yet. */
146
+ /** Whether a return request can be opened now. Absent only when the return requests could not be read whole. */
142
147
  returnRequestEligibility?: OrderReturnRequestEligibility;
143
148
  };
144
149
  /**
package/dist/rma.d.ts CHANGED
@@ -234,13 +234,20 @@ declare global {
234
234
  * A shopper-sourced return request as the shopper sees it, by ALLOW-LIST:
235
235
  * never the operator's reasons or actors, carrier, tracking, nor the
236
236
  * shopper's own description. Answered by the shopper's warranty request
237
- * (`ShopperReturnRequestSubmitResponse`) and its `orderReturnRequest` frame.
237
+ * (`ShopperReturnRequestSubmitResponse`), its `orderReturnRequest` frame (on
238
+ * the request and on every later status move), and the order reads
239
+ * (`StorefrontOrderView.returnRequests`, `GuestOrderStatusView.returnRequests`).
238
240
  */
239
241
  interface OrderReturnRequestView {
240
242
  rmaId: string;
241
243
  flow: ShopperReturnRequestFlow;
242
244
  status: RmaStatus;
243
245
  requestedAt: number;
246
+ /**
247
+ * Unix ms of the request's last write (the `Rma` row's `updatedAt`). Of two
248
+ * frames or reads of one request, the later `updatedAt` is the current one.
249
+ */
250
+ updatedAt: number;
244
251
  items: OrderReturnRequestItemView[];
245
252
  /** Unix ms. */
246
253
  warrantyEndsAt?: number;
@@ -250,6 +257,10 @@ declare global {
250
257
  returnShippingPaidBy: ChangeOfMindReturnShippingPayer;
251
258
  refundAs: ChangeOfMindRefundAs;
252
259
  };
260
+ /**
261
+ * The refunds owed on this request, as on a withdrawal. No writer links a
262
+ * refund to a shopper request yet, so it is absent today.
263
+ */
253
264
  refunds?: OrderPurchaseWithdrawalRefundView[];
254
265
  }
255
266
  /** `data` of an `orderReturnRequest` socket frame, sent to the order's own customer only. */
@@ -257,7 +268,11 @@ declare global {
257
268
  orderId: string;
258
269
  returnRequest: OrderReturnRequestView;
259
270
  }
260
- /** Whether the shopper can open a return request on the order now. Reserved — no read serves it yet. */
271
+ /**
272
+ * Whether the shopper can open a return request on the order now — display
273
+ * only; the request path decides. Served on the order reads beside
274
+ * `returnRequests`.
275
+ */
261
276
  interface OrderReturnRequestEligibility {
262
277
  warranty: {
263
278
  open: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "platform-types",
3
- "version": "1.10.824",
3
+ "version": "1.10.825",
4
4
  "description": "Shared wire and entity contracts for the platform.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",