@01.software/sdk 0.70.1 → 0.72.1

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.
Files changed (70) hide show
  1. package/CHANGELOG.md +143 -0
  2. package/MIGRATION.md +28 -0
  3. package/README.md +253 -11
  4. package/dist/client.cjs +396 -26
  5. package/dist/client.cjs.map +1 -1
  6. package/dist/client.d.cts +7 -6
  7. package/dist/client.d.ts +7 -6
  8. package/dist/client.js +396 -26
  9. package/dist/client.js.map +1 -1
  10. package/dist/{collection-client-BHLStm1K.d.cts → collection-client-B3CnqMDQ.d.cts} +14 -18
  11. package/dist/{collection-client-B1FSJ24_.d.ts → collection-client-uOgS_1bC.d.ts} +14 -18
  12. package/dist/{const-ty8u0TDI.d.ts → const-BJBK7jBl.d.ts} +1 -1
  13. package/dist/{const-BfQfV-rr.d.cts → const-_ZfJjRQG.d.cts} +1 -1
  14. package/dist/embedded-admin/server.cjs +117 -2
  15. package/dist/embedded-admin/server.cjs.map +1 -1
  16. package/dist/embedded-admin/server.d.cts +30 -2
  17. package/dist/embedded-admin/server.d.ts +30 -2
  18. package/dist/embedded-admin/server.js +117 -2
  19. package/dist/embedded-admin/server.js.map +1 -1
  20. package/dist/embedded-admin.cjs +135 -7
  21. package/dist/embedded-admin.cjs.map +1 -1
  22. package/dist/embedded-admin.d.cts +35 -2
  23. package/dist/embedded-admin.d.ts +35 -2
  24. package/dist/embedded-admin.js +135 -7
  25. package/dist/embedded-admin.js.map +1 -1
  26. package/dist/errors.cjs +2 -0
  27. package/dist/errors.cjs.map +1 -1
  28. package/dist/errors.d.cts +3 -3
  29. package/dist/errors.d.ts +3 -3
  30. package/dist/errors.js +2 -0
  31. package/dist/errors.js.map +1 -1
  32. package/dist/{index-DnKgjPGM.d.ts → index-CBaP4q8r.d.ts} +3 -3
  33. package/dist/{index-CX6si6YC.d.cts → index-CI_LFWiG.d.cts} +3 -3
  34. package/dist/index.cjs +396 -26
  35. package/dist/index.cjs.map +1 -1
  36. package/dist/index.d.cts +24 -9
  37. package/dist/index.d.ts +24 -9
  38. package/dist/index.js +396 -26
  39. package/dist/index.js.map +1 -1
  40. package/dist/{payload-types-DTAaWKrp.d.cts → payload-types-BRg8Yary.d.cts} +262 -177
  41. package/dist/{payload-types-DTAaWKrp.d.ts → payload-types-BRg8Yary.d.ts} +262 -177
  42. package/dist/query.cjs +20 -0
  43. package/dist/query.cjs.map +1 -1
  44. package/dist/query.d.cts +5 -5
  45. package/dist/query.d.ts +5 -5
  46. package/dist/query.js +20 -0
  47. package/dist/query.js.map +1 -1
  48. package/dist/realtime.d.cts +2 -2
  49. package/dist/realtime.d.ts +2 -2
  50. package/dist/server.cjs +459 -46
  51. package/dist/server.cjs.map +1 -1
  52. package/dist/server.d.cts +10 -8
  53. package/dist/server.d.ts +10 -8
  54. package/dist/server.js +459 -46
  55. package/dist/server.js.map +1 -1
  56. package/dist/storefront-cache.cjs +2 -0
  57. package/dist/storefront-cache.cjs.map +1 -1
  58. package/dist/storefront-cache.js +2 -0
  59. package/dist/storefront-cache.js.map +1 -1
  60. package/dist/{types-DdlhpNVv.d.ts → types-Cmnxxvuv.d.ts} +238 -21
  61. package/dist/{types-Bzgf4mTo.d.cts → types-CnkJQUez.d.cts} +238 -21
  62. package/dist/{types-DX8Z44yQ.d.ts → types-DLjSqL0P.d.ts} +2 -2
  63. package/dist/{types-CpSiyJud.d.cts → types-FyklqLAk.d.cts} +2 -2
  64. package/dist/ui/form.d.cts +1 -1
  65. package/dist/ui/form.d.ts +1 -1
  66. package/dist/ui/video.d.cts +1 -1
  67. package/dist/ui/video.d.ts +1 -1
  68. package/dist/webhook.d.cts +5 -5
  69. package/dist/webhook.d.ts +5 -5
  70. package/package.json +2 -4
@@ -542,7 +542,7 @@ interface CarouselBlock {
542
542
  blockType: 'Carousel';
543
543
  }
544
544
  /**
545
- * Manage image assets used by content and products.
545
+ * Manage visual assets used by content and products.
546
546
  *
547
547
  * This interface was referenced by `Config`'s JSON-Schema
548
548
  * via the `definition` "images".
@@ -555,7 +555,7 @@ interface Image {
555
555
  */
556
556
  alt?: string | null;
557
557
  /**
558
- * Low quality image placeholder
558
+ * A low-resolution preview of the image.
559
559
  */
560
560
  lqip?: string | null;
