@01.software/sdk 0.71.0 → 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.
- package/CHANGELOG.md +84 -0
- package/README.md +31 -1
- package/dist/client.cjs +74 -7
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +6 -6
- package/dist/client.d.ts +6 -6
- package/dist/client.js +74 -7
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-D18xyUq_.d.cts → collection-client-B3CnqMDQ.d.cts} +4 -4
- package/dist/{collection-client-CUGJcTpl.d.ts → collection-client-uOgS_1bC.d.ts} +4 -4
- package/dist/{const-Dlu0mXmj.d.ts → const-BJBK7jBl.d.ts} +1 -1
- package/dist/{const-oGEoxCXZ.d.cts → const-_ZfJjRQG.d.cts} +1 -1
- package/dist/{index-Ccd4NYTL.d.ts → index-CBaP4q8r.d.ts} +3 -3
- package/dist/{index-HHVtIKXs.d.cts → index-CI_LFWiG.d.cts} +3 -3
- package/dist/index.cjs +74 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -7
- package/dist/index.d.ts +7 -7
- package/dist/index.js +74 -7
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-BgOEk6Y9.d.cts → payload-types-BRg8Yary.d.cts} +191 -166
- package/dist/{payload-types-BgOEk6Y9.d.ts → payload-types-BRg8Yary.d.ts} +191 -166
- package/dist/query.d.cts +5 -5
- package/dist/query.d.ts +5 -5
- package/dist/realtime.d.cts +2 -2
- package/dist/realtime.d.ts +2 -2
- package/dist/server.cjs +74 -7
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +7 -7
- package/dist/server.d.ts +7 -7
- package/dist/server.js +74 -7
- package/dist/server.js.map +1 -1
- package/dist/{types-nyOvcO0K.d.ts → types-Cmnxxvuv.d.ts} +46 -7
- package/dist/{types-DLHEIsAx.d.cts → types-CnkJQUez.d.cts} +46 -7
- package/dist/{types-CSvp2fJ_.d.ts → types-DLjSqL0P.d.ts} +2 -2
- package/dist/{types-BzG3NO7R.d.cts → types-FyklqLAk.d.cts} +2 -2
- package/dist/ui/form.d.cts +1 -1
- package/dist/ui/form.d.ts +1 -1
- package/dist/ui/video.d.cts +1 -1
- package/dist/ui/video.d.ts +1 -1
- package/dist/webhook.d.cts +5 -5
- package/dist/webhook.d.ts +5 -5
- package/package.json +2 -4
|
@@ -542,7 +542,7 @@ interface CarouselBlock {
|
|
|
542
542
|
blockType: 'Carousel';
|
|
543
543
|
}
|
|
544
544
|
/**
|
|
545
|
-
* Manage
|
|
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
|
-
*
|
|
558
|
+
* A low-resolution preview of the image.
|
|
559
559
|
*/
|
|
560
560
|
lqip?: string | null;
|
|
561
561
|
palette?: {
|
|
@@ -652,7 +652,7 @@ interface Tenant {
|
|
|
652
652
|
} | unknown[] | string | number | boolean | null;
|
|
653
653
|
name: string;
|
|
654
654
|
/**
|
|
655
|
-
*
|
|
655
|
+
* Time zone for workspace daily aggregation and AI usage date boundaries.
|
|
656
656
|
*/
|
|
657
657
|
timezone?: string | null;
|
|
658
658
|
/**
|
|
@@ -773,7 +773,7 @@ interface Tenant {
|
|
|
773
773
|
*/
|
|
774
774
|
senderIdentity?: {
|
|
775
775
|
/**
|
|
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.
|
|
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.
|
|
777
777
|
*/
|
|
778
778
|
displayName?: string | null;
|
|
779
779
|
/**
|
|
@@ -1111,7 +1111,7 @@ interface Audience {
|
|
|
1111
1111
|
interface EmailLog {
|
|
1112
1112
|
id: string;
|
|
1113
1113
|
/**
|
|
1114
|
-
*
|
|
1114
|
+
* The workspace that sent the email. System emails have no workspace assigned and can only be viewed by a Super Admin.
|
|
1115
1115
|
*/
|
|
1116
1116
|
tenant?: (string | null) | Tenant;
|
|
1117
1117
|
to: string;
|
|
@@ -1139,7 +1139,7 @@ interface EmailLog {
|
|
|
1139
1139
|
*/
|
|
1140
1140
|
recipientConsent?: ('marketing' | 'transactional' | 'service_notice') | null;
|
|
1141
1141
|
/**
|
|
1142
|
-
* Commerce notification send
|
|
1142
|
+
* Commerce notification send history. See the Consent category field for the notification’s consent classification.
|
|
1143
1143
|
*/
|
|
1144
1144
|
commerceNotification?: {
|
|
1145
1145
|
event?: ('orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnApproved' | 'returnRejected' | 'returnCanceled' | 'returnCompleted' | 'eventRegistrationConfirmed' | 'eventOccurrenceCanceled') | null;
|
|
@@ -1171,15 +1171,15 @@ interface CommerceNotificationIntent {
|
|
|
1171
1171
|
*/
|
|
1172
1172
|
recipientEmail?: string | null;
|
|
1173
1173
|
/**
|
|
1174
|
-
*
|
|
1174
|
+
* Notification category used to check recipient consent before sending.
|
|
1175
1175
|
*/
|
|
1176
1176
|
recipientConsent: 'marketing' | 'transactional' | 'service_notice';
|
|
1177
1177
|
/**
|
|
1178
|
-
*
|
|
1178
|
+
* Language to refer to when composing the notification.
|
|
1179
1179
|
*/
|
|
1180
1180
|
locale?: string | null;
|
|
1181
1181
|
/**
|
|
1182
|
-
*
|
|
1182
|
+
* Record of the event at the time it occurred, used to compose the notification. Contains no secrets.
|
|
1183
1183
|
*/
|
|
1184
1184
|
payload?: {
|
|
1185
1185
|
[k: string]: unknown;
|
|
@@ -1275,7 +1275,7 @@ interface Order {
|
|
|
1275
1275
|
*/
|
|
1276
1276
|
shippingAmount?: number | null;
|
|
1277
1277
|
/**
|
|
1278
|
-
* Shipping
|
|
1278
|
+
* Shipping charges saved at the time of the order.
|
|
1279
1279
|
*/
|
|
1280
1280
|
shippingLines?: {
|
|
1281
1281
|
label: string;
|
|
@@ -1320,7 +1320,7 @@ interface Order {
|
|
|
1320
1320
|
*/
|
|
1321
1321
|
appliedDiscount?: (string | null) | Discount;
|
|
1322
1322
|
/**
|
|
1323
|
-
* Discount
|
|
1323
|
+
* Discount applications saved when the order was created.
|
|
1324
1324
|
*/
|
|
1325
1325
|
appliedDiscounts?: {
|
|
1326
1326
|
code?: string | null;
|
|
@@ -1352,7 +1352,7 @@ interface Order {
|
|
|
1352
1352
|
currentTotalAmount?: number | null;
|
|
1353
1353
|
taxAmount?: number | null;
|
|
1354
1354
|
/**
|
|
1355
|
-
* Initial shipping refund policy
|
|
1355
|
+
* Initial shipping refund policy saved at the time of the order.
|
|
1356
1356
|
*/
|
|
1357
1357
|
returnShippingRefundPolicySnapshot?: {
|
|
1358
1358
|
[k: string]: unknown;
|
|
@@ -1396,7 +1396,7 @@ interface Order {
|
|
|
1396
1396
|
integrationMetadata?: {
|
|
1397
1397
|
[k: string]: unknown;
|
|
1398
1398
|
} | unknown[] | string | number | boolean | null;
|
|
1399
|
-
source?: ('web' | 'app' | 'manual' | 'api' | 'import') | null;
|
|
1399
|
+
source?: ('web' | 'app' | 'manual' | 'api' | 'import' | 'in_person') | null;
|
|
1400
1400
|
deliveryMethod?: ('shipping' | 'pickup') | null;
|
|
1401
1401
|
tags?: (string | OrderTag)[] | null;
|
|
1402
1402
|
tagSlugs?: {
|
|
@@ -1408,7 +1408,7 @@ interface Order {
|
|
|
1408
1408
|
*/
|
|
1409
1409
|
test?: boolean | null;
|
|
1410
1410
|
/**
|
|
1411
|
-
*
|
|
1411
|
+
* Pricing market saved when the order was created.
|
|
1412
1412
|
*/
|
|
1413
1413
|
market?: (string | null) | Market;
|
|
1414
1414
|
currency?: string | null;
|
|
@@ -1423,7 +1423,7 @@ interface Order {
|
|
|
1423
1423
|
deletedAt?: string | null;
|
|
1424
1424
|
}
|
|
1425
1425
|
/**
|
|
1426
|
-
* Manage
|
|
1426
|
+
* Manage contact information and account status.
|
|
1427
1427
|
*
|
|
1428
1428
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1429
1429
|
* via the `definition` "customers".
|
|
@@ -1449,12 +1449,12 @@ interface Customer {
|
|
|
1449
1449
|
*/
|
|
1450
1450
|
authProvider?: ('local' | 'google' | 'apple' | 'kakao' | 'naver') | null;
|
|
1451
1451
|
/**
|
|
1452
|
-
* External provider user ID.
|
|
1452
|
+
* External provider user ID. Identifies the linked account together with its sign-in provider and cannot be edited after creation.
|
|
1453
1453
|
*/
|
|
1454
1454
|
providerUserId?: string | null;
|
|
1455
1455
|
lastLoginAt?: string | null;
|
|
1456
1456
|
/**
|
|
1457
|
-
* Last password change
|
|
1457
|
+
* Last password change time, used to check whether earlier sign-in sessions are still valid.
|
|
1458
1458
|
*/
|
|
1459
1459
|
passwordChangedAt?: string | null;
|
|
1460
1460
|
orders?: {
|
|
@@ -1473,6 +1473,9 @@ interface Customer {
|
|
|
1473
1473
|
* Read-only, automatically counted orders, including pending orders, excluding canceled, refunded, returned, test and trashed orders.
|
|
1474
1474
|
*/
|
|
1475
1475
|
totalOrderCount?: number | null;
|
|
1476
|
+
/**
|
|
1477
|
+
* Order total in one verified currency. No value is provided when currencies are multiple or unverified.
|
|
1478
|
+
*/
|
|
1476
1479
|
lifetimeValue?: number | null;
|
|
1477
1480
|
firstOrderAt?: string | null;
|
|
1478
1481
|
lastOrderAt?: string | null;
|
|
@@ -1535,7 +1538,7 @@ interface Customer {
|
|
|
1535
1538
|
};
|
|
1536
1539
|
};
|
|
1537
1540
|
/**
|
|
1538
|
-
* Workspace self-reported value. It
|
|
1541
|
+
* Workspace self-reported value. It does not replace server-recorded hosted consent history.
|
|
1539
1542
|
*/
|
|
1540
1543
|
acceptsTos?: boolean | null;
|
|
1541
1544
|
/**
|
|
@@ -1574,7 +1577,7 @@ interface Customer {
|
|
|
1574
1577
|
collection: 'customers';
|
|
1575
1578
|
}
|
|
1576
1579
|
/**
|
|
1577
|
-
* Manage
|
|
1580
|
+
* Manage audience groupings for coupons, targeting, and badges.
|
|
1578
1581
|
*
|
|
1579
1582
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1580
1583
|
* via the `definition` "customer-groups".
|
|
@@ -1590,7 +1593,7 @@ interface CustomerGroup {
|
|
|
1590
1593
|
generateSlug?: boolean | null;
|
|
1591
1594
|
slug?: string | null;
|
|
1592
1595
|
/**
|
|
1593
|
-
* Short summary
|
|
1596
|
+
* Short summary
|
|
1594
1597
|
*/
|
|
1595
1598
|
description?: string | null;
|
|
1596
1599
|
/**
|
|
@@ -1884,7 +1887,7 @@ interface Product {
|
|
|
1884
1887
|
totalDocs?: number;
|
|
1885
1888
|
};
|
|
1886
1889
|
/**
|
|
1887
|
-
*
|
|
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.
|
|
1888
1891
|
*/
|
|
1889
1892
|
markets?: (string | Market)[] | null;
|
|
1890
1893
|
/**
|
|
@@ -2002,7 +2005,7 @@ interface Product {
|
|
|
2002
2005
|
deletedAt?: string | null;
|
|
2003
2006
|
}
|
|
2004
2007
|
/**
|
|
2005
|
-
* Manage
|
|
2008
|
+
* Manage audiovisual content, processing, and publishing status.
|
|
2006
2009
|
*
|
|
2007
2010
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2008
2011
|
* via the `definition` "videos".
|
|
@@ -2017,7 +2020,7 @@ interface Video {
|
|
|
2017
2020
|
subtitle?: string | null;
|
|
2018
2021
|
filename?: string | null;
|
|
2019
2022
|
/**
|
|
2020
|
-
* Short summary
|
|
2023
|
+
* Short summary
|
|
2021
2024
|
*/
|
|
2022
2025
|
description?: string | null;
|
|
2023
2026
|
content?: {
|
|
@@ -2110,7 +2113,7 @@ interface Video {
|
|
|
2110
2113
|
deletedAt?: string | null;
|
|
2111
2114
|
}
|
|
2112
2115
|
/**
|
|
2113
|
-
* Manage
|
|
2116
|
+
* Manage broadcast schedules and transmission status.
|
|
2114
2117
|
*
|
|
2115
2118
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2116
2119
|
* via the `definition` "live-streams".
|
|
@@ -2124,7 +2127,7 @@ interface LiveStream {
|
|
|
2124
2127
|
*/
|
|
2125
2128
|
subtitle?: string | null;
|
|
2126
2129
|
/**
|
|
2127
|
-
* Short summary
|
|
2130
|
+
* Short summary
|
|
2128
2131
|
*/
|
|
2129
2132
|
description?: string | null;
|
|
2130
2133
|
/**
|
|
@@ -2218,7 +2221,7 @@ interface VideoCategory {
|
|
|
2218
2221
|
generateSlug?: boolean | null;
|
|
2219
2222
|
slug?: string | null;
|
|
2220
2223
|
/**
|
|
2221
|
-
* Short summary
|
|
2224
|
+
* Short summary
|
|
2222
2225
|
*/
|
|
2223
2226
|
description?: string | null;
|
|
2224
2227
|
/**
|
|
@@ -2252,7 +2255,7 @@ interface VideoTag {
|
|
|
2252
2255
|
generateSlug?: boolean | null;
|
|
2253
2256
|
slug?: string | null;
|
|
2254
2257
|
/**
|
|
2255
|
-
* Short summary
|
|
2258
|
+
* Short summary
|
|
2256
2259
|
*/
|
|
2257
2260
|
description?: string | null;
|
|
2258
2261
|
/**
|
|
@@ -2443,11 +2446,11 @@ interface InventoryAdjustment {
|
|
|
2443
2446
|
variant?: (string | null) | ProductVariant;
|
|
2444
2447
|
product?: (string | null) | Product;
|
|
2445
2448
|
/**
|
|
2446
|
-
* SKU
|
|
2449
|
+
* SKU saved at the time of the inventory adjustment.
|
|
2447
2450
|
*/
|
|
2448
2451
|
sku?: string | null;
|
|
2449
2452
|
/**
|
|
2450
|
-
* Variant
|
|
2453
|
+
* Variant name saved at the time of the inventory adjustment.
|
|
2451
2454
|
*/
|
|
2452
2455
|
variantTitle?: string | null;
|
|
2453
2456
|
/**
|
|
@@ -2503,7 +2506,7 @@ interface Return {
|
|
|
2503
2506
|
*/
|
|
2504
2507
|
rejectionReasonCode?: ('window_expired' | 'used_or_damaged' | 'non_returnable' | 'other') | null;
|
|
2505
2508
|
/**
|
|
2506
|
-
*
|
|
2509
|
+
* Describe any circumstances not covered by the selected reason.
|
|
2507
2510
|
*/
|
|
2508
2511
|
reasonDetail?: string | null;
|
|
2509
2512
|
/**
|
|
@@ -2519,7 +2522,7 @@ interface Return {
|
|
|
2519
2522
|
*/
|
|
2520
2523
|
canceledAt?: string | null;
|
|
2521
2524
|
/**
|
|
2522
|
-
*
|
|
2525
|
+
* Operator or server account that confirmed the return cancellation.
|
|
2523
2526
|
*/
|
|
2524
2527
|
canceledBy?: string | null;
|
|
2525
2528
|
items?: {
|
|
@@ -2533,7 +2536,7 @@ interface Return {
|
|
|
2533
2536
|
adminNotes?: string | null;
|
|
2534
2537
|
completedAt?: string | null;
|
|
2535
2538
|
/**
|
|
2536
|
-
*
|
|
2539
|
+
* Enter a receipt link where the refund can be reviewed.
|
|
2537
2540
|
*/
|
|
2538
2541
|
refundReceiptUrl?: string | null;
|
|
2539
2542
|
refundAmount: number;
|
|
@@ -2542,7 +2545,7 @@ interface Return {
|
|
|
2542
2545
|
*/
|
|
2543
2546
|
returnShippingFee?: number | null;
|
|
2544
2547
|
/**
|
|
2545
|
-
*
|
|
2548
|
+
* The portion of the original order shipping charge refunded with this return.
|
|
2546
2549
|
*/
|
|
2547
2550
|
initialShippingRefundAmount?: number | null;
|
|
2548
2551
|
initialShippingRefundSuggestedAmount?: number | null;
|
|
@@ -2655,7 +2658,7 @@ interface ProductOption {
|
|
|
2655
2658
|
*/
|
|
2656
2659
|
product: string | Product;
|
|
2657
2660
|
/**
|
|
2658
|
-
* Option
|
|
2661
|
+
* Option name. (e.g. Color, Size)
|
|
2659
2662
|
*/
|
|
2660
2663
|
title: string;
|
|
2661
2664
|
/**
|
|
@@ -2676,7 +2679,7 @@ interface ProductOption {
|
|
|
2676
2679
|
deletedAt?: string | null;
|
|
2677
2680
|
}
|
|
2678
2681
|
/**
|
|
2679
|
-
*
|
|
2682
|
+
* Organize products hierarchically for navigation and grouping.
|
|
2680
2683
|
*
|
|
2681
2684
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2682
2685
|
* via the `definition` "product-categories".
|
|
@@ -2692,7 +2695,7 @@ interface ProductCategory {
|
|
|
2692
2695
|
generateSlug?: boolean | null;
|
|
2693
2696
|
slug?: string | null;
|
|
2694
2697
|
/**
|
|
2695
|
-
* Short summary
|
|
2698
|
+
* Short summary
|
|
2696
2699
|
*/
|
|
2697
2700
|
description?: string | null;
|
|
2698
2701
|
/**
|
|
@@ -2712,7 +2715,7 @@ interface ProductCategory {
|
|
|
2712
2715
|
deletedAt?: string | null;
|
|
2713
2716
|
}
|
|
2714
2717
|
/**
|
|
2715
|
-
*
|
|
2718
|
+
* Flat labels for product search and loose grouping.
|
|
2716
2719
|
*
|
|
2717
2720
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2718
2721
|
* via the `definition` "product-tags".
|
|
@@ -2728,7 +2731,7 @@ interface ProductTag {
|
|
|
2728
2731
|
generateSlug?: boolean | null;
|
|
2729
2732
|
slug?: string | null;
|
|
2730
2733
|
/**
|
|
2731
|
-
* Short summary
|
|
2734
|
+
* Short summary
|
|
2732
2735
|
*/
|
|
2733
2736
|
description?: string | null;
|
|
2734
2737
|
/**
|
|
@@ -2744,7 +2747,7 @@ interface ProductTag {
|
|
|
2744
2747
|
deletedAt?: string | null;
|
|
2745
2748
|
}
|
|
2746
2749
|
/**
|
|
2747
|
-
* Manage
|
|
2750
|
+
* Manage details and logos linked to products.
|
|
2748
2751
|
*
|
|
2749
2752
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2750
2753
|
* via the `definition` "brands".
|
|
@@ -2755,7 +2758,7 @@ interface Brand {
|
|
|
2755
2758
|
tenant?: (string | null) | Tenant;
|
|
2756
2759
|
name: string;
|
|
2757
2760
|
/**
|
|
2758
|
-
* Short summary
|
|
2761
|
+
* Short summary
|
|
2759
2762
|
*/
|
|
2760
2763
|
description?: string | null;
|
|
2761
2764
|
content?: {
|
|
@@ -2848,7 +2851,7 @@ interface BrandLogo {
|
|
|
2848
2851
|
*/
|
|
2849
2852
|
alt?: string | null;
|
|
2850
2853
|
/**
|
|
2851
|
-
*
|
|
2854
|
+
* A low-resolution preview of the image.
|
|
2852
2855
|
*/
|
|
2853
2856
|
lqip?: string | null;
|
|
2854
2857
|
palette?: {
|
|
@@ -2968,7 +2971,7 @@ interface ProductCollection {
|
|
|
2968
2971
|
*/
|
|
2969
2972
|
subtitle?: string | null;
|
|
2970
2973
|
/**
|
|
2971
|
-
* Short summary
|
|
2974
|
+
* Short summary
|
|
2972
2975
|
*/
|
|
2973
2976
|
description?: string | null;
|
|
2974
2977
|
content?: {
|
|
@@ -3044,7 +3047,7 @@ interface ProductCollection {
|
|
|
3044
3047
|
deletedAt?: string | null;
|
|
3045
3048
|
}
|
|
3046
3049
|
/**
|
|
3047
|
-
* Manage shipping fee rules and default
|
|
3050
|
+
* Manage shipping fee rules and default delivery terms.
|
|
3048
3051
|
*
|
|
3049
3052
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3050
3053
|
* via the `definition` "shipping-policies".
|
|
@@ -3093,7 +3096,7 @@ interface ShippingPolicy {
|
|
|
3093
3096
|
id?: string | null;
|
|
3094
3097
|
}[] | null;
|
|
3095
3098
|
/**
|
|
3096
|
-
* Short summary
|
|
3099
|
+
* Short summary
|
|
3097
3100
|
*/
|
|
3098
3101
|
description?: string | null;
|
|
3099
3102
|
/**
|
|
@@ -3213,7 +3216,7 @@ interface CheckoutItem {
|
|
|
3213
3216
|
createdAt: string;
|
|
3214
3217
|
}
|
|
3215
3218
|
/**
|
|
3216
|
-
*
|
|
3219
|
+
* Track in-progress payment snapshots. Promoted to an order on payment.
|
|
3217
3220
|
*
|
|
3218
3221
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3219
3222
|
* via the `definition` "checkouts".
|
|
@@ -3247,7 +3250,7 @@ interface Checkout {
|
|
|
3247
3250
|
*/
|
|
3248
3251
|
cartRevision: number;
|
|
3249
3252
|
/**
|
|
3250
|
-
*
|
|
3253
|
+
* Pricing market saved when the checkout was created.
|
|
3251
3254
|
*/
|
|
3252
3255
|
market?: (string | null) | Market;
|
|
3253
3256
|
customer?: (string | null) | Customer;
|
|
@@ -3289,6 +3292,7 @@ interface Checkout {
|
|
|
3289
3292
|
deliveryMessage?: string | null;
|
|
3290
3293
|
};
|
|
3291
3294
|
deliveryMethod?: ('shipping' | 'pickup') | null;
|
|
3295
|
+
source?: ('web' | 'in_person') | null;
|
|
3292
3296
|
items?: {
|
|
3293
3297
|
docs?: (string | CheckoutItem)[];
|
|
3294
3298
|
hasNextPage?: boolean;
|
|
@@ -3324,7 +3328,7 @@ interface Checkout {
|
|
|
3324
3328
|
*/
|
|
3325
3329
|
appliedDiscount?: (string | null) | Discount;
|
|
3326
3330
|
/**
|
|
3327
|
-
* Discount
|
|
3331
|
+
* Discount applications saved at checkout.
|
|
3328
3332
|
*/
|
|
3329
3333
|
appliedDiscounts?: {
|
|
3330
3334
|
code?: string | null;
|
|
@@ -3459,7 +3463,7 @@ interface Cart {
|
|
|
3459
3463
|
openCheckout?: (string | null) | Checkout;
|
|
3460
3464
|
currency?: string | null;
|
|
3461
3465
|
/**
|
|
3462
|
-
* Market used for cart pricing.
|
|
3466
|
+
* Market used for cart pricing. Once a market is first determined when creating the cart or adding an item, it cannot change.
|
|
3463
3467
|
*/
|
|
3464
3468
|
market?: (string | null) | Market;
|
|
3465
3469
|
subtotalAmount?: number | null;
|
|
@@ -3493,7 +3497,7 @@ interface Cart {
|
|
|
3493
3497
|
createdAt: string;
|
|
3494
3498
|
}
|
|
3495
3499
|
/**
|
|
3496
|
-
* Manage
|
|
3500
|
+
* Manage coupon codes and automatic discounts applied at checkout, with eligibility rules and usage limits.
|
|
3497
3501
|
*
|
|
3498
3502
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3499
3503
|
* via the `definition` "discounts".
|
|
@@ -3580,7 +3584,7 @@ interface Discount {
|
|
|
3580
3584
|
*/
|
|
3581
3585
|
maxUses?: number | null;
|
|
3582
3586
|
/**
|
|
3583
|
-
* Read-only usage count
|
|
3587
|
+
* Read-only code discount usage count, including pending checkout reservations. Automatic discounts are not counted.
|
|
3584
3588
|
*/
|
|
3585
3589
|
usesCount?: number | null;
|
|
3586
3590
|
/**
|
|
@@ -3596,7 +3600,7 @@ interface Discount {
|
|
|
3596
3600
|
*/
|
|
3597
3601
|
isCombinable?: boolean | null;
|
|
3598
3602
|
/**
|
|
3599
|
-
*
|
|
3603
|
+
* Allocations other than “Across order”, including “Each line item”, are always rejected at checkout. Change to “Across order” and save.
|
|
3600
3604
|
*/
|
|
3601
3605
|
allocationMethod?: ('across' | 'each') | null;
|
|
3602
3606
|
/**
|
|
@@ -3654,6 +3658,7 @@ interface CartItem {
|
|
|
3654
3658
|
interface PaymentSession {
|
|
3655
3659
|
id: string;
|
|
3656
3660
|
tenant?: (string | null) | Tenant;
|
|
3661
|
+
standardLongTailAlertedAt?: string | null;
|
|
3657
3662
|
finalizationAlertedAt?: string | null;
|
|
3658
3663
|
status: 'pending' | 'captured' | 'failed' | 'canceled';
|
|
3659
3664
|
/**
|
|
@@ -3834,7 +3839,7 @@ interface CommercePaymentAccount {
|
|
|
3834
3839
|
deletedAt?: string | null;
|
|
3835
3840
|
}
|
|
3836
3841
|
/**
|
|
3837
|
-
* Manage
|
|
3842
|
+
* Manage schedules, locations, and recurrence rules.
|
|
3838
3843
|
*
|
|
3839
3844
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3840
3845
|
* via the `definition` "events".
|
|
@@ -3849,7 +3854,7 @@ interface Event {
|
|
|
3849
3854
|
*/
|
|
3850
3855
|
subtitle?: string | null;
|
|
3851
3856
|
/**
|
|
3852
|
-
* Short summary
|
|
3857
|
+
* Short summary
|
|
3853
3858
|
*/
|
|
3854
3859
|
description?: string | null;
|
|
3855
3860
|
content?: {
|
|
@@ -3890,7 +3895,7 @@ interface Event {
|
|
|
3890
3895
|
*/
|
|
3891
3896
|
endsAt: string;
|
|
3892
3897
|
/**
|
|
3893
|
-
*
|
|
3898
|
+
* Time zone used to expand recurring occurrences. After saving, changes require schedule conversion.
|
|
3894
3899
|
*/
|
|
3895
3900
|
timezone?: string | null;
|
|
3896
3901
|
isAllDay?: boolean | null;
|
|
@@ -3978,7 +3983,7 @@ interface Event {
|
|
|
3978
3983
|
totalDocs?: number;
|
|
3979
3984
|
};
|
|
3980
3985
|
/**
|
|
3981
|
-
* Registrations for this event.
|
|
3986
|
+
* Registrations for this event. Use the actions on the registration screen to change registration status and check in attendees.
|
|
3982
3987
|
*/
|
|
3983
3988
|
registrations?: {
|
|
3984
3989
|
docs?: (string | EventRegistration)[];
|
|
@@ -4028,7 +4033,7 @@ interface Event {
|
|
|
4028
4033
|
status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
|
|
4029
4034
|
coverImage?: (string | null) | Image;
|
|
4030
4035
|
/**
|
|
4031
|
-
* Public API visibility. Unlisted events
|
|
4036
|
+
* Public API visibility. Unlisted events are also included in public API reads.
|
|
4032
4037
|
*/
|
|
4033
4038
|
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
4034
4039
|
/**
|
|
@@ -4036,7 +4041,7 @@ interface Event {
|
|
|
4036
4041
|
*/
|
|
4037
4042
|
sourceType?: ('native' | 'external') | null;
|
|
4038
4043
|
/**
|
|
4039
|
-
* External event identity.
|
|
4044
|
+
* External event identity. Provider, source ID, and URL can all be included in public read responses.
|
|
4040
4045
|
*/
|
|
4041
4046
|
externalSource?: {
|
|
4042
4047
|
provider?: string | null;
|
|
@@ -4066,7 +4071,7 @@ interface EventCategory {
|
|
|
4066
4071
|
generateSlug?: boolean | null;
|
|
4067
4072
|
slug?: string | null;
|
|
4068
4073
|
/**
|
|
4069
|
-
* Short summary
|
|
4074
|
+
* Short summary
|
|
4070
4075
|
*/
|
|
4071
4076
|
description?: string | null;
|
|
4072
4077
|
/**
|
|
@@ -4100,7 +4105,7 @@ interface EventTag {
|
|
|
4100
4105
|
generateSlug?: boolean | null;
|
|
4101
4106
|
slug?: string | null;
|
|
4102
4107
|
/**
|
|
4103
|
-
* Short summary
|
|
4108
|
+
* Short summary
|
|
4104
4109
|
*/
|
|
4105
4110
|
description?: string | null;
|
|
4106
4111
|
/**
|
|
@@ -4130,7 +4135,7 @@ interface EventOccurrence {
|
|
|
4130
4135
|
displayTitle?: string | null;
|
|
4131
4136
|
event: string | Event;
|
|
4132
4137
|
/**
|
|
4133
|
-
*
|
|
4138
|
+
* Identifies this occurrence by its originally scheduled start time and time zone. Kept when you change this occurrence’s time.
|
|
4134
4139
|
*/
|
|
4135
4140
|
instanceKey?: string | null;
|
|
4136
4141
|
/**
|
|
@@ -4142,7 +4147,7 @@ interface EventOccurrence {
|
|
|
4142
4147
|
*/
|
|
4143
4148
|
endsAt: string;
|
|
4144
4149
|
/**
|
|
4145
|
-
*
|
|
4150
|
+
* Time zone used to distinguish this occurrence. It cannot be changed on an existing occurrence.
|
|
4146
4151
|
*/
|
|
4147
4152
|
timezone?: string | null;
|
|
4148
4153
|
isAllDay?: boolean | null;
|
|
@@ -4171,7 +4176,7 @@ interface EventOccurrence {
|
|
|
4171
4176
|
registrationCount?: number | null;
|
|
4172
4177
|
waitlistCount?: number | null;
|
|
4173
4178
|
/**
|
|
4174
|
-
* Registrations linked to this occurrence.
|
|
4179
|
+
* Registrations linked to this occurrence. Use the actions on the registration screen to change registration status and check in attendees.
|
|
4175
4180
|
*/
|
|
4176
4181
|
registrations?: {
|
|
4177
4182
|
docs?: (string | EventRegistration)[];
|
|
@@ -4198,18 +4203,6 @@ interface EventOccurrence {
|
|
|
4198
4203
|
interface EventRegistration {
|
|
4199
4204
|
id: string;
|
|
4200
4205
|
tenant?: (string | null) | Tenant;
|
|
4201
|
-
/**
|
|
4202
|
-
* Event this registration belongs to.
|
|
4203
|
-
*/
|
|
4204
|
-
event: string | Event;
|
|
4205
|
-
/**
|
|
4206
|
-
* Occurrence this registration belongs to. Must belong to the same workspace as the event.
|
|
4207
|
-
*/
|
|
4208
|
-
occurrence: string | EventOccurrence;
|
|
4209
|
-
/**
|
|
4210
|
-
* Linked customer for authenticated registrations. Guest registrations may leave this empty.
|
|
4211
|
-
*/
|
|
4212
|
-
customer?: (string | null) | Customer;
|
|
4213
4206
|
/**
|
|
4214
4207
|
* Registration lifecycle status used for capacity accounting. Managed separately from attendance status.
|
|
4215
4208
|
*/
|
|
@@ -4222,6 +4215,18 @@ interface EventRegistration {
|
|
|
4222
4215
|
* Number of attendees for this registration. Used for attendee and capacity calculations.
|
|
4223
4216
|
*/
|
|
4224
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;
|
|
4225
4230
|
/**
|
|
4226
4231
|
* PII snapshot captured at registration time. Hidden from publishable-key reads and subject to retention cleanup.
|
|
4227
4232
|
*/
|
|
@@ -4231,7 +4236,7 @@ interface EventRegistration {
|
|
|
4231
4236
|
phone?: string | null;
|
|
4232
4237
|
};
|
|
4233
4238
|
/**
|
|
4234
|
-
*
|
|
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.
|
|
4235
4240
|
*/
|
|
4236
4241
|
attendeeEmail?: string | null;
|
|
4237
4242
|
/**
|
|
@@ -4289,7 +4294,7 @@ interface EventRegistration {
|
|
|
4289
4294
|
*/
|
|
4290
4295
|
guestTokenExpiresAt?: string | null;
|
|
4291
4296
|
/**
|
|
4292
|
-
* Retention deadline for attendee
|
|
4297
|
+
* Retention deadline for attendee personal information. Automated cleanup may delete personal information after this timestamp.
|
|
4293
4298
|
*/
|
|
4294
4299
|
piiRetentionUntil?: string | null;
|
|
4295
4300
|
/**
|
|
@@ -4304,7 +4309,7 @@ interface EventRegistration {
|
|
|
4304
4309
|
deletedAt?: string | null;
|
|
4305
4310
|
}
|
|
4306
4311
|
/**
|
|
4307
|
-
* Manage
|
|
4312
|
+
* Manage entry options and pricing references per occurrence.
|
|
4308
4313
|
*
|
|
4309
4314
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4310
4315
|
* via the `definition` "event-admission-types".
|
|
@@ -4315,7 +4320,7 @@ interface EventAdmissionType {
|
|
|
4315
4320
|
tenant?: (string | null) | Tenant;
|
|
4316
4321
|
label: string;
|
|
4317
4322
|
/**
|
|
4318
|
-
* Short summary
|
|
4323
|
+
* Short summary
|
|
4319
4324
|
*/
|
|
4320
4325
|
description?: string | null;
|
|
4321
4326
|
event: string | Event;
|
|
@@ -4324,7 +4329,7 @@ interface EventAdmissionType {
|
|
|
4324
4329
|
*/
|
|
4325
4330
|
occurrence?: (string | null) | EventOccurrence;
|
|
4326
4331
|
/**
|
|
4327
|
-
* Optional to save
|
|
4332
|
+
* Optional to save. To sell, select an active product variant with a product and price. Manage the amount on the linked product variant.
|
|
4328
4333
|
*/
|
|
4329
4334
|
priceReference?: (string | null) | ProductVariant;
|
|
4330
4335
|
/**
|
|
@@ -4333,10 +4338,16 @@ interface EventAdmissionType {
|
|
|
4333
4338
|
allowedCustomerGroups?: (string | CustomerGroup)[] | null;
|
|
4334
4339
|
firstRestrictedAt?: string | null;
|
|
4335
4340
|
/**
|
|
4336
|
-
* Optional
|
|
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.
|
|
4337
4342
|
*/
|
|
4338
4343
|
maxQuantityPerOccurrence?: number | null;
|
|
4344
|
+
/**
|
|
4345
|
+
* The sale window includes this time.
|
|
4346
|
+
*/
|
|
4339
4347
|
validFrom?: string | null;
|
|
4348
|
+
/**
|
|
4349
|
+
* The sale window includes this end time.
|
|
4350
|
+
*/
|
|
4340
4351
|
validUntil?: string | null;
|
|
4341
4352
|
isActive?: boolean | null;
|
|
4342
4353
|
updatedAt: string;
|
|
@@ -4479,6 +4490,7 @@ interface FulfillmentOrder {
|
|
|
4479
4490
|
metadata?: {
|
|
4480
4491
|
[k: string]: unknown;
|
|
4481
4492
|
} | unknown[] | string | number | boolean | null;
|
|
4493
|
+
method?: ('shipping' | 'pickup') | null;
|
|
4482
4494
|
updatedAt: string;
|
|
4483
4495
|
createdAt: string;
|
|
4484
4496
|
deletedAt?: string | null;
|
|
@@ -4537,6 +4549,7 @@ interface Fulfillment {
|
|
|
4537
4549
|
metadata?: {
|
|
4538
4550
|
[k: string]: unknown;
|
|
4539
4551
|
} | unknown[] | string | number | boolean | null;
|
|
4552
|
+
method?: ('shipping' | 'pickup') | null;
|
|
4540
4553
|
updatedAt: string;
|
|
4541
4554
|
createdAt: string;
|
|
4542
4555
|
deletedAt?: string | null;
|
|
@@ -4576,7 +4589,7 @@ interface Transaction {
|
|
|
4576
4589
|
order?: (string | null) | Order;
|
|
4577
4590
|
amount?: number | null;
|
|
4578
4591
|
/**
|
|
4579
|
-
* Payment method
|
|
4592
|
+
* Payment method at the time of payment, as reported by the payment provider.
|
|
4580
4593
|
*/
|
|
4581
4594
|
paymentMethod?: string | null;
|
|
4582
4595
|
/**
|
|
@@ -4640,7 +4653,7 @@ interface Transaction {
|
|
|
4640
4653
|
deletedAt?: string | null;
|
|
4641
4654
|
}
|
|
4642
4655
|
/**
|
|
4643
|
-
*
|
|
4656
|
+
* Flat labels for order segmentation and filtering.
|
|
4644
4657
|
*
|
|
4645
4658
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4646
4659
|
* via the `definition` "order-tags".
|
|
@@ -4656,7 +4669,7 @@ interface OrderTag {
|
|
|
4656
4669
|
generateSlug?: boolean | null;
|
|
4657
4670
|
slug?: string | null;
|
|
4658
4671
|
/**
|
|
4659
|
-
* Short summary
|
|
4672
|
+
* Short summary
|
|
4660
4673
|
*/
|
|
4661
4674
|
description?: string | null;
|
|
4662
4675
|
/**
|
|
@@ -4797,15 +4810,15 @@ interface WebhookEvent {
|
|
|
4797
4810
|
id: string;
|
|
4798
4811
|
tenant?: (string | null) | Tenant;
|
|
4799
4812
|
/**
|
|
4800
|
-
* New
|
|
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.
|
|
4801
4814
|
*/
|
|
4802
4815
|
ownershipScope?: ('tenant' | 'global' | 'unknown') | null;
|
|
4803
4816
|
/**
|
|
4804
|
-
*
|
|
4817
|
+
* The service that sent the event (for example, toss or mux).
|
|
4805
4818
|
*/
|
|
4806
4819
|
provider: string;
|
|
4807
4820
|
/**
|
|
4808
|
-
*
|
|
4821
|
+
* The event ID supplied by the provider. The provider and event ID together prevent duplicate receipt (idempotency key).
|
|
4809
4822
|
*/
|
|
4810
4823
|
eventId: string;
|
|
4811
4824
|
receivedAt?: string | null;
|
|
@@ -5169,7 +5182,7 @@ interface TenantLogo {
|
|
|
5169
5182
|
*/
|
|
5170
5183
|
alt?: string | null;
|
|
5171
5184
|
/**
|
|
5172
|
-
*
|
|
5185
|
+
* A low-resolution preview of the image.
|
|
5173
5186
|
*/
|
|
5174
5187
|
lqip?: string | null;
|
|
5175
5188
|
palette?: {
|
|
@@ -5263,7 +5276,7 @@ interface TenantEntitlement {
|
|
|
5263
5276
|
tenant: string | Tenant;
|
|
5264
5277
|
plan: 'free' | 'starter' | 'basic' | 'pro' | 'enterprise';
|
|
5265
5278
|
/**
|
|
5266
|
-
*
|
|
5279
|
+
* The entitlement’s current lifecycle status. Only active entitlements count toward the current plan.
|
|
5267
5280
|
*/
|
|
5268
5281
|
status: 'active' | 'scheduled' | 'expired' | 'revoked';
|
|
5269
5282
|
sourceType: 'project_free' | 'subscription' | 'manual' | 'support' | 'promo' | 'trial' | 'enterprise_contract';
|
|
@@ -5274,7 +5287,7 @@ interface TenantEntitlement {
|
|
|
5274
5287
|
priority: number;
|
|
5275
5288
|
startsAt: string;
|
|
5276
5289
|
/**
|
|
5277
|
-
*
|
|
5290
|
+
* The date the entitlement expires. Required for promotion and trial entitlements, enforced by hook validation.
|
|
5278
5291
|
*/
|
|
5279
5292
|
endsAt?: string | null;
|
|
5280
5293
|
reason?: string | null;
|
|
@@ -5294,7 +5307,7 @@ interface TenantEntitlement {
|
|
|
5294
5307
|
interface Subscription {
|
|
5295
5308
|
id: string;
|
|
5296
5309
|
/**
|
|
5297
|
-
*
|
|
5310
|
+
* Billing is scoped to the project. The existing Live workspace link is retained for billing compatibility and historical evidence.
|
|
5298
5311
|
*/
|
|
5299
5312
|
project?: (string | null) | Project;
|
|
5300
5313
|
tenant: string | Tenant;
|
|
@@ -5389,7 +5402,13 @@ interface UsageRateCard {
|
|
|
5389
5402
|
notes?: string | null;
|
|
5390
5403
|
status: 'draft' | 'active' | 'archived';
|
|
5391
5404
|
currency: 'KRW';
|
|
5405
|
+
/**
|
|
5406
|
+
* Start of the new-registration window (inclusive).
|
|
5407
|
+
*/
|
|
5392
5408
|
effectiveFrom: string;
|
|
5409
|
+
/**
|
|
5410
|
+
* New registration is unavailable from this time.
|
|
5411
|
+
*/
|
|
5393
5412
|
effectiveTo?: string | null;
|
|
5394
5413
|
/**
|
|
5395
5414
|
* Base usage fee (KRW)
|
|
@@ -5624,7 +5643,7 @@ interface ApiUsage {
|
|
|
5624
5643
|
[k: string]: unknown;
|
|
5625
5644
|
} | unknown[] | string | number | boolean | null;
|
|
5626
5645
|
/**
|
|
5627
|
-
*
|
|
5646
|
+
* When the scheduled usage aggregation (cron) calculated usage for this month.
|
|
5628
5647
|
*/
|
|
5629
5648
|
snapshottedAt?: string | null;
|
|
5630
5649
|
updatedAt: string;
|
|
@@ -5771,28 +5790,28 @@ interface Refund {
|
|
|
5771
5790
|
status: 'succeeded' | 'failed';
|
|
5772
5791
|
source: 'return' | 'cancel' | 'operator' | 'adjustment';
|
|
5773
5792
|
/**
|
|
5774
|
-
*
|
|
5793
|
+
* Minor-unit amount in the refund ledger currency
|
|
5775
5794
|
*/
|
|
5776
5795
|
totalAmount: number;
|
|
5777
5796
|
fundingCheckout?: (string | null) | Checkout;
|
|
5778
5797
|
/**
|
|
5779
|
-
*
|
|
5798
|
+
* Minor-unit amount in the refund ledger currency
|
|
5780
5799
|
*/
|
|
5781
5800
|
creditAmount?: number | null;
|
|
5782
5801
|
/**
|
|
5783
|
-
*
|
|
5802
|
+
* Minor-unit amount in the refund ledger currency
|
|
5784
5803
|
*/
|
|
5785
5804
|
providerAmount?: number | null;
|
|
5786
5805
|
/**
|
|
5787
|
-
*
|
|
5806
|
+
* Minor-unit amount in the refund ledger currency
|
|
5788
5807
|
*/
|
|
5789
5808
|
lineAmount?: number | null;
|
|
5790
5809
|
/**
|
|
5791
|
-
*
|
|
5810
|
+
* Minor-unit amount in the refund ledger currency
|
|
5792
5811
|
*/
|
|
5793
5812
|
shippingAmount?: number | null;
|
|
5794
5813
|
/**
|
|
5795
|
-
*
|
|
5814
|
+
* Minor-unit amount in the refund ledger currency
|
|
5796
5815
|
*/
|
|
5797
5816
|
adjustmentAmount?: number | null;
|
|
5798
5817
|
currency?: string | null;
|
|
@@ -5819,12 +5838,12 @@ interface RefundLineItem {
|
|
|
5819
5838
|
lineType: 'item' | 'shipping' | 'adjustment';
|
|
5820
5839
|
quantity?: number | null;
|
|
5821
5840
|
/**
|
|
5822
|
-
*
|
|
5841
|
+
* Minor-unit amount in the parent refund currency
|
|
5823
5842
|
*/
|
|
5824
5843
|
amount: number;
|
|
5825
5844
|
restockAction?: ('return_to_stock' | 'discard' | 'no_restock') | null;
|
|
5826
5845
|
/**
|
|
5827
|
-
*
|
|
5846
|
+
* Minor-unit amount in the parent refund currency
|
|
5828
5847
|
*/
|
|
5829
5848
|
restockingFee?: number | null;
|
|
5830
5849
|
metadata?: {
|
|
@@ -6357,11 +6376,11 @@ interface InventoryReservation {
|
|
|
6357
6376
|
order?: (string | null) | Order;
|
|
6358
6377
|
orderItem?: (string | null) | OrderItem;
|
|
6359
6378
|
/**
|
|
6360
|
-
* Checkout
|
|
6379
|
+
* Checkout for this pre-payment inventory reservation. When the order is placed, the reservation is linked to that order.
|
|
6361
6380
|
*/
|
|
6362
6381
|
checkout?: (string | null) | Checkout;
|
|
6363
6382
|
/**
|
|
6364
|
-
* Checkout
|
|
6383
|
+
* Checkout item for this pre-payment inventory reservation. When the order is placed, the reservation is linked to that order item.
|
|
6365
6384
|
*/
|
|
6366
6385
|
checkoutItem?: (string | null) | CheckoutItem;
|
|
6367
6386
|
variant: string | ProductVariant;
|
|
@@ -6375,7 +6394,7 @@ interface InventoryReservation {
|
|
|
6375
6394
|
*/
|
|
6376
6395
|
statusChangedAt?: string | null;
|
|
6377
6396
|
/**
|
|
6378
|
-
* When a
|
|
6397
|
+
* When a reservation in the Pending state expires and is automatically released. Not recorded for other states.
|
|
6379
6398
|
*/
|
|
6380
6399
|
expiresAt?: string | null;
|
|
6381
6400
|
updatedAt: string;
|
|
@@ -6432,7 +6451,7 @@ interface OrderExportProfile {
|
|
|
6432
6451
|
[k: string]: unknown;
|
|
6433
6452
|
} | unknown[] | string | number | boolean | null;
|
|
6434
6453
|
/**
|
|
6435
|
-
* Short summary
|
|
6454
|
+
* Short summary
|
|
6436
6455
|
*/
|
|
6437
6456
|
description?: string | null;
|
|
6438
6457
|
/**
|
|
@@ -6528,7 +6547,7 @@ interface TenantCommerceConfig {
|
|
|
6528
6547
|
deletedAt?: string | null;
|
|
6529
6548
|
}
|
|
6530
6549
|
/**
|
|
6531
|
-
*
|
|
6550
|
+
* Server-recorded terms and privacy policy consent history from hosted signup and reconsent. Consent collected during direct signup is not included.
|
|
6532
6551
|
*
|
|
6533
6552
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6534
6553
|
* via the `definition` "customer-consent-receipts".
|
|
@@ -6629,7 +6648,7 @@ interface CustomerProfileList {
|
|
|
6629
6648
|
generateSlug?: boolean | null;
|
|
6630
6649
|
slug?: string | null;
|
|
6631
6650
|
/**
|
|
6632
|
-
* Short summary
|
|
6651
|
+
* Short summary
|
|
6633
6652
|
*/
|
|
6634
6653
|
description?: string | null;
|
|
6635
6654
|
isActive?: boolean | null;
|
|
@@ -6724,7 +6743,7 @@ interface DraftOrder {
|
|
|
6724
6743
|
*/
|
|
6725
6744
|
market?: (string | null) | Market;
|
|
6726
6745
|
/**
|
|
6727
|
-
*
|
|
6746
|
+
* Amounts saved from the last calculation.
|
|
6728
6747
|
*/
|
|
6729
6748
|
computedTotals?: {
|
|
6730
6749
|
subtotal?: number | null;
|
|
@@ -6797,7 +6816,7 @@ interface DraftOrderItem {
|
|
|
6797
6816
|
createdAt: string;
|
|
6798
6817
|
}
|
|
6799
6818
|
/**
|
|
6800
|
-
*
|
|
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.
|
|
6801
6820
|
*
|
|
6802
6821
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6803
6822
|
* via the `definition` "benefit-voucher-definitions".
|
|
@@ -6813,7 +6832,7 @@ interface BenefitVoucherDefinition {
|
|
|
6813
6832
|
createdAt: string;
|
|
6814
6833
|
}
|
|
6815
6834
|
/**
|
|
6816
|
-
* Manage publishable
|
|
6835
|
+
* Manage publishable writing, authors, and classification.
|
|
6817
6836
|
*
|
|
6818
6837
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6819
6838
|
* via the `definition` "articles".
|
|
@@ -6828,7 +6847,7 @@ interface Article {
|
|
|
6828
6847
|
*/
|
|
6829
6848
|
subtitle?: string | null;
|
|
6830
6849
|
/**
|
|
6831
|
-
* Short summary
|
|
6850
|
+
* Short summary
|
|
6832
6851
|
*/
|
|
6833
6852
|
description?: string | null;
|
|
6834
6853
|
content?: {
|
|
@@ -6924,7 +6943,7 @@ interface Article {
|
|
|
6924
6943
|
deletedAt?: string | null;
|
|
6925
6944
|
}
|
|
6926
6945
|
/**
|
|
6927
|
-
* Manage
|
|
6946
|
+
* Manage contributor profiles and display details.
|
|
6928
6947
|
*
|
|
6929
6948
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6930
6949
|
* via the `definition` "article-authors".
|
|
@@ -6973,7 +6992,7 @@ interface ArticleCategory {
|
|
|
6973
6992
|
generateSlug?: boolean | null;
|
|
6974
6993
|
slug?: string | null;
|
|
6975
6994
|
/**
|
|
6976
|
-
* Short summary
|
|
6995
|
+
* Short summary
|
|
6977
6996
|
*/
|
|
6978
6997
|
description?: string | null;
|
|
6979
6998
|
/**
|
|
@@ -7007,7 +7026,7 @@ interface ArticleTag {
|
|
|
7007
7026
|
generateSlug?: boolean | null;
|
|
7008
7027
|
slug?: string | null;
|
|
7009
7028
|
/**
|
|
7010
|
-
* Short summary
|
|
7029
|
+
* Short summary
|
|
7011
7030
|
*/
|
|
7012
7031
|
description?: string | null;
|
|
7013
7032
|
/**
|
|
@@ -7023,7 +7042,7 @@ interface ArticleTag {
|
|
|
7023
7042
|
deletedAt?: string | null;
|
|
7024
7043
|
}
|
|
7025
7044
|
/**
|
|
7026
|
-
* Manage
|
|
7045
|
+
* Manage structured content and publishing status.
|
|
7027
7046
|
*
|
|
7028
7047
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7029
7048
|
* via the `definition` "documents".
|
|
@@ -7038,7 +7057,7 @@ interface Document {
|
|
|
7038
7057
|
*/
|
|
7039
7058
|
subtitle?: string | null;
|
|
7040
7059
|
/**
|
|
7041
|
-
* Short summary
|
|
7060
|
+
* Short summary
|
|
7042
7061
|
*/
|
|
7043
7062
|
description?: string | null;
|
|
7044
7063
|
content?: {
|
|
@@ -7162,7 +7181,7 @@ interface DocumentCategory {
|
|
|
7162
7181
|
generateSlug?: boolean | null;
|
|
7163
7182
|
slug?: string | null;
|
|
7164
7183
|
/**
|
|
7165
|
-
* Short summary
|
|
7184
|
+
* Short summary
|
|
7166
7185
|
*/
|
|
7167
7186
|
description?: string | null;
|
|
7168
7187
|
/**
|
|
@@ -7182,7 +7201,7 @@ interface DocumentCategory {
|
|
|
7182
7201
|
deletedAt?: string | null;
|
|
7183
7202
|
}
|
|
7184
7203
|
/**
|
|
7185
|
-
* Manage
|
|
7204
|
+
* Manage content formats used for classification.
|
|
7186
7205
|
*
|
|
7187
7206
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7188
7207
|
* via the `definition` "document-types".
|
|
@@ -7198,7 +7217,7 @@ interface DocumentType {
|
|
|
7198
7217
|
generateSlug?: boolean | null;
|
|
7199
7218
|
slug?: string | null;
|
|
7200
7219
|
/**
|
|
7201
|
-
* Short summary
|
|
7220
|
+
* Short summary
|
|
7202
7221
|
*/
|
|
7203
7222
|
description?: string | null;
|
|
7204
7223
|
/**
|
|
@@ -7229,7 +7248,7 @@ interface Playlist {
|
|
|
7229
7248
|
*/
|
|
7230
7249
|
subtitle?: string | null;
|
|
7231
7250
|
/**
|
|
7232
|
-
* Short summary
|
|
7251
|
+
* Short summary
|
|
7233
7252
|
*/
|
|
7234
7253
|
description?: string | null;
|
|
7235
7254
|
categories?: (string | PlaylistCategory)[] | null;
|
|
@@ -7301,7 +7320,7 @@ interface PlaylistCategory {
|
|
|
7301
7320
|
generateSlug?: boolean | null;
|
|
7302
7321
|
slug?: string | null;
|
|
7303
7322
|
/**
|
|
7304
|
-
* Short summary
|
|
7323
|
+
* Short summary
|
|
7305
7324
|
*/
|
|
7306
7325
|
description?: string | null;
|
|
7307
7326
|
/**
|
|
@@ -7335,7 +7354,7 @@ interface PlaylistTag {
|
|
|
7335
7354
|
generateSlug?: boolean | null;
|
|
7336
7355
|
slug?: string | null;
|
|
7337
7356
|
/**
|
|
7338
|
-
* Short summary
|
|
7357
|
+
* Short summary
|
|
7339
7358
|
*/
|
|
7340
7359
|
description?: string | null;
|
|
7341
7360
|
/**
|
|
@@ -7351,7 +7370,7 @@ interface PlaylistTag {
|
|
|
7351
7370
|
deletedAt?: string | null;
|
|
7352
7371
|
}
|
|
7353
7372
|
/**
|
|
7354
|
-
* Manage audio
|
|
7373
|
+
* Manage audio recordings and metadata used in playlists.
|
|
7355
7374
|
*
|
|
7356
7375
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7357
7376
|
* via the `definition` "tracks".
|
|
@@ -7362,7 +7381,7 @@ interface Track {
|
|
|
7362
7381
|
tenant?: (string | null) | Tenant;
|
|
7363
7382
|
title?: string | null;
|
|
7364
7383
|
/**
|
|
7365
|
-
* Short summary
|
|
7384
|
+
* Short summary
|
|
7366
7385
|
*/
|
|
7367
7386
|
description?: string | null;
|
|
7368
7387
|
artist?: string | null;
|
|
@@ -7416,7 +7435,7 @@ interface TrackCategory {
|
|
|
7416
7435
|
generateSlug?: boolean | null;
|
|
7417
7436
|
slug?: string | null;
|
|
7418
7437
|
/**
|
|
7419
|
-
* Short summary
|
|
7438
|
+
* Short summary
|
|
7420
7439
|
*/
|
|
7421
7440
|
description?: string | null;
|
|
7422
7441
|
/**
|
|
@@ -7450,7 +7469,7 @@ interface TrackTag {
|
|
|
7450
7469
|
generateSlug?: boolean | null;
|
|
7451
7470
|
slug?: string | null;
|
|
7452
7471
|
/**
|
|
7453
|
-
* Short summary
|
|
7472
|
+
* Short summary
|
|
7454
7473
|
*/
|
|
7455
7474
|
description?: string | null;
|
|
7456
7475
|
/**
|
|
@@ -7492,7 +7511,7 @@ interface TrackAsset {
|
|
|
7492
7511
|
focalY?: number | null;
|
|
7493
7512
|
}
|
|
7494
7513
|
/**
|
|
7495
|
-
* Manage image
|
|
7514
|
+
* Manage image groupings and display order.
|
|
7496
7515
|
*
|
|
7497
7516
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7498
7517
|
* via the `definition` "galleries".
|
|
@@ -7507,7 +7526,7 @@ interface Gallery {
|
|
|
7507
7526
|
*/
|
|
7508
7527
|
subtitle?: string | null;
|
|
7509
7528
|
/**
|
|
7510
|
-
* Short summary
|
|
7529
|
+
* Short summary
|
|
7511
7530
|
*/
|
|
7512
7531
|
description?: string | null;
|
|
7513
7532
|
/**
|
|
@@ -7585,7 +7604,7 @@ interface GalleryCategory {
|
|
|
7585
7604
|
generateSlug?: boolean | null;
|
|
7586
7605
|
slug?: string | null;
|
|
7587
7606
|
/**
|
|
7588
|
-
* Short summary
|
|
7607
|
+
* Short summary
|
|
7589
7608
|
*/
|
|
7590
7609
|
description?: string | null;
|
|
7591
7610
|
/**
|
|
@@ -7619,7 +7638,7 @@ interface GalleryTag {
|
|
|
7619
7638
|
generateSlug?: boolean | null;
|
|
7620
7639
|
slug?: string | null;
|
|
7621
7640
|
/**
|
|
7622
|
-
* Short summary
|
|
7641
|
+
* Short summary
|
|
7623
7642
|
*/
|
|
7624
7643
|
description?: string | null;
|
|
7625
7644
|
/**
|
|
@@ -7646,7 +7665,7 @@ interface GalleryItem {
|
|
|
7646
7665
|
gallery: string | Gallery;
|
|
7647
7666
|
title?: string | null;
|
|
7648
7667
|
/**
|
|
7649
|
-
* Short summary
|
|
7668
|
+
* Short summary
|
|
7650
7669
|
*/
|
|
7651
7670
|
description?: string | null;
|
|
7652
7671
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
@@ -7676,7 +7695,7 @@ interface GalleryItem {
|
|
|
7676
7695
|
deletedAt?: string | null;
|
|
7677
7696
|
}
|
|
7678
7697
|
/**
|
|
7679
|
-
* Manage external
|
|
7698
|
+
* Manage external addresses and related metadata.
|
|
7680
7699
|
*
|
|
7681
7700
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7682
7701
|
* via the `definition` "links".
|
|
@@ -7692,7 +7711,7 @@ interface Link {
|
|
|
7692
7711
|
subtitle?: string | null;
|
|
7693
7712
|
url: string;
|
|
7694
7713
|
/**
|
|
7695
|
-
* Short summary
|
|
7714
|
+
* Short summary
|
|
7696
7715
|
*/
|
|
7697
7716
|
description?: string | null;
|
|
7698
7717
|
categories?: (string | LinkCategory)[] | null;
|
|
@@ -7745,7 +7764,7 @@ interface LinkCategory {
|
|
|
7745
7764
|
generateSlug?: boolean | null;
|
|
7746
7765
|
slug?: string | null;
|
|
7747
7766
|
/**
|
|
7748
|
-
* Short summary
|
|
7767
|
+
* Short summary
|
|
7749
7768
|
*/
|
|
7750
7769
|
description?: string | null;
|
|
7751
7770
|
/**
|
|
@@ -7779,7 +7798,7 @@ interface LinkTag {
|
|
|
7779
7798
|
generateSlug?: boolean | null;
|
|
7780
7799
|
slug?: string | null;
|
|
7781
7800
|
/**
|
|
7782
|
-
* Short summary
|
|
7801
|
+
* Short summary
|
|
7783
7802
|
*/
|
|
7784
7803
|
description?: string | null;
|
|
7785
7804
|
/**
|
|
@@ -7795,7 +7814,7 @@ interface LinkTag {
|
|
|
7795
7814
|
deletedAt?: string | null;
|
|
7796
7815
|
}
|
|
7797
7816
|
/**
|
|
7798
|
-
* Manage visual
|
|
7817
|
+
* Manage visual work surfaces and publishing status.
|
|
7799
7818
|
*
|
|
7800
7819
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7801
7820
|
* via the `definition` "canvases".
|
|
@@ -7809,7 +7828,7 @@ interface Canvase {
|
|
|
7809
7828
|
*/
|
|
7810
7829
|
subtitle?: string | null;
|
|
7811
7830
|
/**
|
|
7812
|
-
* Short summary
|
|
7831
|
+
* Short summary
|
|
7813
7832
|
*/
|
|
7814
7833
|
description?: string | null;
|
|
7815
7834
|
/**
|
|
@@ -7885,7 +7904,7 @@ interface CanvasCategory {
|
|
|
7885
7904
|
generateSlug?: boolean | null;
|
|
7886
7905
|
slug?: string | null;
|
|
7887
7906
|
/**
|
|
7888
|
-
* Short summary
|
|
7907
|
+
* Short summary
|
|
7889
7908
|
*/
|
|
7890
7909
|
description?: string | null;
|
|
7891
7910
|
/**
|
|
@@ -7919,7 +7938,7 @@ interface CanvasTag {
|
|
|
7919
7938
|
generateSlug?: boolean | null;
|
|
7920
7939
|
slug?: string | null;
|
|
7921
7940
|
/**
|
|
7922
|
-
* Short summary
|
|
7941
|
+
* Short summary
|
|
7923
7942
|
*/
|
|
7924
7943
|
description?: string | null;
|
|
7925
7944
|
/**
|
|
@@ -7951,7 +7970,7 @@ interface CanvasNodeType {
|
|
|
7951
7970
|
generateSlug?: boolean | null;
|
|
7952
7971
|
slug?: string | null;
|
|
7953
7972
|
/**
|
|
7954
|
-
* Short summary
|
|
7973
|
+
* Short summary
|
|
7955
7974
|
*/
|
|
7956
7975
|
description?: string | null;
|
|
7957
7976
|
/**
|
|
@@ -8022,7 +8041,7 @@ interface CanvasEdgeType {
|
|
|
8022
8041
|
generateSlug?: boolean | null;
|
|
8023
8042
|
slug?: string | null;
|
|
8024
8043
|
/**
|
|
8025
|
-
* Short summary
|
|
8044
|
+
* Short summary
|
|
8026
8045
|
*/
|
|
8027
8046
|
description?: string | null;
|
|
8028
8047
|
/**
|
|
@@ -8117,7 +8136,7 @@ interface CanvasEdge {
|
|
|
8117
8136
|
deletedAt?: string | null;
|
|
8118
8137
|
}
|
|
8119
8138
|
/**
|
|
8120
|
-
* Manage community
|
|
8139
|
+
* Manage community contributions, visibility, and review status.
|
|
8121
8140
|
*
|
|
8122
8141
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8123
8142
|
* via the `definition` "posts".
|
|
@@ -8189,12 +8208,12 @@ interface Post {
|
|
|
8189
8208
|
*/
|
|
8190
8209
|
isPinned?: boolean | null;
|
|
8191
8210
|
/**
|
|
8192
|
-
* Author/operator discussion toggle. When
|
|
8211
|
+
* Author/operator discussion toggle. When disabled, new comments are blocked.
|
|
8193
8212
|
*/
|
|
8194
8213
|
allowsComments?: boolean | null;
|
|
8195
8214
|
visibility?: ('visible' | 'hidden') | null;
|
|
8196
8215
|
/**
|
|
8197
|
-
* Moderator lock. When
|
|
8216
|
+
* Moderator lock. When enabled, new comments are blocked regardless of the Allow comments setting.
|
|
8198
8217
|
*/
|
|
8199
8218
|
isLocked?: boolean | null;
|
|
8200
8219
|
editedAt?: string | null;
|
|
@@ -8228,7 +8247,7 @@ interface PostCategory {
|
|
|
8228
8247
|
generateSlug?: boolean | null;
|
|
8229
8248
|
slug?: string | null;
|
|
8230
8249
|
/**
|
|
8231
|
-
* Short summary
|
|
8250
|
+
* Short summary
|
|
8232
8251
|
*/
|
|
8233
8252
|
description?: string | null;
|
|
8234
8253
|
/**
|
|
@@ -8248,7 +8267,7 @@ interface PostCategory {
|
|
|
8248
8267
|
deletedAt?: string | null;
|
|
8249
8268
|
}
|
|
8250
8269
|
/**
|
|
8251
|
-
*
|
|
8270
|
+
* Flat labels for post search and loose topic grouping.
|
|
8252
8271
|
*
|
|
8253
8272
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8254
8273
|
* via the `definition` "post-tags".
|
|
@@ -8264,7 +8283,7 @@ interface PostTag {
|
|
|
8264
8283
|
generateSlug?: boolean | null;
|
|
8265
8284
|
slug?: string | null;
|
|
8266
8285
|
/**
|
|
8267
|
-
* Short summary
|
|
8286
|
+
* Short summary
|
|
8268
8287
|
*/
|
|
8269
8288
|
description?: string | null;
|
|
8270
8289
|
/**
|
|
@@ -8346,7 +8365,7 @@ interface Reaction {
|
|
|
8346
8365
|
createdAt: string;
|
|
8347
8366
|
}
|
|
8348
8367
|
/**
|
|
8349
|
-
* Configure
|
|
8368
|
+
* Configure available ways to respond in community interactions.
|
|
8350
8369
|
*
|
|
8351
8370
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8352
8371
|
* via the `definition` "reaction-types".
|
|
@@ -8442,7 +8461,7 @@ interface CommunityBan {
|
|
|
8442
8461
|
createdAt: string;
|
|
8443
8462
|
}
|
|
8444
8463
|
/**
|
|
8445
|
-
* Manage
|
|
8464
|
+
* Manage display settings and operational defaults.
|
|
8446
8465
|
*
|
|
8447
8466
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8448
8467
|
* via the `definition` "event-calendars".
|
|
@@ -8456,7 +8475,7 @@ interface EventCalendar {
|
|
|
8456
8475
|
*/
|
|
8457
8476
|
subtitle?: string | null;
|
|
8458
8477
|
/**
|
|
8459
|
-
* Short summary
|
|
8478
|
+
* Short summary
|
|
8460
8479
|
*/
|
|
8461
8480
|
description?: string | null;
|
|
8462
8481
|
content?: {
|
|
@@ -8475,7 +8494,7 @@ interface EventCalendar {
|
|
|
8475
8494
|
[k: string]: unknown;
|
|
8476
8495
|
} | null;
|
|
8477
8496
|
/**
|
|
8478
|
-
* Default
|
|
8497
|
+
* Default behavior for public listings.
|
|
8479
8498
|
*/
|
|
8480
8499
|
publicListing?: {
|
|
8481
8500
|
/**
|
|
@@ -8526,7 +8545,7 @@ interface EventCalendar {
|
|
|
8526
8545
|
slug?: string | null;
|
|
8527
8546
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
8528
8547
|
/**
|
|
8529
|
-
* Default
|
|
8548
|
+
* Default time zone for new events. Existing events keep their saved time zone.
|
|
8530
8549
|
*/
|
|
8531
8550
|
timezone?: string | null;
|
|
8532
8551
|
/**
|
|
@@ -8534,7 +8553,7 @@ interface EventCalendar {
|
|
|
8534
8553
|
*/
|
|
8535
8554
|
color?: string | null;
|
|
8536
8555
|
/**
|
|
8537
|
-
* Visibility
|
|
8556
|
+
* Visibility applied across the workspace.
|
|
8538
8557
|
*/
|
|
8539
8558
|
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
8540
8559
|
publishedAt?: string | null;
|
|
@@ -8561,7 +8580,7 @@ interface EventTicketPurchasePrice {
|
|
|
8561
8580
|
deletedAt?: string | null;
|
|
8562
8581
|
}
|
|
8563
8582
|
/**
|
|
8564
|
-
* Manage paid
|
|
8583
|
+
* Manage paid enrollment offerings and benefit groups.
|
|
8565
8584
|
*
|
|
8566
8585
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8567
8586
|
* via the `definition` "membership-plans".
|
|
@@ -8580,7 +8599,7 @@ interface MembershipPlan {
|
|
|
8580
8599
|
generateSlug?: boolean | null;
|
|
8581
8600
|
slug?: string | null;
|
|
8582
8601
|
/**
|
|
8583
|
-
*
|
|
8602
|
+
* Included in public query responses for active plans. Do not enter internal notes that must not be shared with customers.
|
|
8584
8603
|
*/
|
|
8585
8604
|
description?: string | null;
|
|
8586
8605
|
/**
|
|
@@ -8600,7 +8619,7 @@ interface MembershipPlan {
|
|
|
8600
8619
|
*/
|
|
8601
8620
|
memberGroup: string | CustomerGroup;
|
|
8602
8621
|
/**
|
|
8603
|
-
* Billing-cycle and amount options for this plan. Add and edit prices directly here and drag to reorder them.
|
|
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.
|
|
8604
8623
|
*/
|
|
8605
8624
|
prices?: {
|
|
8606
8625
|
docs?: (string | MembershipPlanPrice)[];
|
|
@@ -8639,7 +8658,7 @@ interface MembershipPlanPrice {
|
|
|
8639
8658
|
currency: 'KRW' | 'USD' | 'EUR' | 'JPY';
|
|
8640
8659
|
billingInterval: 'month' | 'year';
|
|
8641
8660
|
/**
|
|
8642
|
-
*
|
|
8661
|
+
* For example, a monthly billing interval with a count of 3 bills every 3 months.
|
|
8643
8662
|
*/
|
|
8644
8663
|
intervalCount: number;
|
|
8645
8664
|
isActive?: boolean | null;
|
|
@@ -8677,7 +8696,7 @@ interface CustomerPaymentMethod {
|
|
|
8677
8696
|
deletedAt?: string | null;
|
|
8678
8697
|
}
|
|
8679
8698
|
/**
|
|
8680
|
-
* Review
|
|
8699
|
+
* Review enrollment status and renewal schedules.
|
|
8681
8700
|
*
|
|
8682
8701
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8683
8702
|
* via the `definition` "customer-memberships".
|
|
@@ -8703,19 +8722,19 @@ interface CustomerMembership {
|
|
|
8703
8722
|
billingInterval: 'month' | 'year';
|
|
8704
8723
|
intervalCount: number;
|
|
8705
8724
|
/**
|
|
8706
|
-
*
|
|
8725
|
+
* Free trial days saved when the subscription request was created.
|
|
8707
8726
|
*/
|
|
8708
8727
|
trialDaysSnapshot?: number | null;
|
|
8709
8728
|
/**
|
|
8710
|
-
*
|
|
8729
|
+
* Start time of the period set by the original subscription request; it cannot be changed.
|
|
8711
8730
|
*/
|
|
8712
8731
|
subscribePeriodStart?: string | null;
|
|
8713
8732
|
/**
|
|
8714
|
-
*
|
|
8733
|
+
* End time of the period set by the original subscription request; it cannot be changed.
|
|
8715
8734
|
*/
|
|
8716
8735
|
subscribePeriodEnd?: string | null;
|
|
8717
8736
|
/**
|
|
8718
|
-
*
|
|
8737
|
+
* Fingerprint of the historical paid-subscription recovery basis; it cannot be changed.
|
|
8719
8738
|
*/
|
|
8720
8739
|
historicalPaidRecoveryEvidence?: string | null;
|
|
8721
8740
|
currentPeriodStart?: string | null;
|
|
@@ -8748,7 +8767,7 @@ interface CustomerMembership {
|
|
|
8748
8767
|
deletedAt?: string | null;
|
|
8749
8768
|
}
|
|
8750
8769
|
/**
|
|
8751
|
-
*
|
|
8770
|
+
* Records of successful payment results that were not applied to membership activation or renewal at the time.
|
|
8752
8771
|
*
|
|
8753
8772
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8754
8773
|
* via the `definition` "membership-unapplied-paid-evidence".
|
|
@@ -8798,6 +8817,8 @@ interface MembershipCharge {
|
|
|
8798
8817
|
createdAt: string;
|
|
8799
8818
|
}
|
|
8800
8819
|
/**
|
|
8820
|
+
* Manage the membership delegated billing connection and charge URL.
|
|
8821
|
+
*
|
|
8801
8822
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8802
8823
|
* via the `definition` "tenant-payment-credentials".
|
|
8803
8824
|
*/
|
|
@@ -8858,7 +8879,7 @@ interface DirectUploadSession {
|
|
|
8858
8879
|
createdAt: string;
|
|
8859
8880
|
}
|
|
8860
8881
|
/**
|
|
8861
|
-
* Manage
|
|
8882
|
+
* Manage input structure and publishing status.
|
|
8862
8883
|
*
|
|
8863
8884
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8864
8885
|
* via the `definition` "forms".
|
|
@@ -8869,7 +8890,7 @@ interface Form {
|
|
|
8869
8890
|
tenant?: (string | null) | Tenant;
|
|
8870
8891
|
title: string;
|
|
8871
8892
|
/**
|
|
8872
|
-
* Short summary
|
|
8893
|
+
* Short summary
|
|
8873
8894
|
*/
|
|
8874
8895
|
description?: string | null;
|
|
8875
8896
|
isActive?: boolean | null;
|
|
@@ -10792,6 +10813,7 @@ interface OrderStagedChangesSelect<T extends boolean = true> {
|
|
|
10792
10813
|
*/
|
|
10793
10814
|
interface PaymentSessionsSelect<T extends boolean = true> {
|
|
10794
10815
|
tenant?: T;
|
|
10816
|
+
standardLongTailAlertedAt?: T;
|
|
10795
10817
|
finalizationAlertedAt?: T;
|
|
10796
10818
|
status?: T;
|
|
10797
10819
|
providerStatus?: T;
|
|
@@ -11284,6 +11306,7 @@ interface FulfillmentOrdersSelect<T extends boolean = true> {
|
|
|
11284
11306
|
items?: T;
|
|
11285
11307
|
adminNotes?: T;
|
|
11286
11308
|
metadata?: T;
|
|
11309
|
+
method?: T;
|
|
11287
11310
|
updatedAt?: T;
|
|
11288
11311
|
createdAt?: T;
|
|
11289
11312
|
deletedAt?: T;
|
|
@@ -11320,6 +11343,7 @@ interface FulfillmentsSelect<T extends boolean = true> {
|
|
|
11320
11343
|
items?: T;
|
|
11321
11344
|
adminNotes?: T;
|
|
11322
11345
|
metadata?: T;
|
|
11346
|
+
method?: T;
|
|
11323
11347
|
updatedAt?: T;
|
|
11324
11348
|
createdAt?: T;
|
|
11325
11349
|
deletedAt?: T;
|
|
@@ -11962,6 +11986,7 @@ interface CheckoutsSelect<T extends boolean = true> {
|
|
|
11962
11986
|
deliveryMessage?: T;
|
|
11963
11987
|
};
|
|
11964
11988
|
deliveryMethod?: T;
|
|
11989
|
+
source?: T;
|
|
11965
11990
|
items?: T;
|
|
11966
11991
|
activePaymentSession?: T;
|
|
11967
11992
|
currency?: T;
|
|
@@ -13450,12 +13475,12 @@ interface EventOccurrencesSelect<T extends boolean = true> {
|
|
|
13450
13475
|
*/
|
|
13451
13476
|
interface EventRegistrationsSelect<T extends boolean = true> {
|
|
13452
13477
|
tenant?: T;
|
|
13453
|
-
event?: T;
|
|
13454
|
-
occurrence?: T;
|
|
13455
|
-
customer?: T;
|
|
13456
13478
|
registrationStatus?: T;
|
|
13457
13479
|
attendanceStatus?: T;
|
|
13458
13480
|
quantity?: T;
|
|
13481
|
+
event?: T;
|
|
13482
|
+
occurrence?: T;
|
|
13483
|
+
customer?: T;
|
|
13459
13484
|
attendeeSnapshot?: T | {
|
|
13460
13485
|
name?: T;
|
|
13461
13486
|
email?: T;
|