561
561
  palette?: {
@@ -635,6 +635,9 @@ interface Image {
635
635
  */
636
636
  interface Tenant {
637
637
  id: string;
638
+ managementIpPolicy?: {
639
+ [k: string]: unknown;
640
+ } | unknown[] | string | number | boolean | null;
638
641
  webhookPurgeFencedAt?: string | null;
639
642
  project?: (string | null) | Project;
640
643
  environmentKind?: ('live' | 'sandbox') | null;
@@ -649,7 +652,7 @@ interface Tenant {
649
652
  } | unknown[] | string | number | boolean | null;
650
653
  name: string;
651
654
  /**
652
- * IANA time zone for workspace daily aggregation and AI usage date boundaries.
655
+ * Time zone for workspace daily aggregation and AI usage date boundaries.
653
656
  */
654
657
  timezone?: string | null;
655
658
  /**
@@ -730,18 +733,47 @@ interface Tenant {
730
733
  * Managed from the dedicated Console developer-settings screen.
731
734
  */
732
735
  embeddedAdminApp?: {
736
+ actions?: {
737
+ [k: string]: unknown;
738
+ } | unknown[] | string | number | boolean | null;
739
+ allowDownloads?: boolean | null;
733
740
  enabled?: boolean | null;
734
741
  allowedRoles?: ('tenant-admin' | 'tenant-editor' | 'tenant-viewer')[] | null;
735
742
  label?: string | null;
736
743
  origin?: string | null;
737
744
  path?: string | null;
738
745
  };
746
+ /**
747
+ * Applies only to form-submission current-page CSV and order carrier files. Error CSV, blank templates and other export paths remain available. Error CSV may contain order numbers, product handles and input values.
748
+ */
749
+ exportPolicy?: {
750
+ formSubmissions?: {
751
+ /**
752
+ * Unset uses the built-in export.
753
+ */
754
+ mode?: ('builtin' | 'disabled' | 'custom-app') | null;
755
+ /**
756
+ * Choose an action registered for this collection. The app must be enabled with file downloads allowed; only administrators can run it.
757
+ */
758
+ actionId?: string | null;
759
+ };
760
+ orders?: {
761
+ /**
762
+ * Unset uses the built-in export.
763
+ */
764
+ mode?: ('builtin' | 'disabled' | 'custom-app') | null;
765
+ /**
766
+ * Choose an action registered for this collection. The app must be enabled with file downloads allowed; only administrators can run it.
767
+ */
768
+ actionId?: string | null;
769
+ };
770
+ };
739
771
  /**
740
772
  * Workspace-wide email sender settings. Applies to every send, including commerce notifications and password resets.
741
773
  */
742
774
  senderIdentity?: {
743
775
  /**
744
- * Brand name shown in the recipient's inbox. If blank, commerce and event notifications use the workspace name; customer authentication emails (password reset, sign-in codes) use the platform default sender. (The send-from address stays on the platform domain.)
776
+ * Brand name shown in the recipient's inbox. If blank, commerce and event notifications use the workspace name; customer authentication emails (password reset, sign-in codes) use the platform default sender. A verified sending domain uses an address on that domain. If the domain is unverified or the sender address settings disagree, the platform address is used.
745
777
  */
746
778
  displayName?: string | null;
747
779
  /**
@@ -1079,7 +1111,7 @@ interface Audience {
1079
1111
  interface EmailLog {
1080
1112
  id: string;
1081
1113
  /**
1082
- * Originating workspace. NULL for system-level emails (super-admin only).
1114
+ * The workspace that sent the email. System emails have no workspace assigned and can only be viewed by a Super Admin.
1083
1115
  */
1084
1116
  tenant?: (string | null) | Tenant;
1085
1117
  to: string;
@@ -1107,7 +1139,7 @@ interface EmailLog {
1107
1139
  */
1108
1140
  recipientConsent?: ('marketing' | 'transactional' | 'service_notice') | null;
1109
1141
  /**
1110
- * Commerce notification send audit metadata. Consent classification remains owned by recipientConsent.
1142
+ * Commerce notification send history. See the Consent category field for the notification’s consent classification.
1111
1143
  */
1112
1144
  commerceNotification?: {
1113
1145
  event?: ('orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnApproved' | 'returnRejected' | 'returnCanceled' | 'returnCompleted' | 'eventRegistrationConfirmed' | 'eventOccurrenceCanceled') | null;
@@ -1139,15 +1171,15 @@ interface CommerceNotificationIntent {
1139
1171
  */
1140
1172
  recipientEmail?: string | null;
1141
1173
  /**
1142
- * Consent classification used by the send-time eligibility gate.
1174
+ * Notification category used to check recipient consent before sending.
1143
1175
  */
1144
1176
  recipientConsent: 'marketing' | 'transactional' | 'service_notice';
1145
1177
  /**
1146
- * Locale hint for template rendering.
1178
+ * Language to refer to when composing the notification.
1147
1179
  */
1148
1180
  locale?: string | null;
1149
1181
  /**
1150
- * Secret-free event snapshot for processor template rendering.
1182
+ * Record of the event at the time it occurred, used to compose the notification. Contains no secrets.
1151
1183
  */
1152
1184
  payload?: {
1153
1185
  [k: string]: unknown;
@@ -1243,7 +1275,7 @@ interface Order {
1243
1275
  */
1244
1276
  shippingAmount?: number | null;
1245
1277
  /**
1246
- * Shipping charge line snapshots at time of order
1278
+ * Shipping charges saved at the time of the order.
1247
1279
  */
1248
1280
  shippingLines?: {
1249
1281
  label: string;
@@ -1288,7 +1320,7 @@ interface Order {
1288
1320
  */
1289
1321
  appliedDiscount?: (string | null) | Discount;
1290
1322
  /**
1291
- * Discount application snapshots captured at order creation.
1323
+ * Discount applications saved when the order was created.
1292
1324
  */
1293
1325
  appliedDiscounts?: {
1294
1326
  code?: string | null;
@@ -1320,7 +1352,7 @@ interface Order {
1320
1352
  currentTotalAmount?: number | null;
1321
1353
  taxAmount?: number | null;
1322
1354
  /**
1323
- * Initial shipping refund policy snapshot at order time
1355
+ * Initial shipping refund policy saved at the time of the order.
1324
1356
  */
1325
1357
  returnShippingRefundPolicySnapshot?: {
1326
1358
  [k: string]: unknown;
@@ -1364,7 +1396,8 @@ interface Order {
1364
1396
  integrationMetadata?: {
1365
1397
  [k: string]: unknown;
1366
1398
  } | unknown[] | string | number | boolean | null;
1367
- source?: ('web' | 'app' | 'manual' | 'api' | 'import') | null;
1399
+ source?: ('web' | 'app' | 'manual' | 'api' | 'import' | 'in_person') | null;
1400
+ deliveryMethod?: ('shipping' | 'pickup') | null;
1368
1401
  tags?: (string | OrderTag)[] | null;
1369
1402
  tagSlugs?: {
1370
1403
  value: string;
@@ -1375,7 +1408,7 @@ interface Order {
1375
1408
  */
1376
1409
  test?: boolean | null;
1377
1410
  /**
1378
- * Market snapshot used for order pricing.
1411
+ * Pricing market saved when the order was created.
1379
1412
  */
1380
1413
  market?: (string | null) | Market;
1381
1414
  currency?: string | null;
@@ -1390,7 +1423,7 @@ interface Order {
1390
1423
  deletedAt?: string | null;
1391
1424
  }
1392
1425
  /**
1393
- * Manage customer information and account status.
1426
+ * Manage contact information and account status.
1394
1427
  *
1395
1428
  * This interface was referenced by `Config`'s JSON-Schema
1396
1429
  * via the `definition` "customers".
@@ -1416,12 +1449,12 @@ interface Customer {
1416
1449
  */
1417
1450
  authProvider?: ('local' | 'google' | 'apple' | 'kakao' | 'naver') | null;
1418
1451
  /**
1419
- * External provider user ID. Paired with authProvider to identify the linked account and not edited after creation.
1452
+ * External provider user ID. Identifies the linked account together with its sign-in provider and cannot be edited after creation.
1420
1453
  */
1421
1454
  providerUserId?: string | null;
1422
1455
  lastLoginAt?: string | null;
1423
1456
  /**
1424
- * Last password change timestamp (used for JWT revocation)
1457
+ * Last password change time, used to check whether earlier sign-in sessions are still valid.
1425
1458
  */
1426
1459
  passwordChangedAt?: string | null;
1427
1460
  orders?: {
@@ -1437,9 +1470,12 @@ interface Customer {
1437
1470
  defaultShippingAddress?: (string | null) | CustomerAddress;
1438
1471
  defaultBillingAddress?: (string | null) | CustomerAddress;
1439
1472
  /**
1440
- * Read-only number of this customer's completed orders. Counted automatically.
1473
+ * Read-only, automatically counted orders, including pending orders, excluding canceled, refunded, returned, test and trashed orders.
1441
1474
  */
1442
1475
  totalOrderCount?: number | null;
1476
+ /**
1477
+ * Order total in one verified currency. No value is provided when currencies are multiple or unverified.
1478
+ */
1443
1479
  lifetimeValue?: number | null;
1444
1480
  firstOrderAt?: string | null;
1445
1481
  lastOrderAt?: string | null;
@@ -1502,7 +1538,7 @@ interface Customer {
1502
1538
  };
1503
1539
  };
1504
1540
  /**
1505
- * Workspace self-reported value. It is not a hosted server consent receipt.
1541
+ * Workspace self-reported value. It does not replace server-recorded hosted consent history.
1506
1542
  */
1507
1543
  acceptsTos?: boolean | null;
1508
1544
  /**
@@ -1541,7 +1577,7 @@ interface Customer {
1541
1577
  collection: 'customers';
1542
1578
  }
1543
1579
  /**
1544
- * Manage customer groups for coupons, targeting, and badges.
1580
+ * Manage audience groupings for coupons, targeting, and badges.
1545
1581
  *
1546
1582
  * This interface was referenced by `Config`'s JSON-Schema
1547
1583
  * via the `definition` "customer-groups".
@@ -1557,7 +1593,7 @@ interface CustomerGroup {
1557
1593
  generateSlug?: boolean | null;
1558
1594
  slug?: string | null;
1559
1595
  /**
1560
- * Short summary for listing/cards
1596
+ * Short summary
1561
1597
  */
1562
1598
  description?: string | null;
1563
1599
  /**
@@ -1851,7 +1887,7 @@ interface Product {
1851
1887
  totalDocs?: number;
1852
1888
  };
1853
1889
  /**
1854
- * Markets where this product is available. Leave empty to exclude it from market-aware catalogs.
1890
+ * New products with no markets are assigned the active default market, if one exists. Removing all markets from an existing product excludes it from market catalogs.
1855
1891
  */
1856
1892
  markets?: (string | Market)[] | null;
1857
1893
  /**
@@ -1969,7 +2005,7 @@ interface Product {
1969
2005
  deletedAt?: string | null;
1970
2006
  }
1971
2007
  /**
1972
- * Manage video content, processing, and publishing status.
2008
+ * Manage audiovisual content, processing, and publishing status.
1973
2009
  *
1974
2010
  * This interface was referenced by `Config`'s JSON-Schema
1975
2011
  * via the `definition` "videos".
@@ -1984,7 +2020,7 @@ interface Video {
1984
2020
  subtitle?: string | null;
1985
2021
  filename?: string | null;
1986
2022
  /**
1987
- * Short summary for listing/cards
2023
+ * Short summary
1988
2024
  */
1989
2025
  description?: string | null;
1990
2026
  content?: {
@@ -2077,7 +2113,7 @@ interface Video {
2077
2113
  deletedAt?: string | null;
2078
2114
  }
2079
2115
  /**
2080
- * Manage live stream schedules and stream status.
2116
+ * Manage broadcast schedules and transmission status.
2081
2117
  *
2082
2118
  * This interface was referenced by `Config`'s JSON-Schema
2083
2119
  * via the `definition` "live-streams".
@@ -2091,7 +2127,7 @@ interface LiveStream {
2091
2127
  */
2092
2128
  subtitle?: string | null;
2093
2129
  /**
2094
- * Short summary for listing/cards
2130
+ * Short summary
2095
2131
  */
2096
2132
  description?: string | null;
2097
2133
  /**
@@ -2185,7 +2221,7 @@ interface VideoCategory {
2185
2221
  generateSlug?: boolean | null;
2186
2222
  slug?: string | null;
2187
2223
  /**
2188
- * Short summary for listing/cards
2224
+ * Short summary
2189
2225
  */
2190
2226
  description?: string | null;
2191
2227
  /**
@@ -2219,7 +2255,7 @@ interface VideoTag {
2219
2255
  generateSlug?: boolean | null;
2220
2256
  slug?: string | null;
2221
2257
  /**
2222
- * Short summary for listing/cards
2258
+ * Short summary
2223
2259
  */
2224
2260
  description?: string | null;
2225
2261
  /**
@@ -2410,11 +2446,11 @@ interface InventoryAdjustment {
2410
2446
  variant?: (string | null) | ProductVariant;
2411
2447
  product?: (string | null) | Product;
2412
2448
  /**
2413
- * SKU snapshot at adjustment time.
2449
+ * SKU saved at the time of the inventory adjustment.
2414
2450
  */
2415
2451
  sku?: string | null;
2416
2452
  /**
2417
- * Variant title snapshot at adjustment time.
2453
+ * Variant name saved at the time of the inventory adjustment.
2418
2454
  */
2419
2455
  variantTitle?: string | null;
2420
2456
  /**
@@ -2453,11 +2489,11 @@ interface Return {
2453
2489
  returnNumber?: string | null;
2454
2490
  order: string | Order;
2455
2491
  /**
2456
- * Exchange is a reserved model. Operator creation is not yet supported until a provider-verified exchange settlement path exists.
2492
+ * Exchange returns are not yet supported.
2457
2493
  */
2458
2494
  type: 'refund' | 'exchange';
2459
2495
  /**
2460
- * Links the new order created for an exchange after a provider-verified exchange settlement path exists.
2496
+ * The new order for an exchange. Exchanges are not yet supported.
2461
2497
  */
2462
2498
  exchangeOrder?: (string | null) | Order;
2463
2499
  status: 'requested' | 'processing' | 'approved' | 'rejected' | 'canceled' | 'completed';
@@ -2470,7 +2506,7 @@ interface Return {
2470
2506
  */
2471
2507
  rejectionReasonCode?: ('window_expired' | 'used_or_damaged' | 'non_returnable' | 'other') | null;
2472
2508
  /**
2473
- * Detailed return reason
2509
+ * Describe any circumstances not covered by the selected reason.
2474
2510
  */
2475
2511
  reasonDetail?: string | null;
2476
2512
  /**
@@ -2486,7 +2522,7 @@ interface Return {
2486
2522
  */
2487
2523
  canceledAt?: string | null;
2488
2524
  /**
2489
- * Validated actor that committed the return cancellation.
2525
+ * Operator or server account that confirmed the return cancellation.
2490
2526
  */
2491
2527
  canceledBy?: string | null;
2492
2528
  items?: {
@@ -2500,16 +2536,16 @@ interface Return {
2500
2536
  adminNotes?: string | null;
2501
2537
  completedAt?: string | null;
2502
2538
  /**
2503
- * Refund receipt URL
2539
+ * Enter a receipt link where the refund can be reviewed.
2504
2540
  */
2505
2541
  refundReceiptUrl?: string | null;
2506
2542
  refundAmount: number;
2507
2543
  /**
2508
- * Return shipping fee deducted from refundAmount
2544
+ * Return shipping cost deducted from the item refund.
2509
2545
  */
2510
2546
  returnShippingFee?: number | null;
2511
2547
  /**
2512
- * Initial order shipping amount refunded
2548
+ * The portion of the original order shipping charge refunded with this return.
2513
2549
  */
2514
2550
  initialShippingRefundAmount?: number | null;
2515
2551
  initialShippingRefundSuggestedAmount?: number | null;
@@ -2521,7 +2557,7 @@ interface Return {
2521
2557
  [k: string]: unknown;
2522
2558
  } | unknown[] | string | number | boolean | null;
2523
2559
  /**
2524
- * Reserved for provider-verified exchange settlement. Positive means extra charge; negative means extra refund.
2560
+ * Exchange balance: positive means an extra charge; negative means an extra refund. Exchanges are not yet supported.
2525
2561
  */
2526
2562
  exchangeDifference?: number | null;
2527
2563
  metadata?: {
@@ -2622,7 +2658,7 @@ interface ProductOption {
2622
2658
  */
2623
2659
  product: string | Product;
2624
2660
  /**
2625
- * Option display name in Admin and storefront. (e.g. Color, Size)
2661
+ * Option name. (e.g. Color, Size)
2626
2662
  */
2627
2663
  title: string;
2628
2664
  /**
@@ -2643,7 +2679,7 @@ interface ProductOption {
2643
2679
  deletedAt?: string | null;
2644
2680
  }
2645
2681
  /**
2646
- * Product categories are a hierarchical taxonomy for navigation and grouping.
2682
+ * Organize products hierarchically for navigation and grouping.
2647
2683
  *
2648
2684
  * This interface was referenced by `Config`'s JSON-Schema
2649
2685
  * via the `definition` "product-categories".
@@ -2659,7 +2695,7 @@ interface ProductCategory {
2659
2695
  generateSlug?: boolean | null;
2660
2696
  slug?: string | null;
2661
2697
  /**
2662
- * Short summary for listing/cards
2698
+ * Short summary
2663
2699
  */
2664
2700
  description?: string | null;
2665
2701
  /**
@@ -2679,7 +2715,7 @@ interface ProductCategory {
2679
2715
  deletedAt?: string | null;
2680
2716
  }
2681
2717
  /**
2682
- * Product tags are flat labels for search and loose grouping.
2718
+ * Flat labels for product search and loose grouping.
2683
2719
  *
2684
2720
  * This interface was referenced by `Config`'s JSON-Schema
2685
2721
  * via the `definition` "product-tags".
@@ -2695,7 +2731,7 @@ interface ProductTag {
2695
2731
  generateSlug?: boolean | null;
2696
2732
  slug?: string | null;
2697
2733
  /**
2698
- * Short summary for listing/cards
2734
+ * Short summary
2699
2735
  */
2700
2736
  description?: string | null;
2701
2737
  /**
@@ -2711,7 +2747,7 @@ interface ProductTag {
2711
2747
  deletedAt?: string | null;
2712
2748
  }
2713
2749
  /**
2714
- * Manage brand details and logos linked to products.
2750
+ * Manage details and logos linked to products.
2715
2751
  *
2716
2752
  * This interface was referenced by `Config`'s JSON-Schema
2717
2753
  * via the `definition` "brands".
@@ -2722,7 +2758,7 @@ interface Brand {
2722
2758
  tenant?: (string | null) | Tenant;
2723
2759
  name: string;
2724
2760
  /**
2725
- * Short summary for listing/cards
2761
+ * Short summary
2726
2762
  */
2727
2763
  description?: string | null;
2728
2764
  content?: {
@@ -2815,7 +2851,7 @@ interface BrandLogo {
2815
2851
  */
2816
2852
  alt?: string | null;
2817
2853
  /**
2818
- * Low quality image placeholder
2854
+ * A low-resolution preview of the image.
2819
2855
  */
2820
2856
  lqip?: string | null;
2821
2857
  palette?: {
@@ -2935,7 +2971,7 @@ interface ProductCollection {
2935
2971
  */
2936
2972
  subtitle?: string | null;
2937
2973
  /**
2938
- * Short summary for listing/cards
2974
+ * Short summary
2939
2975
  */
2940
2976
  description?: string | null;
2941
2977
  content?: {
@@ -3011,7 +3047,7 @@ interface ProductCollection {
3011
3047
  deletedAt?: string | null;
3012
3048
  }
3013
3049
  /**
3014
- * Manage shipping fee rules and default shipping policies.
3050
+ * Manage shipping fee rules and default delivery terms.
3015
3051
  *
3016
3052
  * This interface was referenced by `Config`'s JSON-Schema
3017
3053
  * via the `definition` "shipping-policies".
@@ -3060,7 +3096,7 @@ interface ShippingPolicy {
3060
3096
  id?: string | null;
3061
3097
  }[] | null;
3062
3098
  /**
3063
- * Short summary for listing/cards
3099
+ * Short summary
3064
3100
  */
3065
3101
  description?: string | null;
3066
3102
  /**
@@ -3180,7 +3216,7 @@ interface CheckoutItem {
3180
3216
  createdAt: string;
3181
3217
  }
3182
3218
  /**
3183
- * In-progress checkout snapshots. Promoted to an order on payment.
3219
+ * Track in-progress payment snapshots. Promoted to an order on payment.
3184
3220
  *
3185
3221
  * This interface was referenced by `Config`'s JSON-Schema
3186
3222
  * via the `definition` "checkouts".
@@ -3210,11 +3246,11 @@ interface Checkout {
3210
3246
  providerOrderId?: string | null;
3211
3247
  cart?: (string | null) | Cart;
3212
3248
  /**
3213
- * Cart revision frozen by this checkout.
3249
+ * Cart change count saved when this checkout was created.
3214
3250
  */
3215
3251
  cartRevision: number;
3216
3252
  /**
3217
- * Market snapshot used for checkout pricing.
3253
+ * Pricing market saved when the checkout was created.
3218
3254
  */
3219
3255
  market?: (string | null) | Market;
3220
3256
  customer?: (string | null) | Customer;
@@ -3255,13 +3291,15 @@ interface Checkout {
3255
3291
  detailAddress?: string | null;
3256
3292
  deliveryMessage?: string | null;
3257
3293
  };
3294
+ deliveryMethod?: ('shipping' | 'pickup') | null;
3295
+ source?: ('web' | 'in_person') | null;
3258
3296
  items?: {
3259
3297
  docs?: (string | CheckoutItem)[];
3260
3298
  hasNextPage?: boolean;
3261
3299
  totalDocs?: number;
3262
3300
  };
3263
3301
  /**
3264
- * PaymentSession currently holding or reconciling this Checkout payment slot.
3302
+ * The payment currently in progress or awaiting confirmation for this checkout.
3265
3303
  */
3266
3304
  activePaymentSession?: (string | null) | PaymentSession;
3267
3305
  currency?: string | null;
@@ -3290,7 +3328,7 @@ interface Checkout {
3290
3328
  */
3291
3329
  appliedDiscount?: (string | null) | Discount;
3292
3330
  /**
3293
- * Discount application snapshots captured at checkout.
3331
+ * Discount applications saved at checkout.
3294
3332
  */
3295
3333
  appliedDiscounts?: {
3296
3334
  code?: string | null;
@@ -3386,9 +3424,10 @@ interface Cart {
3386
3424
  * Cart shipping policy. Falls back to the default policy when unset.
3387
3425
  */
3388
3426
  shippingPolicy?: (string | null) | ShippingPolicy;
3427
+ deliveryMethod?: ('shipping' | 'pickup') | null;
3389
3428
  discountCode?: string | null;
3390
3429
  /**
3391
- * Server-resolved applied discount. Used only as provenance for code or automatic discounts.
3430
+ * The code discount or automatic discount applied to this cart.
3392
3431
  */
3393
3432
  appliedDiscount?: (string | null) | Discount;
3394
3433
  /**
@@ -3404,7 +3443,7 @@ interface Cart {
3404
3443
  */
3405
3444
  customerNote?: string | null;
3406
3445
  /**
3407
- * Public cart extension attributes. Mutated only through the replace API.
3446
+ * Additional cart information, updated through the connected store.
3408
3447
  */
3409
3448
  attributes?: {
3410
3449
  key: string;
@@ -3419,12 +3458,12 @@ interface Cart {
3419
3458
  status: 'active' | 'completed' | 'abandoned';
3420
3459
  revision: number;
3421
3460
  /**
3422
- * Open unpaid checkout that froze the current cart revision.
3461
+ * Unpaid checkout created from the current cart contents.
3423
3462
  */
3424
3463
  openCheckout?: (string | null) | Checkout;
3425
3464
  currency?: string | null;
3426
3465
  /**
3427
- * Market used for cart pricing. Locked by the first market-aware add-item or create call.
3466
+ * Market used for cart pricing. Once a market is first determined when creating the cart or adding an item, it cannot change.
3428
3467
  */
3429
3468
  market?: (string | null) | Market;
3430
3469
  subtotalAmount?: number | null;
@@ -3458,7 +3497,7 @@ interface Cart {
3458
3497
  createdAt: string;
3459
3498
  }
3460
3499
  /**
3461
- * Manage discount codes, eligibility rules, and usage limits.
3500
+ * Manage coupon codes and automatic discounts applied at checkout, with eligibility rules and usage limits.
3462
3501
  *
3463
3502
  * This interface was referenced by `Config`'s JSON-Schema
3464
3503
  * via the `definition` "discounts".
@@ -3545,7 +3584,7 @@ interface Discount {
3545
3584
  */
3546
3585
  maxUses?: number | null;
3547
3586
  /**
3548
- * Read-only usage count accumulated when this discount is applied successfully.
3587
+ * Read-only code discount usage count, including pending checkout reservations. Automatic discounts are not counted.
3549
3588
  */
3550
3589
  usesCount?: number | null;
3551
3590
  /**
@@ -3561,7 +3600,7 @@ interface Discount {
3561
3600
  */
3562
3601
  isCombinable?: boolean | null;
3563
3602
  /**
3564
- * Only across-order allocation is supported. Each-line-item is always rejected at checkout and cannot be saved.
3603
+ * Allocations other than “Across order”, including “Each line item”, are always rejected at checkout. Change to “Across order” and save.
3565
3604
  */
3566
3605
  allocationMethod?: ('across' | 'each') | null;
3567
3606
  /**
@@ -3619,6 +3658,8 @@ interface CartItem {
3619
3658
  interface PaymentSession {
3620
3659
  id: string;
3621
3660
  tenant?: (string | null) | Tenant;
3661
+ standardLongTailAlertedAt?: string | null;
3662
+ finalizationAlertedAt?: string | null;
3622
3663
  status: 'pending' | 'captured' | 'failed' | 'canceled';
3623
3664
  /**
3624
3665
  * Provider state normalized to the platform vocabulary.
@@ -3798,7 +3839,7 @@ interface CommercePaymentAccount {
3798
3839
  deletedAt?: string | null;
3799
3840
  }
3800
3841
  /**
3801
- * Manage events with schedules, locations, and recurrence rules.
3842
+ * Manage schedules, locations, and recurrence rules.
3802
3843
  *
3803
3844
  * This interface was referenced by `Config`'s JSON-Schema
3804
3845
  * via the `definition` "events".
@@ -3813,7 +3854,7 @@ interface Event {
3813
3854
  */
3814
3855
  subtitle?: string | null;
3815
3856
  /**
3816
- * Short summary for listing/cards
3857
+ * Short summary
3817
3858
  */
3818
3859
  description?: string | null;
3819
3860
  content?: {
@@ -3854,7 +3895,7 @@ interface Event {
3854
3895
  */
3855
3896
  endsAt: string;
3856
3897
  /**
3857
- * IANA time zone used to expand recurring occurrences.
3898
+ * Time zone used to expand recurring occurrences. After saving, changes require schedule conversion.
3858
3899
  */
3859
3900
  timezone?: string | null;
3860
3901
  isAllDay?: boolean | null;
@@ -3942,7 +3983,7 @@ interface Event {
3942
3983
  totalDocs?: number;
3943
3984
  };
3944
3985
  /**
3945
- * Registrations for this event. Creation and lifecycle status changes are handled by the registration collection and lifecycle actions.
3986
+ * Registrations for this event. Use the actions on the registration screen to change registration status and check in attendees.
3946
3987
  */
3947
3988
  registrations?: {
3948
3989
  docs?: (string | EventRegistration)[];
@@ -3992,7 +4033,7 @@ interface Event {
3992
4033
  status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
3993
4034
  coverImage?: (string | null) | Image;
3994
4035
  /**
3995
- * Public API visibility. Unlisted events remain available to public API reads, but are not intended for promoted listings.
4036
+ * Public API visibility. Unlisted events are also included in public API reads.
3996
4037
  */
3997
4038
  visibility?: ('public' | 'unlisted' | 'private') | null;
3998
4039
  /**
@@ -4000,7 +4041,7 @@ interface Event {
4000
4041
  */
4001
4042
  sourceType?: ('native' | 'external') | null;
4002
4043
  /**
4003
- * External event identity. Public API reads expose only provider and URL.
4044
+ * External event identity. Provider, source ID, and URL can all be included in public read responses.
4004
4045
  */
4005
4046
  externalSource?: {
4006
4047
  provider?: string | null;
@@ -4030,7 +4071,7 @@ interface EventCategory {
4030
4071
  generateSlug?: boolean | null;
4031
4072
  slug?: string | null;
4032
4073
  /**
4033
- * Short summary for listing/cards
4074
+ * Short summary
4034
4075
  */
4035
4076
  description?: string | null;
4036
4077
  /**
@@ -4064,7 +4105,7 @@ interface EventTag {
4064
4105
  generateSlug?: boolean | null;
4065
4106
  slug?: string | null;
4066
4107
  /**
4067
- * Short summary for listing/cards
4108
+ * Short summary
4068
4109
  */
4069
4110
  description?: string | null;
4070
4111
  /**
@@ -4094,7 +4135,7 @@ interface EventOccurrence {
4094
4135
  displayTitle?: string | null;
4095
4136
  event: string | Event;
4096
4137
  /**
4097
- * RECURRENCE-ID based on original DTSTART
4138
+ * Identifies this occurrence by its originally scheduled start time and time zone. Kept when you change this occurrence’s time.
4098
4139
  */
4099
4140
  instanceKey?: string | null;
4100
4141
  /**
@@ -4106,7 +4147,7 @@ interface EventOccurrence {
4106
4147
  */
4107
4148
  endsAt: string;
4108
4149
  /**
4109
- * IANA time zone used for occurrence identity. Existing occurrences cannot change it.
4150
+ * Time zone used to distinguish this occurrence. It cannot be changed on an existing occurrence.
4110
4151
  */
4111
4152
  timezone?: string | null;
4112
4153
  isAllDay?: boolean | null;
@@ -4135,7 +4176,7 @@ interface EventOccurrence {
4135
4176
  registrationCount?: number | null;
4136
4177
  waitlistCount?: number | null;
4137
4178
  /**
4138
- * Registrations linked to this occurrence. Registration status and check-in are managed through the registration collection and lifecycle actions.
4179
+ * Registrations linked to this occurrence. Use the actions on the registration screen to change registration status and check in attendees.
4139
4180
  */
4140
4181
  registrations?: {
4141
4182
  docs?: (string | EventRegistration)[];
@@ -4162,18 +4203,6 @@ interface EventOccurrence {
4162
4203
  interface EventRegistration {
4163
4204
  id: string;
4164
4205
  tenant?: (string | null) | Tenant;
4165
- /**
4166
- * Event this registration belongs to.
4167
- */
4168
- event: string | Event;
4169
- /**
4170
- * Occurrence this registration belongs to. Must belong to the same workspace as the event.
4171
- */
4172
- occurrence: string | EventOccurrence;
4173
- /**
4174
- * Linked customer for authenticated registrations. Guest registrations may leave this empty.
4175
- */
4176
- customer?: (string | null) | Customer;
4177
4206
  /**
4178
4207
  * Registration lifecycle status used for capacity accounting. Managed separately from attendance status.
4179
4208
  */
@@ -4186,6 +4215,18 @@ interface EventRegistration {
4186
4215
  * Number of attendees for this registration. Used for attendee and capacity calculations.
4187
4216
  */
4188
4217
  quantity?: number | null;
4218
+ /**
4219
+ * Event this registration belongs to.
4220
+ */
4221
+ event: string | Event;
4222
+ /**
4223
+ * Occurrence this registration belongs to. Must belong to the same workspace as the event.
4224
+ */
4225
+ occurrence: string | EventOccurrence;
4226
+ /**
4227
+ * Linked customer for authenticated registrations. Guest registrations may leave this empty.
4228
+ */
4229
+ customer?: (string | null) | Customer;
4189
4230
  /**
4190
4231
  * PII snapshot captured at registration time. Hidden from publishable-key reads and subject to retention cleanup.
4191
4232
  */
@@ -4195,7 +4236,7 @@ interface EventRegistration {
4195
4236
  phone?: string | null;
4196
4237
  };
4197
4238
  /**
4198
- * Internal attendee email PII. Duplicates the registration-time snapshot email for search/listing and is hidden from publishable-key reads.
4239
+ * Attendee email captured at registration time; this is personal information (PII). Stored separately from attendee information for search and listing, and hidden from publishable-key reads.
4199
4240
  */
4200
4241
  attendeeEmail?: string | null;
4201
4242
  /**
@@ -4253,7 +4294,7 @@ interface EventRegistration {
4253
4294
  */
4254
4295
  guestTokenExpiresAt?: string | null;
4255
4296
  /**
4256
- * Retention deadline for attendee PII. Owned by retention cleanup, which may redact PII after this timestamp.
4297
+ * Retention deadline for attendee personal information. Automated cleanup may delete personal information after this timestamp.
4257
4298
  */
4258
4299
  piiRetentionUntil?: string | null;
4259
4300
  /**
@@ -4268,7 +4309,7 @@ interface EventRegistration {
4268
4309
  deletedAt?: string | null;
4269
4310
  }
4270
4311
  /**
4271
- * Manage admission types and pricing references per occurrence.
4312
+ * Manage entry options and pricing references per occurrence.
4272
4313
  *
4273
4314
  * This interface was referenced by `Config`'s JSON-Schema
4274
4315
  * via the `definition` "event-admission-types".
@@ -4279,7 +4320,7 @@ interface EventAdmissionType {
4279
4320
  tenant?: (string | null) | Tenant;
4280
4321
  label: string;
4281
4322
  /**
4282
- * Short summary for listing/cards
4323
+ * Short summary
4283
4324
  */
4284
4325
  description?: string | null;
4285
4326
  event: string | Event;
@@ -4288,7 +4329,7 @@ interface EventAdmissionType {
4288
4329
  */
4289
4330
  occurrence?: (string | null) | EventOccurrence;
4290
4331
  /**
4291
- * Optional to save, but customer admission availability omits this type when the reference is missing, deleted, inactive, missing a product, or unpriced. Ecommerce owns the amount; only the reference is stored here.
4332
+ * Optional to save. To sell, select an active product variant with a product and price. Manage the amount on the linked product variant.
4292
4333
  */
4293
4334
  priceReference?: (string | null) | ProductVariant;
4294
4335
  /**
@@ -4297,10 +4338,16 @@ interface EventAdmissionType {
4297
4338
  allowedCustomerGroups?: (string | CustomerGroup)[] | null;
4298
4339
  firstRestrictedAt?: string | null;
4299
4340
  /**
4300
- * Optional per-type ceiling per occurrence. Enforced at hold creation against this type's capacity-consuming hold quantity (held, bound, and confirmed).
4341
+ * Optional maximum quantity for this admission type per occurrence. When reserving more quantity, the limit includes this type's held, checkout-linked, and confirmed quantities.
4301
4342
  */
4302
4343
  maxQuantityPerOccurrence?: number | null;
4344
+ /**
4345
+ * The sale window includes this time.
4346
+ */
4303
4347
  validFrom?: string | null;
4348
+ /**
4349
+ * The sale window includes this end time.
4350
+ */
4304
4351
  validUntil?: string | null;
4305
4352
  isActive?: boolean | null;
4306
4353
  updatedAt: string;
@@ -4443,6 +4490,7 @@ interface FulfillmentOrder {
4443
4490
  metadata?: {
4444
4491
  [k: string]: unknown;
4445
4492
  } | unknown[] | string | number | boolean | null;
4493
+ method?: ('shipping' | 'pickup') | null;
4446
4494
  updatedAt: string;
4447
4495
  createdAt: string;
4448
4496
  deletedAt?: string | null;
@@ -4501,6 +4549,7 @@ interface Fulfillment {
4501
4549
  metadata?: {
4502
4550
  [k: string]: unknown;
4503
4551
  } | unknown[] | string | number | boolean | null;
4552
+ method?: ('shipping' | 'pickup') | null;
4504
4553
  updatedAt: string;
4505
4554
  createdAt: string;
4506
4555
  deletedAt?: string | null;
@@ -4540,7 +4589,7 @@ interface Transaction {
4540
4589
  order?: (string | null) | Order;
4541
4590
  amount?: number | null;
4542
4591
  /**
4543
- * Payment method snapshot returned by the provider.
4592
+ * Payment method at the time of payment, as reported by the payment provider.
4544
4593
  */
4545
4594
  paymentMethod?: string | null;
4546
4595
  /**
@@ -4604,7 +4653,7 @@ interface Transaction {
4604
4653
  deletedAt?: string | null;
4605
4654
  }
4606
4655
  /**
4607
- * Order tags are flat labels for operational segmentation and filtering.
4656
+ * Flat labels for order segmentation and filtering.
4608
4657
  *
4609
4658
  * This interface was referenced by `Config`'s JSON-Schema
4610
4659
  * via the `definition` "order-tags".
@@ -4620,7 +4669,7 @@ interface OrderTag {
4620
4669
  generateSlug?: boolean | null;
4621
4670
  slug?: string | null;
4622
4671
  /**
4623
- * Short summary for listing/cards
4672
+ * Short summary
4624
4673
  */
4625
4674
  description?: string | null;
4626
4675
  /**
@@ -4761,15 +4810,15 @@ interface WebhookEvent {
4761
4810
  id: string;
4762
4811
  tenant?: (string | null) | Tenant;
4763
4812
  /**
4764
- * New runtime rows require workspace or global. Null marks legacy/old-runtime evidence during expand and is treated as unresolved like unknown.
4813
+ * New records must identify whether they belong to a workspace or the whole platform. Older records without an ownership value require review, like records marked Quarantined.
4765
4814
  */
4766
4815
  ownershipScope?: ('tenant' | 'global' | 'unknown') | null;
4767
4816
  /**
4768
- * Provider
4817
+ * The service that sent the event (for example, toss or mux).
4769
4818
  */
4770
4819
  provider: string;
4771
4820
  /**
4772
- * Provider-supplied event ID. Used with provider as the idempotency key for duplicate prevention.
4821
+ * The event ID supplied by the provider. The provider and event ID together prevent duplicate receipt (idempotency key).
4773
4822
  */
4774
4823
  eventId: string;
4775
4824
  receivedAt?: string | null;
@@ -5133,7 +5182,7 @@ interface TenantLogo {
5133
5182
  */
5134
5183
  alt?: string | null;
5135
5184
  /**
5136
- * Low quality image placeholder
5185
+ * A low-resolution preview of the image.
5137
5186
  */
5138
5187
  lqip?: string | null;
5139
5188
  palette?: {
@@ -5227,7 +5276,7 @@ interface TenantEntitlement {
5227
5276
  tenant: string | Tenant;
5228
5277
  plan: 'free' | 'starter' | 'basic' | 'pro' | 'enterprise';
5229
5278
  /**
5230
- * Lifecycle status for the entitlement. Only active rows participate in current plan resolution.
5279
+ * The entitlement’s current lifecycle status. Only active entitlements count toward the current plan.
5231
5280
  */
5232
5281
  status: 'active' | 'scheduled' | 'expired' | 'revoked';
5233
5282
  sourceType: 'project_free' | 'subscription' | 'manual' | 'support' | 'promo' | 'trial' | 'enterprise_contract';
@@ -5238,7 +5287,7 @@ interface TenantEntitlement {
5238
5287
  priority: number;
5239
5288
  startsAt: string;
5240
5289
  /**
5241
- * Entitlement end date. Hook validation requires it for promo / trial sources.
5290
+ * The date the entitlement expires. Required for promotion and trial entitlements, enforced by hook validation.
5242
5291
  */
5243
5292
  endsAt?: string | null;
5244
5293
  reason?: string | null;
@@ -5258,7 +5307,7 @@ interface TenantEntitlement {
5258
5307
  interface Subscription {
5259
5308
  id: string;
5260
5309
  /**
5261
- * Project billing scope. The existing Live workspace relation remains the compatibility and evidence anchor.
5310
+ * Billing is scoped to the project. The existing Live workspace link is retained for billing compatibility and historical evidence.
5262
5311
  */
5263
5312
  project?: (string | null) | Project;
5264
5313
  tenant: string | Tenant;
@@ -5353,7 +5402,13 @@ interface UsageRateCard {
5353
5402
  notes?: string | null;
5354
5403
  status: 'draft' | 'active' | 'archived';
5355
5404
  currency: 'KRW';
5405
+ /**
5406
+ * Start of the new-registration window (inclusive).
5407
+ */
5356
5408
  effectiveFrom: string;
5409
+ /**
5410
+ * New registration is unavailable from this time.
5411
+ */
5357
5412
  effectiveTo?: string | null;
5358
5413
  /**
5359
5414
  * Base usage fee (KRW)
@@ -5588,7 +5643,7 @@ interface ApiUsage {
5588
5643
  [k: string]: unknown;
5589
5644
  } | unknown[] | string | number | boolean | null;
5590
5645
  /**
5591
- * Timestamp when the usage snapshot cron calculated this monthly aggregate.
5646
+ * When the scheduled usage aggregation (cron) calculated usage for this month.
5592
5647
  */
5593
5648
  snapshottedAt?: string | null;
5594
5649
  updatedAt: string;
@@ -5735,28 +5790,28 @@ interface Refund {
5735
5790
  status: 'succeeded' | 'failed';
5736
5791
  source: 'return' | 'cancel' | 'operator' | 'adjustment';
5737
5792
  /**
5738
- * Amount in KRW (won)
5793
+ * Minor-unit amount in the refund ledger currency
5739
5794
  */
5740
5795
  totalAmount: number;
5741
5796
  fundingCheckout?: (string | null) | Checkout;
5742
5797
  /**
5743
- * Amount in KRW (won)
5798
+ * Minor-unit amount in the refund ledger currency
5744
5799
  */
5745
5800
  creditAmount?: number | null;
5746
5801
  /**
5747
- * Amount in KRW (won)
5802
+ * Minor-unit amount in the refund ledger currency
5748
5803
  */
5749
5804
  providerAmount?: number | null;
5750
5805
  /**
5751
- * Amount in KRW (won)
5806
+ * Minor-unit amount in the refund ledger currency
5752
5807
  */
5753
5808
  lineAmount?: number | null;
5754
5809
  /**
5755
- * Amount in KRW (won)
5810
+ * Minor-unit amount in the refund ledger currency
5756
5811
  */
5757
5812
  shippingAmount?: number | null;
5758
5813
  /**
5759
- * Amount in KRW (won)
5814
+ * Minor-unit amount in the refund ledger currency
5760
5815
  */
5761
5816
  adjustmentAmount?: number | null;
5762
5817
  currency?: string | null;
@@ -5783,12 +5838,12 @@ interface RefundLineItem {
5783
5838
  lineType: 'item' | 'shipping' | 'adjustment';
5784
5839
  quantity?: number | null;
5785
5840
  /**
5786
- * Amount in KRW (won)
5841
+ * Minor-unit amount in the parent refund currency
5787
5842
  */
5788
5843
  amount: number;
5789
5844
  restockAction?: ('return_to_stock' | 'discard' | 'no_restock') | null;
5790
5845
  /**
5791
- * Amount in KRW (won)
5846
+ * Minor-unit amount in the parent refund currency
5792
5847
  */
5793
5848
  restockingFee?: number | null;
5794
5849
  metadata?: {
@@ -5853,6 +5908,7 @@ interface OrderStagedChange {
5853
5908
  interface PaymentEventInbox {
5854
5909
  id: string;
5855
5910
  tenant?: (string | null) | Tenant;
5911
+ retryWaitAlertedAt?: string | null;
5856
5912
  provider: string;
5857
5913
  providerAccount: string;
5858
5914
  environment: string;
@@ -5882,7 +5938,7 @@ interface PaymentEventInbox {
5882
5938
  interface PaymentRefundAttempt {
5883
5939
  id: string;
5884
5940
  tenant?: (string | null) | Tenant;
5885
- status: 'provider_pending' | 'provider_succeeded' | 'reconciliation_required' | 'local_committed' | 'failed';
5941
+ status: 'provider_pending' | 'not_sent_rejected' | 'provider_succeeded' | 'reconciliation_required' | 'local_committed' | 'failed';
5886
5942
  order: string | Order;
5887
5943
  paymentSession?: (string | null) | PaymentSession;
5888
5944
  paymentTransaction: string | Transaction;
@@ -5974,6 +6030,10 @@ interface PaymentRefundAttempt {
5974
6030
  returnRefundTransaction?: (string | null) | Transaction;
5975
6031
  returnFinalizedAt?: string | null;
5976
6032
  returnLastErrorCode?: string | null;
6033
+ returnRejection?: {
6034
+ gate: 'fee_total' | 'order_items' | 'ordered_quantity' | 'fulfilled_quantity' | 'shipping_amount' | 'shipping_override' | 'line_fees' | 'line_amount' | 'order_status' | 'remaining_amount' | 'paid_admission';
6035
+ rejectedAt: string;
6036
+ } | null;
5977
6037
  returnSuccessResponse?: {
5978
6038
  version: 1;
5979
6039
  body: {
@@ -6316,11 +6376,11 @@ interface InventoryReservation {
6316
6376
  order?: (string | null) | Order;
6317
6377
  orderItem?: (string | null) | OrderItem;
6318
6378
  /**
6319
- * Checkout that owns this pre-payment hold. Re-linked to an order at placement.
6379
+ * Checkout for this pre-payment inventory reservation. When the order is placed, the reservation is linked to that order.
6320
6380
  */
6321
6381
  checkout?: (string | null) | Checkout;
6322
6382
  /**
6323
- * Checkout line item for this pre-payment hold. Re-linked to an order item at placement.
6383
+ * Checkout item for this pre-payment inventory reservation. When the order is placed, the reservation is linked to that order item.
6324
6384
  */
6325
6385
  checkoutItem?: (string | null) | CheckoutItem;
6326
6386
  variant: string | ProductVariant;
@@ -6334,7 +6394,7 @@ interface InventoryReservation {
6334
6394
  */
6335
6395
  statusChangedAt?: string | null;
6336
6396
  /**
6337
- * When a pending pre-payment hold expires and is auto-released. Empty for held/released/consumed rows.
6397
+ * When a reservation in the Pending state expires and is automatically released. Not recorded for other states.
6338
6398
  */
6339
6399
  expiresAt?: string | null;
6340
6400
  updatedAt: string;
@@ -6391,7 +6451,7 @@ interface OrderExportProfile {
6391
6451
  [k: string]: unknown;
6392
6452
  } | unknown[] | string | number | boolean | null;
6393
6453
  /**
6394
- * Short summary for listing/cards
6454
+ * Short summary
6395
6455
  */
6396
6456
  description?: string | null;
6397
6457
  /**
@@ -6487,7 +6547,7 @@ interface TenantCommerceConfig {
6487
6547
  deletedAt?: string | null;
6488
6548
  }
6489
6549
  /**
6490
- * Review customer consent records for terms and privacy policy.
6550
+ * Server-recorded terms and privacy policy consent history from hosted signup and reconsent. Consent collected during direct signup is not included.
6491
6551
  *
6492
6552
  * This interface was referenced by `Config`'s JSON-Schema
6493
6553
  * via the `definition` "customer-consent-receipts".
@@ -6588,7 +6648,7 @@ interface CustomerProfileList {
6588
6648
  generateSlug?: boolean | null;
6589
6649
  slug?: string | null;
6590
6650
  /**
6591
- * Short summary for listing/cards
6651
+ * Short summary
6592
6652
  */
6593
6653
  description?: string | null;
6594
6654
  isActive?: boolean | null;
@@ -6683,7 +6743,7 @@ interface DraftOrder {
6683
6743
  */
6684
6744
  market?: (string | null) | Market;
6685
6745
  /**
6686
- * Snapshot of the last calculate() result.
6746
+ * Amounts saved from the last calculation.
6687
6747
  */
6688
6748
  computedTotals?: {
6689
6749
  subtotal?: number | null;
@@ -6756,7 +6816,7 @@ interface DraftOrderItem {
6756
6816
  createdAt: string;
6757
6817
  }
6758
6818
  /**
6759
- * Manage single-use benefit voucher definitions and validity periods for customers.
6819
+ * Define single-use redemption coupons and validity periods. Issue them to customers through a server integration; staff redeem them without an order in Customer detail.
6760
6820
  *
6761
6821
  * This interface was referenced by `Config`'s JSON-Schema
6762
6822
  * via the `definition` "benefit-voucher-definitions".
@@ -6772,7 +6832,7 @@ interface BenefitVoucherDefinition {
6772
6832
  createdAt: string;
6773
6833
  }
6774
6834
  /**
6775
- * Manage publishable articles, authors, and classification.
6835
+ * Manage publishable writing, authors, and classification.
6776
6836
  *
6777
6837
  * This interface was referenced by `Config`'s JSON-Schema
6778
6838
  * via the `definition` "articles".
@@ -6787,7 +6847,7 @@ interface Article {
6787
6847
  */
6788
6848
  subtitle?: string | null;
6789
6849
  /**
6790
- * Short summary for listing/cards
6850
+ * Short summary
6791
6851
  */
6792
6852
  description?: string | null;
6793
6853
  content?: {
@@ -6883,7 +6943,7 @@ interface Article {
6883
6943
  deletedAt?: string | null;
6884
6944
  }
6885
6945
  /**
6886
- * Manage article author profiles and display details.
6946
+ * Manage contributor profiles and display details.
6887
6947
  *
6888
6948
  * This interface was referenced by `Config`'s JSON-Schema
6889
6949
  * via the `definition` "article-authors".
@@ -6932,7 +6992,7 @@ interface ArticleCategory {
6932
6992
  generateSlug?: boolean | null;
6933
6993
  slug?: string | null;
6934
6994
  /**
6935
- * Short summary for listing/cards
6995
+ * Short summary
6936
6996
  */
6937
6997
  description?: string | null;
6938
6998
  /**
@@ -6966,7 +7026,7 @@ interface ArticleTag {
6966
7026
  generateSlug?: boolean | null;
6967
7027
  slug?: string | null;
6968
7028
  /**
6969
- * Short summary for listing/cards
7029
+ * Short summary
6970
7030
  */
6971
7031
  description?: string | null;
6972
7032
  /**
@@ -6982,7 +7042,7 @@ interface ArticleTag {
6982
7042
  deletedAt?: string | null;
6983
7043
  }
6984
7044
  /**
6985
- * Manage document-based content and publishing status.
7045
+ * Manage structured content and publishing status.
6986
7046
  *
6987
7047
  * This interface was referenced by `Config`'s JSON-Schema
6988
7048
  * via the `definition` "documents".
@@ -6997,7 +7057,7 @@ interface Document {
6997
7057
  */
6998
7058
  subtitle?: string | null;
6999
7059
  /**
7000
- * Short summary for listing/cards
7060
+ * Short summary
7001
7061
  */
7002
7062
  description?: string | null;
7003
7063
  content?: {
@@ -7121,7 +7181,7 @@ interface DocumentCategory {
7121
7181
  generateSlug?: boolean | null;
7122
7182
  slug?: string | null;
7123
7183
  /**
7124
- * Short summary for listing/cards
7184
+ * Short summary
7125
7185
  */
7126
7186
  description?: string | null;
7127
7187
  /**
@@ -7141,7 +7201,7 @@ interface DocumentCategory {
7141
7201
  deletedAt?: string | null;
7142
7202
  }
7143
7203
  /**
7144
- * Manage document types used for classification.
7204
+ * Manage content formats used for classification.
7145
7205
  *
7146
7206
  * This interface was referenced by `Config`'s JSON-Schema
7147
7207
  * via the `definition` "document-types".
@@ -7157,7 +7217,7 @@ interface DocumentType {
7157
7217
  generateSlug?: boolean | null;
7158
7218
  slug?: string | null;
7159
7219
  /**
7160
- * Short summary for listing/cards
7220
+ * Short summary
7161
7221
  */
7162
7222
  description?: string | null;
7163
7223
  /**
@@ -7188,7 +7248,7 @@ interface Playlist {
7188
7248
  */
7189
7249
  subtitle?: string | null;
7190
7250
  /**
7191
- * Short summary for listing/cards
7251
+ * Short summary
7192
7252
  */
7193
7253
  description?: string | null;
7194
7254
  categories?: (string | PlaylistCategory)[] | null;
@@ -7260,7 +7320,7 @@ interface PlaylistCategory {
7260
7320
  generateSlug?: boolean | null;
7261
7321
  slug?: string | null;
7262
7322
  /**
7263
- * Short summary for listing/cards
7323
+ * Short summary
7264
7324
  */
7265
7325
  description?: string | null;
7266
7326
  /**
@@ -7294,7 +7354,7 @@ interface PlaylistTag {
7294
7354
  generateSlug?: boolean | null;
7295
7355
  slug?: string | null;
7296
7356
  /**
7297
- * Short summary for listing/cards
7357
+ * Short summary
7298
7358
  */
7299
7359
  description?: string | null;
7300
7360
  /**
@@ -7310,7 +7370,7 @@ interface PlaylistTag {
7310
7370
  deletedAt?: string | null;
7311
7371
  }
7312
7372
  /**
7313
- * Manage audio tracks and metadata used in playlists.
7373
+ * Manage audio recordings and metadata used in playlists.
7314
7374
  *
7315
7375
  * This interface was referenced by `Config`'s JSON-Schema
7316
7376
  * via the `definition` "tracks".
@@ -7321,7 +7381,7 @@ interface Track {
7321
7381
  tenant?: (string | null) | Tenant;
7322
7382
  title?: string | null;
7323
7383
  /**
7324
- * Short summary for listing/cards
7384
+ * Short summary
7325
7385
  */
7326
7386
  description?: string | null;
7327
7387
  artist?: string | null;
@@ -7375,7 +7435,7 @@ interface TrackCategory {
7375
7435
  generateSlug?: boolean | null;
7376
7436
  slug?: string | null;
7377
7437
  /**
7378
- * Short summary for listing/cards
7438
+ * Short summary
7379
7439
  */
7380
7440
  description?: string | null;
7381
7441
  /**
@@ -7409,7 +7469,7 @@ interface TrackTag {
7409
7469
  generateSlug?: boolean | null;
7410
7470
  slug?: string | null;
7411
7471
  /**
7412
- * Short summary for listing/cards
7472
+ * Short summary
7413
7473
  */
7414
7474
  description?: string | null;
7415
7475
  /**
@@ -7451,7 +7511,7 @@ interface TrackAsset {
7451
7511
  focalY?: number | null;
7452
7512
  }
7453
7513
  /**
7454
- * Manage image galleries and display order.
7514
+ * Manage image groupings and display order.
7455
7515
  *
7456
7516
  * This interface was referenced by `Config`'s JSON-Schema
7457
7517
  * via the `definition` "galleries".
@@ -7466,7 +7526,7 @@ interface Gallery {
7466
7526
  */
7467
7527
  subtitle?: string | null;
7468
7528
  /**
7469
- * Short summary for listing/cards
7529
+ * Short summary
7470
7530
  */
7471
7531
  description?: string | null;
7472
7532
  /**
@@ -7544,7 +7604,7 @@ interface GalleryCategory {
7544
7604
  generateSlug?: boolean | null;
7545
7605
  slug?: string | null;
7546
7606
  /**
7547
- * Short summary for listing/cards
7607
+ * Short summary
7548
7608
  */
7549
7609
  description?: string | null;
7550
7610
  /**
@@ -7578,7 +7638,7 @@ interface GalleryTag {
7578
7638
  generateSlug?: boolean | null;
7579
7639
  slug?: string | null;
7580
7640
  /**
7581
- * Short summary for listing/cards
7641
+ * Short summary
7582
7642
  */
7583
7643
  description?: string | null;
7584
7644
  /**
@@ -7605,7 +7665,7 @@ interface GalleryItem {
7605
7665
  gallery: string | Gallery;
7606
7666
  title?: string | null;
7607
7667
  /**
7608
- * Short summary for listing/cards
7668
+ * Short summary
7609
7669
  */
7610
7670
  description?: string | null;
7611
7671
  status?: ('draft' | 'published' | 'archived') | null;
@@ -7635,7 +7695,7 @@ interface GalleryItem {
7635
7695
  deletedAt?: string | null;
7636
7696
  }
7637
7697
  /**
7638
- * Manage external links and related metadata.
7698
+ * Manage external addresses and related metadata.
7639
7699
  *
7640
7700
  * This interface was referenced by `Config`'s JSON-Schema
7641
7701
  * via the `definition` "links".
@@ -7651,7 +7711,7 @@ interface Link {
7651
7711
  subtitle?: string | null;
7652
7712
  url: string;
7653
7713
  /**
7654
- * Short summary for listing/cards
7714
+ * Short summary
7655
7715
  */
7656
7716
  description?: string | null;
7657
7717
  categories?: (string | LinkCategory)[] | null;
@@ -7704,7 +7764,7 @@ interface LinkCategory {
7704
7764
  generateSlug?: boolean | null;
7705
7765
  slug?: string | null;
7706
7766
  /**
7707
- * Short summary for listing/cards
7767
+ * Short summary
7708
7768
  */
7709
7769
  description?: string | null;
7710
7770
  /**
@@ -7738,7 +7798,7 @@ interface LinkTag {
7738
7798
  generateSlug?: boolean | null;
7739
7799
  slug?: string | null;
7740
7800
  /**
7741
- * Short summary for listing/cards
7801
+ * Short summary
7742
7802
  */
7743
7803
  description?: string | null;
7744
7804
  /**
@@ -7754,7 +7814,7 @@ interface LinkTag {
7754
7814
  deletedAt?: string | null;
7755
7815
  }
7756
7816
  /**
7757
- * Manage visual canvases and publishing status.
7817
+ * Manage visual work surfaces and publishing status.
7758
7818
  *
7759
7819
  * This interface was referenced by `Config`'s JSON-Schema
7760
7820
  * via the `definition` "canvases".
@@ -7768,7 +7828,7 @@ interface Canvase {
7768
7828
  */
7769
7829
  subtitle?: string | null;
7770
7830
  /**
7771
- * Short summary for listing/cards
7831
+ * Short summary
7772
7832
  */
7773
7833
  description?: string | null;
7774
7834
  /**
@@ -7844,7 +7904,7 @@ interface CanvasCategory {
7844
7904
  generateSlug?: boolean | null;
7845
7905
  slug?: string | null;
7846
7906
  /**
7847
- * Short summary for listing/cards
7907
+ * Short summary
7848
7908
  */
7849
7909
  description?: string | null;
7850
7910
  /**
@@ -7878,7 +7938,7 @@ interface CanvasTag {
7878
7938
  generateSlug?: boolean | null;
7879
7939
  slug?: string | null;
7880
7940
  /**
7881
- * Short summary for listing/cards
7941
+ * Short summary
7882
7942
  */
7883
7943
  description?: string | null;
7884
7944
  /**
@@ -7910,7 +7970,7 @@ interface CanvasNodeType {
7910
7970
  generateSlug?: boolean | null;
7911
7971
  slug?: string | null;
7912
7972
  /**
7913
- * Short summary for listing/cards
7973
+ * Short summary
7914
7974
  */
7915
7975
  description?: string | null;
7916
7976
  /**
@@ -7981,7 +8041,7 @@ interface CanvasEdgeType {
7981
8041
  generateSlug?: boolean | null;
7982
8042
  slug?: string | null;
7983
8043
  /**
7984
- * Short summary for listing/cards
8044
+ * Short summary
7985
8045
  */
7986
8046
  description?: string | null;
7987
8047
  /**
@@ -8076,7 +8136,7 @@ interface CanvasEdge {
8076
8136
  deletedAt?: string | null;
8077
8137
  }
8078
8138
  /**
8079
- * Manage community posts, visibility, and review status.
8139
+ * Manage community contributions, visibility, and review status.
8080
8140
  *
8081
8141
  * This interface was referenced by `Config`'s JSON-Schema
8082
8142
  * via the `definition` "posts".
@@ -8148,12 +8208,12 @@ interface Post {
8148
8208
  */
8149
8209
  isPinned?: boolean | null;
8150
8210
  /**
8151
- * Author/operator discussion toggle. When false, new comments are blocked.
8211
+ * Author/operator discussion toggle. When disabled, new comments are blocked.
8152
8212
  */
8153
8213
  allowsComments?: boolean | null;
8154
8214
  visibility?: ('visible' | 'hidden') | null;
8155
8215
  /**
8156
- * Moderator lock. When true, new comments are blocked regardless of allowsComments.
8216
+ * Moderator lock. When enabled, new comments are blocked regardless of the Allow comments setting.
8157
8217
  */
8158
8218
  isLocked?: boolean | null;
8159
8219
  editedAt?: string | null;
@@ -8187,7 +8247,7 @@ interface PostCategory {
8187
8247
  generateSlug?: boolean | null;
8188
8248
  slug?: string | null;
8189
8249
  /**
8190
- * Short summary for listing/cards
8250
+ * Short summary
8191
8251
  */
8192
8252
  description?: string | null;
8193
8253
  /**
@@ -8207,7 +8267,7 @@ interface PostCategory {
8207
8267
  deletedAt?: string | null;
8208
8268
  }
8209
8269
  /**
8210
- * Post tags are flat labels for search and loose topic grouping.
8270
+ * Flat labels for post search and loose topic grouping.
8211
8271
  *
8212
8272
  * This interface was referenced by `Config`'s JSON-Schema
8213
8273
  * via the `definition` "post-tags".
@@ -8223,7 +8283,7 @@ interface PostTag {
8223
8283
  generateSlug?: boolean | null;
8224
8284
  slug?: string | null;
8225
8285
  /**
8226
- * Short summary for listing/cards
8286
+ * Short summary
8227
8287
  */
8228
8288
  description?: string | null;
8229
8289
  /**
@@ -8305,7 +8365,7 @@ interface Reaction {
8305
8365
  createdAt: string;
8306
8366
  }
8307
8367
  /**
8308
- * Configure reaction types available in community interactions.
8368
+ * Configure available ways to respond in community interactions.
8309
8369
  *
8310
8370
  * This interface was referenced by `Config`'s JSON-Schema
8311
8371
  * via the `definition` "reaction-types".
@@ -8401,7 +8461,7 @@ interface CommunityBan {
8401
8461
  createdAt: string;
8402
8462
  }
8403
8463
  /**
8404
- * Manage event calendar display settings and defaults.
8464
+ * Manage display settings and operational defaults.
8405
8465
  *
8406
8466
  * This interface was referenced by `Config`'s JSON-Schema
8407
8467
  * via the `definition` "event-calendars".
@@ -8415,7 +8475,7 @@ interface EventCalendar {
8415
8475
  */
8416
8476
  subtitle?: string | null;
8417
8477
  /**
8418
- * Short summary for listing/cards
8478
+ * Short summary
8419
8479
  */
8420
8480
  description?: string | null;
8421
8481
  content?: {
@@ -8434,7 +8494,7 @@ interface EventCalendar {
8434
8494
  [k: string]: unknown;
8435
8495
  } | null;
8436
8496
  /**
8437
- * Default listing behavior for the public event calendar.
8497
+ * Default behavior for public listings.
8438
8498
  */
8439
8499
  publicListing?: {
8440
8500
  /**
@@ -8485,7 +8545,7 @@ interface EventCalendar {
8485
8545
  slug?: string | null;
8486
8546
  status?: ('draft' | 'published' | 'archived') | null;
8487
8547
  /**
8488
- * Default IANA time zone for this calendar.
8548
+ * Default time zone for new events. Existing events keep their saved time zone.
8489
8549
  */
8490
8550
  timezone?: string | null;
8491
8551
  /**
@@ -8493,7 +8553,7 @@ interface EventCalendar {
8493
8553
  */
8494
8554
  color?: string | null;
8495
8555
  /**
8496
- * Visibility for the workspace-global calendar.
8556
+ * Visibility applied across the workspace.
8497
8557
  */
8498
8558
  visibility?: ('public' | 'unlisted' | 'private') | null;
8499
8559
  publishedAt?: string | null;
@@ -8520,7 +8580,7 @@ interface EventTicketPurchasePrice {
8520
8580
  deletedAt?: string | null;
8521
8581
  }
8522
8582
  /**
8523
- * Manage paid membership plans and benefit groups.
8583
+ * Manage paid enrollment offerings and benefit groups.
8524
8584
  *
8525
8585
  * This interface was referenced by `Config`'s JSON-Schema
8526
8586
  * via the `definition` "membership-plans".
@@ -8539,7 +8599,7 @@ interface MembershipPlan {
8539
8599
  generateSlug?: boolean | null;
8540
8600
  slug?: string | null;
8541
8601
  /**
8542
- * Internal note for operators; not shown to customers.
8602
+ * Included in public query responses for active plans. Do not enter internal notes that must not be shared with customers.
8543
8603
  */
8544
8604
  description?: string | null;
8545
8605
  /**
@@ -8559,7 +8619,7 @@ interface MembershipPlan {
8559
8619
  */
8560
8620
  memberGroup: string | CustomerGroup;
8561
8621
  /**
8562
- * Billing-cycle and amount options for this plan. Add and edit prices directly here and drag to reorder them. A plan with no active price is not shown at signup.
8622
+ * Billing-cycle and amount options for this plan. Add and edit prices directly here and drag to reorder them. New subscriptions to this plan require an active price.
8563
8623
  */
8564
8624
  prices?: {
8565
8625
  docs?: (string | MembershipPlanPrice)[];
@@ -8598,7 +8658,7 @@ interface MembershipPlanPrice {
8598
8658
  currency: 'KRW' | 'USD' | 'EUR' | 'JPY';
8599
8659
  billingInterval: 'month' | 'year';
8600
8660
  /**
8601
- * e.g. quarterly = month × 3
8661
+ * For example, a monthly billing interval with a count of 3 bills every 3 months.
8602
8662
  */
8603
8663
  intervalCount: number;
8604
8664
  isActive?: boolean | null;
@@ -8636,7 +8696,7 @@ interface CustomerPaymentMethod {
8636
8696
  deletedAt?: string | null;
8637
8697
  }
8638
8698
  /**
8639
- * Review customer membership status and renewal schedules.
8699
+ * Review enrollment status and renewal schedules.
8640
8700
  *
8641
8701
  * This interface was referenced by `Config`'s JSON-Schema
8642
8702
  * via the `definition` "customer-memberships".
@@ -8662,19 +8722,19 @@ interface CustomerMembership {
8662
8722
  billingInterval: 'month' | 'year';
8663
8723
  intervalCount: number;
8664
8724
  /**
8665
- * Trial-day snapshot captured when the subscribe intent is created
8725
+ * Free trial days saved when the subscription request was created.
8666
8726
  */
8667
8727
  trialDaysSnapshot?: number | null;
8668
8728
  /**
8669
- * Immutable original period start for the subscribe intent
8729
+ * Start time of the period set by the original subscription request; it cannot be changed.
8670
8730
  */
8671
8731
  subscribePeriodStart?: string | null;
8672
8732
  /**
8673
- * Immutable original period end for the subscribe intent
8733
+ * End time of the period set by the original subscription request; it cannot be changed.
8674
8734
  */
8675
8735
  subscribePeriodEnd?: string | null;
8676
8736
  /**
8677
- * Immutable SHA-256 digest of historical paid-admission recovery basis
8737
+ * Fingerprint of the historical paid-subscription recovery basis; it cannot be changed.
8678
8738
  */
8679
8739
  historicalPaidRecoveryEvidence?: string | null;
8680
8740
  currentPeriodStart?: string | null;
@@ -8707,7 +8767,7 @@ interface CustomerMembership {
8707
8767
  deletedAt?: string | null;
8708
8768
  }
8709
8769
  /**
8710
- * Review evidence for paid results that were not applied to a membership.
8770
+ * Records of successful payment results that were not applied to membership activation or renewal at the time.
8711
8771
  *
8712
8772
  * This interface was referenced by `Config`'s JSON-Schema
8713
8773
  * via the `definition` "membership-unapplied-paid-evidence".
@@ -8757,6 +8817,8 @@ interface MembershipCharge {
8757
8817
  createdAt: string;
8758
8818
  }
8759
8819
  /**
8820
+ * Manage the membership delegated billing connection and charge URL.
8821
+ *
8760
8822
  * This interface was referenced by `Config`'s JSON-Schema
8761
8823
  * via the `definition` "tenant-payment-credentials".
8762
8824
  */
@@ -8817,7 +8879,7 @@ interface DirectUploadSession {
8817
8879
  createdAt: string;
8818
8880
  }
8819
8881
  /**
8820
- * Manage form structure and publishing status.
8882
+ * Manage input structure and publishing status.
8821
8883
  *
8822
8884
  * This interface was referenced by `Config`'s JSON-Schema
8823
8885
  * via the `definition` "forms".
@@ -8828,7 +8890,7 @@ interface Form {
8828
8890
  tenant?: (string | null) | Tenant;
8829
8891
  title: string;
8830
8892
  /**
8831
- * Short summary for listing/cards
8893
+ * Short summary
8832
8894
  */
8833
8895
  description?: string | null;
8834
8896
  isActive?: boolean | null;
@@ -9453,6 +9515,7 @@ interface ProjectsSelect<T extends boolean = true> {
9453
9515
  * via the `definition` "tenants_select".
9454
9516
  */
9455
9517
  interface TenantsSelect<T extends boolean = true> {
9518
+ managementIpPolicy?: T;
9456
9519
  webhookPurgeFencedAt?: T;
9457
9520
  project?: T;
9458
9521
  environmentKind?: T;
@@ -9487,12 +9550,24 @@ interface TenantsSelect<T extends boolean = true> {
9487
9550
  id?: T;
9488
9551
  };
9489
9552
  embeddedAdminApp?: T | {
9553
+ actions?: T;
9554
+ allowDownloads?: T;
9490
9555
  enabled?: T;
9491
9556
  allowedRoles?: T;
9492
9557
  label?: T;
9493
9558
  origin?: T;
9494
9559
  path?: T;
9495
9560
  };
9561
+ exportPolicy?: T | {
9562
+ formSubmissions?: T | {
9563
+ mode?: T;
9564
+ actionId?: T;
9565
+ };
9566
+ orders?: T | {
9567
+ mode?: T;
9568
+ actionId?: T;
9569
+ };
9570
+ };
9496
9571
  senderIdentity?: T | {
9497
9572
  displayName?: T;
9498
9573
  replyTo?: T;
@@ -10492,6 +10567,7 @@ interface OrdersSelect<T extends boolean = true> {
10492
10567
  clientReferenceId?: T;
10493
10568
  integrationMetadata?: T;
10494
10569
  source?: T;
10570
+ deliveryMethod?: T;
10495
10571
  tags?: T;
10496
10572
  tagSlugs?: T | {
10497
10573
  value?: T;
@@ -10737,6 +10813,8 @@ interface OrderStagedChangesSelect<T extends boolean = true> {
10737
10813
  */
10738
10814
  interface PaymentSessionsSelect<T extends boolean = true> {
10739
10815
  tenant?: T;
10816
+ standardLongTailAlertedAt?: T;
10817
+ finalizationAlertedAt?: T;
10740
10818
  status?: T;
10741
10819
  providerStatus?: T;
10742
10820
  finalizationStatus?: T;
@@ -10801,6 +10879,7 @@ interface PaymentSessionsSelect<T extends boolean = true> {
10801
10879
  */
10802
10880
  interface PaymentEventInboxSelect<T extends boolean = true> {
10803
10881
  tenant?: T;
10882
+ retryWaitAlertedAt?: T;
10804
10883
  provider?: T;
10805
10884
  providerAccount?: T;
10806
10885
  environment?: T;
@@ -10862,6 +10941,7 @@ interface PaymentRefundAttemptsSelect<T extends boolean = true> {
10862
10941
  returnRefundTransaction?: T;
10863
10942
  returnFinalizedAt?: T;
10864
10943
  returnLastErrorCode?: T;
10944
+ returnRejection?: T;
10865
10945
  returnSuccessResponse?: T;
10866
10946
  returnResponseOutcome?: T;
10867
10947
  updatedAt?: T;
@@ -11226,6 +11306,7 @@ interface FulfillmentOrdersSelect<T extends boolean = true> {
11226
11306
  items?: T;
11227
11307
  adminNotes?: T;
11228
11308
  metadata?: T;
11309
+ method?: T;
11229
11310
  updatedAt?: T;
11230
11311
  createdAt?: T;
11231
11312
  deletedAt?: T;
@@ -11262,6 +11343,7 @@ interface FulfillmentsSelect<T extends boolean = true> {
11262
11343
  items?: T;
11263
11344
  adminNotes?: T;
11264
11345
  metadata?: T;
11346
+ method?: T;
11265
11347
  updatedAt?: T;
11266
11348
  createdAt?: T;
11267
11349
  deletedAt?: T;
@@ -11775,6 +11857,7 @@ interface CartsSelect<T extends boolean = true> {
11775
11857
  deliveryMessage?: T;
11776
11858
  };
11777
11859
  shippingPolicy?: T;
11860
+ deliveryMethod?: T;
11778
11861
  discountCode?: T;
11779
11862
  appliedDiscount?: T;
11780
11863
  discountCodes?: T | {
@@ -11902,6 +11985,8 @@ interface CheckoutsSelect<T extends boolean = true> {
11902
11985
  detailAddress?: T;
11903
11986
  deliveryMessage?: T;
11904
11987
  };
11988
+ deliveryMethod?: T;
11989
+ source?: T;
11905
11990
  items?: T;
11906
11991
  activePaymentSession?: T;
11907
11992
  currency?: T;
@@ -13390,12 +13475,12 @@ interface EventOccurrencesSelect<T extends boolean = true> {
13390
13475
  */
13391
13476
  interface EventRegistrationsSelect<T extends boolean = true> {
13392
13477
  tenant?: T;
13393
- event?: T;
13394
- occurrence?: T;
13395
- customer?: T;
13396
13478
  registrationStatus?: T;
13397
13479
  attendanceStatus?: T;
13398
13480
  quantity?: T;
13481
+ event?: T;
13482
+ occurrence?: T;
13483
+ customer?: T;
13399
13484
  attendeeSnapshot?: T | {
13400
13485
  name?: T;
13401
13486
  email?: T;