@01.software/sdk 0.71.0 → 0.73.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 +118 -0
- package/README.md +71 -1
- package/dist/client.cjs +83 -9
- 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 +83 -9
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-D18xyUq_.d.cts → collection-client-BH4dIZ6c.d.cts} +4 -4
- package/dist/{collection-client-CUGJcTpl.d.ts → collection-client-lLAl3xCZ.d.ts} +4 -4
- package/dist/{const-oGEoxCXZ.d.cts → const-BS2EaIp4.d.cts} +1 -1
- package/dist/{const-Dlu0mXmj.d.ts → const-CCvoknRY.d.ts} +1 -1
- package/dist/{index-HHVtIKXs.d.cts → index-CHdrzJ8-.d.cts} +3 -3
- package/dist/{index-Ccd4NYTL.d.ts → index-DVqNpmsc.d.ts} +3 -3
- package/dist/index.cjs +84 -10
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +14 -11
- package/dist/index.d.ts +14 -11
- package/dist/index.js +84 -10
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-BgOEk6Y9.d.cts → payload-types-PXkmefhZ.d.cts} +267 -185
- package/dist/{payload-types-BgOEk6Y9.d.ts → payload-types-PXkmefhZ.d.ts} +267 -185
- 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 +113 -17
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +8 -7
- package/dist/server.d.ts +8 -7
- package/dist/server.js +113 -17
- package/dist/server.js.map +1 -1
- package/dist/{types-CSvp2fJ_.d.ts → types-CQRsG6sA.d.ts} +2 -2
- package/dist/{types-DLHEIsAx.d.cts → types-Chwgg4CQ.d.cts} +63 -7
- package/dist/{types-BzG3NO7R.d.cts → types-CyMz0Kzc.d.cts} +2 -2
- package/dist/{types-nyOvcO0K.d.ts → types-lbzbJSZh.d.ts} +63 -7
- 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
|
@@ -24,6 +24,7 @@ interface Config {
|
|
|
24
24
|
'webhook-deliveries': WebhookDelivery;
|
|
25
25
|
'webhook-outbox-deliveries': WebhookOutboxDelivery;
|
|
26
26
|
projects: Project;
|
|
27
|
+
'project-invitations': ProjectInvitation;
|
|
27
28
|
tenants: Tenant;
|
|
28
29
|
'tenant-metadata': TenantMetadatum;
|
|
29
30
|
'tenant-entitlements': TenantEntitlement;
|
|
@@ -273,6 +274,7 @@ interface Config {
|
|
|
273
274
|
'webhook-deliveries': WebhookDeliveriesSelect<false> | WebhookDeliveriesSelect<true>;
|
|
274
275
|
'webhook-outbox-deliveries': WebhookOutboxDeliveriesSelect<false> | WebhookOutboxDeliveriesSelect<true>;
|
|
275
276
|
projects: ProjectsSelect<false> | ProjectsSelect<true>;
|
|
277
|
+
'project-invitations': ProjectInvitationsSelect<false> | ProjectInvitationsSelect<true>;
|
|
276
278
|
tenants: TenantsSelect<false> | TenantsSelect<true>;
|
|
277
279
|
'tenant-metadata': TenantMetadataSelect<false> | TenantMetadataSelect<true>;
|
|
278
280
|
'tenant-entitlements': TenantEntitlementsSelect<false> | TenantEntitlementsSelect<true>;
|
|
@@ -542,7 +544,7 @@ interface CarouselBlock {
|
|
|
542
544
|
blockType: 'Carousel';
|
|
543
545
|
}
|
|
544
546
|
/**
|
|
545
|
-
* Manage
|
|
547
|
+
* Manage visual assets used by content and products.
|
|
546
548
|
*
|
|
547
549
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
548
550
|
* via the `definition` "images".
|
|
@@ -555,7 +557,7 @@ interface Image {
|
|
|
555
557
|
*/
|
|
556
558
|
alt?: string | null;
|
|
557
559
|
/**
|
|
558
|
-
*
|
|
560
|
+
* A low-resolution preview of the image.
|
|
559
561
|
*/
|
|
560
562
|
lqip?: string | null;
|
|
561
563
|
palette?: {
|
|
@@ -652,7 +654,7 @@ interface Tenant {
|
|
|
652
654
|
} | unknown[] | string | number | boolean | null;
|
|
653
655
|
name: string;
|
|
654
656
|
/**
|
|
655
|
-
*
|
|
657
|
+
* Time zone for workspace daily aggregation and AI usage date boundaries.
|
|
656
658
|
*/
|
|
657
659
|
timezone?: string | null;
|
|
658
660
|
/**
|
|
@@ -668,7 +670,7 @@ interface Tenant {
|
|
|
668
670
|
*/
|
|
669
671
|
slug?: string | null;
|
|
670
672
|
/**
|
|
671
|
-
*
|
|
673
|
+
* Register workspace-owned frontend origins for saved-record previews. Configure them separately from API CORS.
|
|
672
674
|
*/
|
|
673
675
|
previewDestinations?: {
|
|
674
676
|
origin: string;
|
|
@@ -683,7 +685,7 @@ interface Tenant {
|
|
|
683
685
|
id?: string | null;
|
|
684
686
|
}[] | null;
|
|
685
687
|
/**
|
|
686
|
-
*
|
|
688
|
+
* Currency for product prices and order amounts. Changing it re-denominates stored amounts with no conversion (KRW 15000 becomes USD 15,000), so it is refused once products or unsettled orders exist.
|
|
687
689
|
*/
|
|
688
690
|
shopCurrency?: string | null;
|
|
689
691
|
/**
|
|
@@ -719,11 +721,11 @@ interface Tenant {
|
|
|
719
721
|
*/
|
|
720
722
|
status?: ('active' | 'paused' | 'past_due' | 'canceled' | 'pending_deletion') | null;
|
|
721
723
|
/**
|
|
722
|
-
* A public key that
|
|
724
|
+
* A public key that identifies the workspace.
|
|
723
725
|
*/
|
|
724
726
|
publishableKey: string;
|
|
725
727
|
/**
|
|
726
|
-
*
|
|
728
|
+
* Allowed origins for browser API calls. Browser API calls are blocked when empty.
|
|
727
729
|
*/
|
|
728
730
|
cors?: {
|
|
729
731
|
origin: string;
|
|
@@ -769,19 +771,19 @@ interface Tenant {
|
|
|
769
771
|
};
|
|
770
772
|
};
|
|
771
773
|
/**
|
|
772
|
-
*
|
|
774
|
+
* Sender settings for notification and customer authentication emails.
|
|
773
775
|
*/
|
|
774
776
|
senderIdentity?: {
|
|
775
777
|
/**
|
|
776
|
-
*
|
|
778
|
+
* Sender name shown in the recipient's inbox.
|
|
777
779
|
*/
|
|
778
780
|
displayName?: string | null;
|
|
779
781
|
/**
|
|
780
|
-
* Address that receives customer replies
|
|
782
|
+
* Address that receives customer replies.
|
|
781
783
|
*/
|
|
782
784
|
replyTo?: string | null;
|
|
783
785
|
/**
|
|
784
|
-
*
|
|
786
|
+
* The platform sender address is used until verification.
|
|
785
787
|
*/
|
|
786
788
|
domain?: string | null;
|
|
787
789
|
/**
|
|
@@ -940,7 +942,11 @@ interface Project {
|
|
|
940
942
|
interface User {
|
|
941
943
|
id: string;
|
|
942
944
|
_users_members_order?: string | null;
|
|
945
|
+
invitationEmailVerified?: boolean | null;
|
|
943
946
|
roles: ('super-admin' | 'user')[];
|
|
947
|
+
/**
|
|
948
|
+
* Manage Project workspace (Live/Sandbox) members in Settings > Workspace > Project environments.
|
|
949
|
+
*/
|
|
944
950
|
tenants?: {
|
|
945
951
|
tenant: string | Tenant;
|
|
946
952
|
roles: ('tenant-admin' | 'tenant-editor' | 'tenant-viewer')[];
|
|
@@ -1111,7 +1117,7 @@ interface Audience {
|
|
|
1111
1117
|
interface EmailLog {
|
|
1112
1118
|
id: string;
|
|
1113
1119
|
/**
|
|
1114
|
-
*
|
|
1120
|
+
* The workspace that sent the email. System emails have no workspace assigned and can only be viewed by a Super Admin.
|
|
1115
1121
|
*/
|
|
1116
1122
|
tenant?: (string | null) | Tenant;
|
|
1117
1123
|
to: string;
|
|
@@ -1139,7 +1145,7 @@ interface EmailLog {
|
|
|
1139
1145
|
*/
|
|
1140
1146
|
recipientConsent?: ('marketing' | 'transactional' | 'service_notice') | null;
|
|
1141
1147
|
/**
|
|
1142
|
-
* Commerce notification send
|
|
1148
|
+
* Commerce notification send history. See the Consent category field for the notification’s consent classification.
|
|
1143
1149
|
*/
|
|
1144
1150
|
commerceNotification?: {
|
|
1145
1151
|
event?: ('orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnApproved' | 'returnRejected' | 'returnCanceled' | 'returnCompleted' | 'eventRegistrationConfirmed' | 'eventOccurrenceCanceled') | null;
|
|
@@ -1171,15 +1177,15 @@ interface CommerceNotificationIntent {
|
|
|
1171
1177
|
*/
|
|
1172
1178
|
recipientEmail?: string | null;
|
|
1173
1179
|
/**
|
|
1174
|
-
*
|
|
1180
|
+
* Notification category used to check recipient consent before sending.
|
|
1175
1181
|
*/
|
|
1176
1182
|
recipientConsent: 'marketing' | 'transactional' | 'service_notice';
|
|
1177
1183
|
/**
|
|
1178
|
-
*
|
|
1184
|
+
* Language to refer to when composing the notification.
|
|
1179
1185
|
*/
|
|
1180
1186
|
locale?: string | null;
|
|
1181
1187
|
/**
|
|
1182
|
-
*
|
|
1188
|
+
* Record of the event at the time it occurred, used to compose the notification. Contains no secrets.
|
|
1183
1189
|
*/
|
|
1184
1190
|
payload?: {
|
|
1185
1191
|
[k: string]: unknown;
|
|
@@ -1275,7 +1281,7 @@ interface Order {
|
|
|
1275
1281
|
*/
|
|
1276
1282
|
shippingAmount?: number | null;
|
|
1277
1283
|
/**
|
|
1278
|
-
* Shipping
|
|
1284
|
+
* Shipping charges saved at the time of the order.
|
|
1279
1285
|
*/
|
|
1280
1286
|
shippingLines?: {
|
|
1281
1287
|
label: string;
|
|
@@ -1320,7 +1326,7 @@ interface Order {
|
|
|
1320
1326
|
*/
|
|
1321
1327
|
appliedDiscount?: (string | null) | Discount;
|
|
1322
1328
|
/**
|
|
1323
|
-
* Discount
|
|
1329
|
+
* Discount applications saved when the order was created.
|
|
1324
1330
|
*/
|
|
1325
1331
|
appliedDiscounts?: {
|
|
1326
1332
|
code?: string | null;
|
|
@@ -1352,7 +1358,7 @@ interface Order {
|
|
|
1352
1358
|
currentTotalAmount?: number | null;
|
|
1353
1359
|
taxAmount?: number | null;
|
|
1354
1360
|
/**
|
|
1355
|
-
* Initial shipping refund policy
|
|
1361
|
+
* Initial shipping refund policy saved at the time of the order.
|
|
1356
1362
|
*/
|
|
1357
1363
|
returnShippingRefundPolicySnapshot?: {
|
|
1358
1364
|
[k: string]: unknown;
|
|
@@ -1396,7 +1402,7 @@ interface Order {
|
|
|
1396
1402
|
integrationMetadata?: {
|
|
1397
1403
|
[k: string]: unknown;
|
|
1398
1404
|
} | unknown[] | string | number | boolean | null;
|
|
1399
|
-
source?: ('web' | 'app' | 'manual' | 'api' | 'import') | null;
|
|
1405
|
+
source?: ('web' | 'app' | 'manual' | 'api' | 'import' | 'in_person') | null;
|
|
1400
1406
|
deliveryMethod?: ('shipping' | 'pickup') | null;
|
|
1401
1407
|
tags?: (string | OrderTag)[] | null;
|
|
1402
1408
|
tagSlugs?: {
|
|
@@ -1408,7 +1414,7 @@ interface Order {
|
|
|
1408
1414
|
*/
|
|
1409
1415
|
test?: boolean | null;
|
|
1410
1416
|
/**
|
|
1411
|
-
*
|
|
1417
|
+
* Pricing market saved when the order was created.
|
|
1412
1418
|
*/
|
|
1413
1419
|
market?: (string | null) | Market;
|
|
1414
1420
|
currency?: string | null;
|
|
@@ -1423,7 +1429,7 @@ interface Order {
|
|
|
1423
1429
|
deletedAt?: string | null;
|
|
1424
1430
|
}
|
|
1425
1431
|
/**
|
|
1426
|
-
* Manage
|
|
1432
|
+
* Manage contact information and account status.
|
|
1427
1433
|
*
|
|
1428
1434
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1429
1435
|
* via the `definition` "customers".
|
|
@@ -1449,12 +1455,12 @@ interface Customer {
|
|
|
1449
1455
|
*/
|
|
1450
1456
|
authProvider?: ('local' | 'google' | 'apple' | 'kakao' | 'naver') | null;
|
|
1451
1457
|
/**
|
|
1452
|
-
* External provider user ID.
|
|
1458
|
+
* External provider user ID. Identifies the linked account together with its sign-in provider and cannot be edited after creation.
|
|
1453
1459
|
*/
|
|
1454
1460
|
providerUserId?: string | null;
|
|
1455
1461
|
lastLoginAt?: string | null;
|
|
1456
1462
|
/**
|
|
1457
|
-
* Last password change
|
|
1463
|
+
* Last password change time, used to check whether earlier sign-in sessions are still valid.
|
|
1458
1464
|
*/
|
|
1459
1465
|
passwordChangedAt?: string | null;
|
|
1460
1466
|
orders?: {
|
|
@@ -1473,6 +1479,9 @@ interface Customer {
|
|
|
1473
1479
|
* Read-only, automatically counted orders, including pending orders, excluding canceled, refunded, returned, test and trashed orders.
|
|
1474
1480
|
*/
|
|
1475
1481
|
totalOrderCount?: number | null;
|
|
1482
|
+
/**
|
|
1483
|
+
* Order total in one verified currency. No value is provided when currencies are multiple or unverified.
|
|
1484
|
+
*/
|
|
1476
1485
|
lifetimeValue?: number | null;
|
|
1477
1486
|
firstOrderAt?: string | null;
|
|
1478
1487
|
lastOrderAt?: string | null;
|
|
@@ -1535,7 +1544,7 @@ interface Customer {
|
|
|
1535
1544
|
};
|
|
1536
1545
|
};
|
|
1537
1546
|
/**
|
|
1538
|
-
* Workspace self-reported value. It
|
|
1547
|
+
* Workspace self-reported value. It does not replace server-recorded hosted consent history.
|
|
1539
1548
|
*/
|
|
1540
1549
|
acceptsTos?: boolean | null;
|
|
1541
1550
|
/**
|
|
@@ -1574,7 +1583,7 @@ interface Customer {
|
|
|
1574
1583
|
collection: 'customers';
|
|
1575
1584
|
}
|
|
1576
1585
|
/**
|
|
1577
|
-
* Manage
|
|
1586
|
+
* Manage audience groupings for coupons, targeting, and badges.
|
|
1578
1587
|
*
|
|
1579
1588
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1580
1589
|
* via the `definition` "customer-groups".
|
|
@@ -1590,7 +1599,7 @@ interface CustomerGroup {
|
|
|
1590
1599
|
generateSlug?: boolean | null;
|
|
1591
1600
|
slug?: string | null;
|
|
1592
1601
|
/**
|
|
1593
|
-
* Short summary
|
|
1602
|
+
* Short summary
|
|
1594
1603
|
*/
|
|
1595
1604
|
description?: string | null;
|
|
1596
1605
|
/**
|
|
@@ -1659,7 +1668,7 @@ interface CustomerAddress {
|
|
|
1659
1668
|
*/
|
|
1660
1669
|
jibunAddress?: string | null;
|
|
1661
1670
|
/**
|
|
1662
|
-
* City (KR:
|
|
1671
|
+
* City (KR: 시/군, e.g. "Seoul", "Busan"; non-KR: city/town).
|
|
1663
1672
|
*/
|
|
1664
1673
|
city?: string | null;
|
|
1665
1674
|
/**
|
|
@@ -1884,7 +1893,7 @@ interface Product {
|
|
|
1884
1893
|
totalDocs?: number;
|
|
1885
1894
|
};
|
|
1886
1895
|
/**
|
|
1887
|
-
*
|
|
1896
|
+
* 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
1897
|
*/
|
|
1889
1898
|
markets?: (string | Market)[] | null;
|
|
1890
1899
|
/**
|
|
@@ -2002,7 +2011,7 @@ interface Product {
|
|
|
2002
2011
|
deletedAt?: string | null;
|
|
2003
2012
|
}
|
|
2004
2013
|
/**
|
|
2005
|
-
* Manage
|
|
2014
|
+
* Manage audiovisual content, processing, and publishing status.
|
|
2006
2015
|
*
|
|
2007
2016
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2008
2017
|
* via the `definition` "videos".
|
|
@@ -2017,7 +2026,7 @@ interface Video {
|
|
|
2017
2026
|
subtitle?: string | null;
|
|
2018
2027
|
filename?: string | null;
|
|
2019
2028
|
/**
|
|
2020
|
-
* Short summary
|
|
2029
|
+
* Short summary
|
|
2021
2030
|
*/
|
|
2022
2031
|
description?: string | null;
|
|
2023
2032
|
content?: {
|
|
@@ -2110,7 +2119,7 @@ interface Video {
|
|
|
2110
2119
|
deletedAt?: string | null;
|
|
2111
2120
|
}
|
|
2112
2121
|
/**
|
|
2113
|
-
* Manage
|
|
2122
|
+
* Manage broadcast schedules and transmission status.
|
|
2114
2123
|
*
|
|
2115
2124
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2116
2125
|
* via the `definition` "live-streams".
|
|
@@ -2124,7 +2133,7 @@ interface LiveStream {
|
|
|
2124
2133
|
*/
|
|
2125
2134
|
subtitle?: string | null;
|
|
2126
2135
|
/**
|
|
2127
|
-
* Short summary
|
|
2136
|
+
* Short summary
|
|
2128
2137
|
*/
|
|
2129
2138
|
description?: string | null;
|
|
2130
2139
|
/**
|
|
@@ -2218,7 +2227,7 @@ interface VideoCategory {
|
|
|
2218
2227
|
generateSlug?: boolean | null;
|
|
2219
2228
|
slug?: string | null;
|
|
2220
2229
|
/**
|
|
2221
|
-
* Short summary
|
|
2230
|
+
* Short summary
|
|
2222
2231
|
*/
|
|
2223
2232
|
description?: string | null;
|
|
2224
2233
|
/**
|
|
@@ -2252,7 +2261,7 @@ interface VideoTag {
|
|
|
2252
2261
|
generateSlug?: boolean | null;
|
|
2253
2262
|
slug?: string | null;
|
|
2254
2263
|
/**
|
|
2255
|
-
* Short summary
|
|
2264
|
+
* Short summary
|
|
2256
2265
|
*/
|
|
2257
2266
|
description?: string | null;
|
|
2258
2267
|
/**
|
|
@@ -2403,7 +2412,7 @@ interface Market {
|
|
|
2403
2412
|
}[];
|
|
2404
2413
|
currency: string;
|
|
2405
2414
|
/**
|
|
2406
|
-
*
|
|
2415
|
+
* Rate used to convert base-currency prices into this market currency.
|
|
2407
2416
|
*/
|
|
2408
2417
|
fxRateFromShopCurrency: number;
|
|
2409
2418
|
/**
|
|
@@ -2443,11 +2452,11 @@ interface InventoryAdjustment {
|
|
|
2443
2452
|
variant?: (string | null) | ProductVariant;
|
|
2444
2453
|
product?: (string | null) | Product;
|
|
2445
2454
|
/**
|
|
2446
|
-
* SKU
|
|
2455
|
+
* SKU saved at the time of the inventory adjustment.
|
|
2447
2456
|
*/
|
|
2448
2457
|
sku?: string | null;
|
|
2449
2458
|
/**
|
|
2450
|
-
* Variant
|
|
2459
|
+
* Variant name saved at the time of the inventory adjustment.
|
|
2451
2460
|
*/
|
|
2452
2461
|
variantTitle?: string | null;
|
|
2453
2462
|
/**
|
|
@@ -2503,7 +2512,7 @@ interface Return {
|
|
|
2503
2512
|
*/
|
|
2504
2513
|
rejectionReasonCode?: ('window_expired' | 'used_or_damaged' | 'non_returnable' | 'other') | null;
|
|
2505
2514
|
/**
|
|
2506
|
-
*
|
|
2515
|
+
* Describe any circumstances not covered by the selected reason.
|
|
2507
2516
|
*/
|
|
2508
2517
|
reasonDetail?: string | null;
|
|
2509
2518
|
/**
|
|
@@ -2519,7 +2528,7 @@ interface Return {
|
|
|
2519
2528
|
*/
|
|
2520
2529
|
canceledAt?: string | null;
|
|
2521
2530
|
/**
|
|
2522
|
-
*
|
|
2531
|
+
* Operator or server account that confirmed the return cancellation.
|
|
2523
2532
|
*/
|
|
2524
2533
|
canceledBy?: string | null;
|
|
2525
2534
|
items?: {
|
|
@@ -2533,7 +2542,7 @@ interface Return {
|
|
|
2533
2542
|
adminNotes?: string | null;
|
|
2534
2543
|
completedAt?: string | null;
|
|
2535
2544
|
/**
|
|
2536
|
-
*
|
|
2545
|
+
* Enter a receipt link where the refund can be reviewed.
|
|
2537
2546
|
*/
|
|
2538
2547
|
refundReceiptUrl?: string | null;
|
|
2539
2548
|
refundAmount: number;
|
|
@@ -2542,7 +2551,7 @@ interface Return {
|
|
|
2542
2551
|
*/
|
|
2543
2552
|
returnShippingFee?: number | null;
|
|
2544
2553
|
/**
|
|
2545
|
-
*
|
|
2554
|
+
* The portion of the original order shipping charge refunded with this return.
|
|
2546
2555
|
*/
|
|
2547
2556
|
initialShippingRefundAmount?: number | null;
|
|
2548
2557
|
initialShippingRefundSuggestedAmount?: number | null;
|
|
@@ -2655,7 +2664,7 @@ interface ProductOption {
|
|
|
2655
2664
|
*/
|
|
2656
2665
|
product: string | Product;
|
|
2657
2666
|
/**
|
|
2658
|
-
* Option
|
|
2667
|
+
* Option name. (e.g. Color, Size)
|
|
2659
2668
|
*/
|
|
2660
2669
|
title: string;
|
|
2661
2670
|
/**
|
|
@@ -2676,7 +2685,7 @@ interface ProductOption {
|
|
|
2676
2685
|
deletedAt?: string | null;
|
|
2677
2686
|
}
|
|
2678
2687
|
/**
|
|
2679
|
-
*
|
|
2688
|
+
* Organize products hierarchically for navigation and grouping.
|
|
2680
2689
|
*
|
|
2681
2690
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2682
2691
|
* via the `definition` "product-categories".
|
|
@@ -2692,7 +2701,7 @@ interface ProductCategory {
|
|
|
2692
2701
|
generateSlug?: boolean | null;
|
|
2693
2702
|
slug?: string | null;
|
|
2694
2703
|
/**
|
|
2695
|
-
* Short summary
|
|
2704
|
+
* Short summary
|
|
2696
2705
|
*/
|
|
2697
2706
|
description?: string | null;
|
|
2698
2707
|
/**
|
|
@@ -2712,7 +2721,7 @@ interface ProductCategory {
|
|
|
2712
2721
|
deletedAt?: string | null;
|
|
2713
2722
|
}
|
|
2714
2723
|
/**
|
|
2715
|
-
*
|
|
2724
|
+
* Flat labels for product search and loose grouping.
|
|
2716
2725
|
*
|
|
2717
2726
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2718
2727
|
* via the `definition` "product-tags".
|
|
@@ -2728,7 +2737,7 @@ interface ProductTag {
|
|
|
2728
2737
|
generateSlug?: boolean | null;
|
|
2729
2738
|
slug?: string | null;
|
|
2730
2739
|
/**
|
|
2731
|
-
* Short summary
|
|
2740
|
+
* Short summary
|
|
2732
2741
|
*/
|
|
2733
2742
|
description?: string | null;
|
|
2734
2743
|
/**
|
|
@@ -2744,7 +2753,7 @@ interface ProductTag {
|
|
|
2744
2753
|
deletedAt?: string | null;
|
|
2745
2754
|
}
|
|
2746
2755
|
/**
|
|
2747
|
-
* Manage
|
|
2756
|
+
* Manage details and logos linked to products.
|
|
2748
2757
|
*
|
|
2749
2758
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2750
2759
|
* via the `definition` "brands".
|
|
@@ -2755,7 +2764,7 @@ interface Brand {
|
|
|
2755
2764
|
tenant?: (string | null) | Tenant;
|
|
2756
2765
|
name: string;
|
|
2757
2766
|
/**
|
|
2758
|
-
* Short summary
|
|
2767
|
+
* Short summary
|
|
2759
2768
|
*/
|
|
2760
2769
|
description?: string | null;
|
|
2761
2770
|
content?: {
|
|
@@ -2848,7 +2857,7 @@ interface BrandLogo {
|
|
|
2848
2857
|
*/
|
|
2849
2858
|
alt?: string | null;
|
|
2850
2859
|
/**
|
|
2851
|
-
*
|
|
2860
|
+
* A low-resolution preview of the image.
|
|
2852
2861
|
*/
|
|
2853
2862
|
lqip?: string | null;
|
|
2854
2863
|
palette?: {
|
|
@@ -2968,7 +2977,7 @@ interface ProductCollection {
|
|
|
2968
2977
|
*/
|
|
2969
2978
|
subtitle?: string | null;
|
|
2970
2979
|
/**
|
|
2971
|
-
* Short summary
|
|
2980
|
+
* Short summary
|
|
2972
2981
|
*/
|
|
2973
2982
|
description?: string | null;
|
|
2974
2983
|
content?: {
|
|
@@ -3044,7 +3053,7 @@ interface ProductCollection {
|
|
|
3044
3053
|
deletedAt?: string | null;
|
|
3045
3054
|
}
|
|
3046
3055
|
/**
|
|
3047
|
-
* Manage shipping fee rules and default
|
|
3056
|
+
* Manage shipping fee rules and default delivery terms.
|
|
3048
3057
|
*
|
|
3049
3058
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3050
3059
|
* via the `definition` "shipping-policies".
|
|
@@ -3059,11 +3068,11 @@ interface ShippingPolicy {
|
|
|
3059
3068
|
*/
|
|
3060
3069
|
title?: string | null;
|
|
3061
3070
|
/**
|
|
3062
|
-
* Read-only
|
|
3071
|
+
* Read-only value from the previous rate model. Edit Shipping rates below.
|
|
3063
3072
|
*/
|
|
3064
3073
|
baseAmount?: number | null;
|
|
3065
3074
|
/**
|
|
3066
|
-
* Read-only
|
|
3075
|
+
* Read-only value from the previous rate model. Set up free shipping with an order-amount rate row priced at 0, or with an automatic discount whose Discount type is 'Free Shipping' and Min order amount is set. When you use a rate row, change the existing paid row's Condition to Order amount and cap it with a Max order amount below the free-shipping threshold so both rows never apply together.
|
|
3067
3076
|
*/
|
|
3068
3077
|
freeShippingMinAmount?: number | null;
|
|
3069
3078
|
rates?: {
|
|
@@ -3093,7 +3102,7 @@ interface ShippingPolicy {
|
|
|
3093
3102
|
id?: string | null;
|
|
3094
3103
|
}[] | null;
|
|
3095
3104
|
/**
|
|
3096
|
-
* Short summary
|
|
3105
|
+
* Short summary
|
|
3097
3106
|
*/
|
|
3098
3107
|
description?: string | null;
|
|
3099
3108
|
/**
|
|
@@ -3213,7 +3222,7 @@ interface CheckoutItem {
|
|
|
3213
3222
|
createdAt: string;
|
|
3214
3223
|
}
|
|
3215
3224
|
/**
|
|
3216
|
-
*
|
|
3225
|
+
* Track in-progress payment snapshots. Promoted to an order on payment.
|
|
3217
3226
|
*
|
|
3218
3227
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3219
3228
|
* via the `definition` "checkouts".
|
|
@@ -3247,7 +3256,7 @@ interface Checkout {
|
|
|
3247
3256
|
*/
|
|
3248
3257
|
cartRevision: number;
|
|
3249
3258
|
/**
|
|
3250
|
-
*
|
|
3259
|
+
* Pricing market saved when the checkout was created.
|
|
3251
3260
|
*/
|
|
3252
3261
|
market?: (string | null) | Market;
|
|
3253
3262
|
customer?: (string | null) | Customer;
|
|
@@ -3289,6 +3298,7 @@ interface Checkout {
|
|
|
3289
3298
|
deliveryMessage?: string | null;
|
|
3290
3299
|
};
|
|
3291
3300
|
deliveryMethod?: ('shipping' | 'pickup') | null;
|
|
3301
|
+
source?: ('web' | 'in_person') | null;
|
|
3292
3302
|
items?: {
|
|
3293
3303
|
docs?: (string | CheckoutItem)[];
|
|
3294
3304
|
hasNextPage?: boolean;
|
|
@@ -3324,7 +3334,7 @@ interface Checkout {
|
|
|
3324
3334
|
*/
|
|
3325
3335
|
appliedDiscount?: (string | null) | Discount;
|
|
3326
3336
|
/**
|
|
3327
|
-
* Discount
|
|
3337
|
+
* Discount applications saved at checkout.
|
|
3328
3338
|
*/
|
|
3329
3339
|
appliedDiscounts?: {
|
|
3330
3340
|
code?: string | null;
|
|
@@ -3459,7 +3469,7 @@ interface Cart {
|
|
|
3459
3469
|
openCheckout?: (string | null) | Checkout;
|
|
3460
3470
|
currency?: string | null;
|
|
3461
3471
|
/**
|
|
3462
|
-
* Market used for cart pricing.
|
|
3472
|
+
* Market used for cart pricing. Once a market is first determined when creating the cart or adding an item, it cannot change.
|
|
3463
3473
|
*/
|
|
3464
3474
|
market?: (string | null) | Market;
|
|
3465
3475
|
subtotalAmount?: number | null;
|
|
@@ -3493,7 +3503,7 @@ interface Cart {
|
|
|
3493
3503
|
createdAt: string;
|
|
3494
3504
|
}
|
|
3495
3505
|
/**
|
|
3496
|
-
* Manage
|
|
3506
|
+
* Manage coupon codes and automatic discounts applied at checkout, with eligibility rules and usage limits.
|
|
3497
3507
|
*
|
|
3498
3508
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3499
3509
|
* via the `definition` "discounts".
|
|
@@ -3580,7 +3590,7 @@ interface Discount {
|
|
|
3580
3590
|
*/
|
|
3581
3591
|
maxUses?: number | null;
|
|
3582
3592
|
/**
|
|
3583
|
-
* Read-only usage count
|
|
3593
|
+
* Read-only code discount usage count, including pending checkout reservations. Automatic discounts are not counted.
|
|
3584
3594
|
*/
|
|
3585
3595
|
usesCount?: number | null;
|
|
3586
3596
|
/**
|
|
@@ -3596,7 +3606,7 @@ interface Discount {
|
|
|
3596
3606
|
*/
|
|
3597
3607
|
isCombinable?: boolean | null;
|
|
3598
3608
|
/**
|
|
3599
|
-
*
|
|
3609
|
+
* Allocations other than “Across order”, including “Each line item”, are always rejected at checkout. Change to “Across order” and save.
|
|
3600
3610
|
*/
|
|
3601
3611
|
allocationMethod?: ('across' | 'each') | null;
|
|
3602
3612
|
/**
|
|
@@ -3654,6 +3664,7 @@ interface CartItem {
|
|
|
3654
3664
|
interface PaymentSession {
|
|
3655
3665
|
id: string;
|
|
3656
3666
|
tenant?: (string | null) | Tenant;
|
|
3667
|
+
standardLongTailAlertedAt?: string | null;
|
|
3657
3668
|
finalizationAlertedAt?: string | null;
|
|
3658
3669
|
status: 'pending' | 'captured' | 'failed' | 'canceled';
|
|
3659
3670
|
/**
|
|
@@ -3834,7 +3845,7 @@ interface CommercePaymentAccount {
|
|
|
3834
3845
|
deletedAt?: string | null;
|
|
3835
3846
|
}
|
|
3836
3847
|
/**
|
|
3837
|
-
* Manage
|
|
3848
|
+
* Manage schedules, locations, and recurrence rules.
|
|
3838
3849
|
*
|
|
3839
3850
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3840
3851
|
* via the `definition` "events".
|
|
@@ -3849,7 +3860,7 @@ interface Event {
|
|
|
3849
3860
|
*/
|
|
3850
3861
|
subtitle?: string | null;
|
|
3851
3862
|
/**
|
|
3852
|
-
* Short summary
|
|
3863
|
+
* Short summary
|
|
3853
3864
|
*/
|
|
3854
3865
|
description?: string | null;
|
|
3855
3866
|
content?: {
|
|
@@ -3890,7 +3901,7 @@ interface Event {
|
|
|
3890
3901
|
*/
|
|
3891
3902
|
endsAt: string;
|
|
3892
3903
|
/**
|
|
3893
|
-
*
|
|
3904
|
+
* Time zone used to expand recurring occurrences. After saving, changes require schedule conversion.
|
|
3894
3905
|
*/
|
|
3895
3906
|
timezone?: string | null;
|
|
3896
3907
|
isAllDay?: boolean | null;
|
|
@@ -3978,7 +3989,7 @@ interface Event {
|
|
|
3978
3989
|
totalDocs?: number;
|
|
3979
3990
|
};
|
|
3980
3991
|
/**
|
|
3981
|
-
* Registrations for this event.
|
|
3992
|
+
* Registrations for this event. Use the actions on the registration screen to change registration status and check in attendees.
|
|
3982
3993
|
*/
|
|
3983
3994
|
registrations?: {
|
|
3984
3995
|
docs?: (string | EventRegistration)[];
|
|
@@ -4028,7 +4039,7 @@ interface Event {
|
|
|
4028
4039
|
status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
|
|
4029
4040
|
coverImage?: (string | null) | Image;
|
|
4030
4041
|
/**
|
|
4031
|
-
* Public API visibility. Unlisted events
|
|
4042
|
+
* Public API visibility. Unlisted events are also included in public API reads.
|
|
4032
4043
|
*/
|
|
4033
4044
|
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
4034
4045
|
/**
|
|
@@ -4036,7 +4047,7 @@ interface Event {
|
|
|
4036
4047
|
*/
|
|
4037
4048
|
sourceType?: ('native' | 'external') | null;
|
|
4038
4049
|
/**
|
|
4039
|
-
* External event identity.
|
|
4050
|
+
* External event identity. Provider, source ID, and URL can all be included in public read responses.
|
|
4040
4051
|
*/
|
|
4041
4052
|
externalSource?: {
|
|
4042
4053
|
provider?: string | null;
|
|
@@ -4066,7 +4077,7 @@ interface EventCategory {
|
|
|
4066
4077
|
generateSlug?: boolean | null;
|
|
4067
4078
|
slug?: string | null;
|
|
4068
4079
|
/**
|
|
4069
|
-
* Short summary
|
|
4080
|
+
* Short summary
|
|
4070
4081
|
*/
|
|
4071
4082
|
description?: string | null;
|
|
4072
4083
|
/**
|
|
@@ -4100,7 +4111,7 @@ interface EventTag {
|
|
|
4100
4111
|
generateSlug?: boolean | null;
|
|
4101
4112
|
slug?: string | null;
|
|
4102
4113
|
/**
|
|
4103
|
-
* Short summary
|
|
4114
|
+
* Short summary
|
|
4104
4115
|
*/
|
|
4105
4116
|
description?: string | null;
|
|
4106
4117
|
/**
|
|
@@ -4130,7 +4141,7 @@ interface EventOccurrence {
|
|
|
4130
4141
|
displayTitle?: string | null;
|
|
4131
4142
|
event: string | Event;
|
|
4132
4143
|
/**
|
|
4133
|
-
*
|
|
4144
|
+
* Identifies this occurrence by its originally scheduled start time and time zone. Kept when you change this occurrence’s time.
|
|
4134
4145
|
*/
|
|
4135
4146
|
instanceKey?: string | null;
|
|
4136
4147
|
/**
|
|
@@ -4142,7 +4153,7 @@ interface EventOccurrence {
|
|
|
4142
4153
|
*/
|
|
4143
4154
|
endsAt: string;
|
|
4144
4155
|
/**
|
|
4145
|
-
*
|
|
4156
|
+
* Time zone used to distinguish this occurrence. It cannot be changed on an existing occurrence.
|
|
4146
4157
|
*/
|
|
4147
4158
|
timezone?: string | null;
|
|
4148
4159
|
isAllDay?: boolean | null;
|
|
@@ -4171,7 +4182,7 @@ interface EventOccurrence {
|
|
|
4171
4182
|
registrationCount?: number | null;
|
|
4172
4183
|
waitlistCount?: number | null;
|
|
4173
4184
|
/**
|
|
4174
|
-
* Registrations linked to this occurrence.
|
|
4185
|
+
* Registrations linked to this occurrence. Use the actions on the registration screen to change registration status and check in attendees.
|
|
4175
4186
|
*/
|
|
4176
4187
|
registrations?: {
|
|
4177
4188
|
docs?: (string | EventRegistration)[];
|
|
@@ -4198,18 +4209,6 @@ interface EventOccurrence {
|
|
|
4198
4209
|
interface EventRegistration {
|
|
4199
4210
|
id: string;
|
|
4200
4211
|
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
4212
|
/**
|
|
4214
4213
|
* Registration lifecycle status used for capacity accounting. Managed separately from attendance status.
|
|
4215
4214
|
*/
|
|
@@ -4222,6 +4221,18 @@ interface EventRegistration {
|
|
|
4222
4221
|
* Number of attendees for this registration. Used for attendee and capacity calculations.
|
|
4223
4222
|
*/
|
|
4224
4223
|
quantity?: number | null;
|
|
4224
|
+
/**
|
|
4225
|
+
* Event this registration belongs to.
|
|
4226
|
+
*/
|
|
4227
|
+
event: string | Event;
|
|
4228
|
+
/**
|
|
4229
|
+
* Occurrence this registration belongs to. Must belong to the same workspace as the event.
|
|
4230
|
+
*/
|
|
4231
|
+
occurrence: string | EventOccurrence;
|
|
4232
|
+
/**
|
|
4233
|
+
* Linked customer for authenticated registrations. Guest registrations may leave this empty.
|
|
4234
|
+
*/
|
|
4235
|
+
customer?: (string | null) | Customer;
|
|
4225
4236
|
/**
|
|
4226
4237
|
* PII snapshot captured at registration time. Hidden from publishable-key reads and subject to retention cleanup.
|
|
4227
4238
|
*/
|
|
@@ -4231,7 +4242,7 @@ interface EventRegistration {
|
|
|
4231
4242
|
phone?: string | null;
|
|
4232
4243
|
};
|
|
4233
4244
|
/**
|
|
4234
|
-
*
|
|
4245
|
+
* 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
4246
|
*/
|
|
4236
4247
|
attendeeEmail?: string | null;
|
|
4237
4248
|
/**
|
|
@@ -4289,7 +4300,7 @@ interface EventRegistration {
|
|
|
4289
4300
|
*/
|
|
4290
4301
|
guestTokenExpiresAt?: string | null;
|
|
4291
4302
|
/**
|
|
4292
|
-
* Retention deadline for attendee
|
|
4303
|
+
* Retention deadline for attendee personal information. Automated cleanup may delete personal information after this timestamp.
|
|
4293
4304
|
*/
|
|
4294
4305
|
piiRetentionUntil?: string | null;
|
|
4295
4306
|
/**
|
|
@@ -4304,7 +4315,7 @@ interface EventRegistration {
|
|
|
4304
4315
|
deletedAt?: string | null;
|
|
4305
4316
|
}
|
|
4306
4317
|
/**
|
|
4307
|
-
* Manage
|
|
4318
|
+
* Manage entry options and pricing references per occurrence.
|
|
4308
4319
|
*
|
|
4309
4320
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4310
4321
|
* via the `definition` "event-admission-types".
|
|
@@ -4315,7 +4326,7 @@ interface EventAdmissionType {
|
|
|
4315
4326
|
tenant?: (string | null) | Tenant;
|
|
4316
4327
|
label: string;
|
|
4317
4328
|
/**
|
|
4318
|
-
* Short summary
|
|
4329
|
+
* Short summary
|
|
4319
4330
|
*/
|
|
4320
4331
|
description?: string | null;
|
|
4321
4332
|
event: string | Event;
|
|
@@ -4324,7 +4335,7 @@ interface EventAdmissionType {
|
|
|
4324
4335
|
*/
|
|
4325
4336
|
occurrence?: (string | null) | EventOccurrence;
|
|
4326
4337
|
/**
|
|
4327
|
-
* Optional to save
|
|
4338
|
+
* Optional to save. To sell, select an active product variant with a product and price. Manage the amount on the linked product variant.
|
|
4328
4339
|
*/
|
|
4329
4340
|
priceReference?: (string | null) | ProductVariant;
|
|
4330
4341
|
/**
|
|
@@ -4333,10 +4344,16 @@ interface EventAdmissionType {
|
|
|
4333
4344
|
allowedCustomerGroups?: (string | CustomerGroup)[] | null;
|
|
4334
4345
|
firstRestrictedAt?: string | null;
|
|
4335
4346
|
/**
|
|
4336
|
-
* Optional
|
|
4347
|
+
* 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
4348
|
*/
|
|
4338
4349
|
maxQuantityPerOccurrence?: number | null;
|
|
4350
|
+
/**
|
|
4351
|
+
* The sale window includes this time.
|
|
4352
|
+
*/
|
|
4339
4353
|
validFrom?: string | null;
|
|
4354
|
+
/**
|
|
4355
|
+
* The sale window includes this end time.
|
|
4356
|
+
*/
|
|
4340
4357
|
validUntil?: string | null;
|
|
4341
4358
|
isActive?: boolean | null;
|
|
4342
4359
|
updatedAt: string;
|
|
@@ -4479,6 +4496,7 @@ interface FulfillmentOrder {
|
|
|
4479
4496
|
metadata?: {
|
|
4480
4497
|
[k: string]: unknown;
|
|
4481
4498
|
} | unknown[] | string | number | boolean | null;
|
|
4499
|
+
method?: ('shipping' | 'pickup') | null;
|
|
4482
4500
|
updatedAt: string;
|
|
4483
4501
|
createdAt: string;
|
|
4484
4502
|
deletedAt?: string | null;
|
|
@@ -4537,6 +4555,7 @@ interface Fulfillment {
|
|
|
4537
4555
|
metadata?: {
|
|
4538
4556
|
[k: string]: unknown;
|
|
4539
4557
|
} | unknown[] | string | number | boolean | null;
|
|
4558
|
+
method?: ('shipping' | 'pickup') | null;
|
|
4540
4559
|
updatedAt: string;
|
|
4541
4560
|
createdAt: string;
|
|
4542
4561
|
deletedAt?: string | null;
|
|
@@ -4565,7 +4584,7 @@ interface Transaction {
|
|
|
4565
4584
|
_title?: string | null;
|
|
4566
4585
|
type: 'payment' | 'refund';
|
|
4567
4586
|
/**
|
|
4568
|
-
*
|
|
4587
|
+
* Payment operation recorded by this transaction: authorization, sale, capture, void, or refund. See 'Type' for the payment/refund distinction.
|
|
4569
4588
|
*/
|
|
4570
4589
|
kind: 'authorization' | 'sale' | 'capture' | 'void' | 'refund';
|
|
4571
4590
|
/**
|
|
@@ -4576,7 +4595,7 @@ interface Transaction {
|
|
|
4576
4595
|
order?: (string | null) | Order;
|
|
4577
4596
|
amount?: number | null;
|
|
4578
4597
|
/**
|
|
4579
|
-
* Payment method
|
|
4598
|
+
* Payment method at the time of payment, as reported by the payment provider.
|
|
4580
4599
|
*/
|
|
4581
4600
|
paymentMethod?: string | null;
|
|
4582
4601
|
/**
|
|
@@ -4640,7 +4659,7 @@ interface Transaction {
|
|
|
4640
4659
|
deletedAt?: string | null;
|
|
4641
4660
|
}
|
|
4642
4661
|
/**
|
|
4643
|
-
*
|
|
4662
|
+
* Flat labels for order segmentation and filtering.
|
|
4644
4663
|
*
|
|
4645
4664
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4646
4665
|
* via the `definition` "order-tags".
|
|
@@ -4656,7 +4675,7 @@ interface OrderTag {
|
|
|
4656
4675
|
generateSlug?: boolean | null;
|
|
4657
4676
|
slug?: string | null;
|
|
4658
4677
|
/**
|
|
4659
|
-
* Short summary
|
|
4678
|
+
* Short summary
|
|
4660
4679
|
*/
|
|
4661
4680
|
description?: string | null;
|
|
4662
4681
|
/**
|
|
@@ -4797,15 +4816,15 @@ interface WebhookEvent {
|
|
|
4797
4816
|
id: string;
|
|
4798
4817
|
tenant?: (string | null) | Tenant;
|
|
4799
4818
|
/**
|
|
4800
|
-
* New
|
|
4819
|
+
* 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
4820
|
*/
|
|
4802
4821
|
ownershipScope?: ('tenant' | 'global' | 'unknown') | null;
|
|
4803
4822
|
/**
|
|
4804
|
-
*
|
|
4823
|
+
* The service that sent the event (for example, toss or mux).
|
|
4805
4824
|
*/
|
|
4806
4825
|
provider: string;
|
|
4807
4826
|
/**
|
|
4808
|
-
*
|
|
4827
|
+
* The event ID supplied by the provider. The provider and event ID together prevent duplicate receipt (idempotency key).
|
|
4809
4828
|
*/
|
|
4810
4829
|
eventId: string;
|
|
4811
4830
|
receivedAt?: string | null;
|
|
@@ -4923,31 +4942,31 @@ interface Webhook {
|
|
|
4923
4942
|
*/
|
|
4924
4943
|
name: string;
|
|
4925
4944
|
/**
|
|
4926
|
-
*
|
|
4945
|
+
* Only HTTPS addresses are allowed. This address receives sensitive workspace events.
|
|
4927
4946
|
*/
|
|
4928
4947
|
url: string;
|
|
4929
4948
|
/**
|
|
4930
|
-
*
|
|
4949
|
+
* The secret is stored encrypted.
|
|
4931
4950
|
*/
|
|
4932
4951
|
secret?: string | null;
|
|
4933
4952
|
/**
|
|
4934
|
-
* When the
|
|
4953
|
+
* When the secret was first shown.
|
|
4935
4954
|
*/
|
|
4936
4955
|
secretRevealedAt?: string | null;
|
|
4937
4956
|
/**
|
|
4938
|
-
*
|
|
4957
|
+
* When the secret was last replaced.
|
|
4939
4958
|
*/
|
|
4940
4959
|
secretRotatedAt?: string | null;
|
|
4941
4960
|
/**
|
|
4942
|
-
* User who last
|
|
4961
|
+
* User who last replaced the secret.
|
|
4943
4962
|
*/
|
|
4944
4963
|
secretRotatedBy?: (string | null) | User;
|
|
4945
4964
|
/**
|
|
4946
|
-
*
|
|
4965
|
+
* When empty, only ordinary item creation and update notifications are received. Some collections receive only commerce notifications; notifications for orders, fulfillments, returns, and customer memberships are received only when selected.
|
|
4947
4966
|
*/
|
|
4948
4967
|
subscriptions?: {
|
|
4949
4968
|
/**
|
|
4950
|
-
* Receives
|
|
4969
|
+
* Receives creation and update notifications and commerce notifications for the selected collection.
|
|
4951
4970
|
*/
|
|
4952
4971
|
collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | 'markets' | 'brands' | 'brand-logos' | 'orders' | 'order-items' | 'transactions' | 'fulfillment-orders' | 'fulfillment-order-items' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | 'shipping-policies' | 'shipping-zones' | 'customers' | 'customer-profiles' | 'customer-addresses' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-items' | 'gallery-categories' | 'gallery-tags' | 'links' | 'link-categories' | 'link-tags' | 'forms' | 'form-submissions' | 'articles' | 'article-authors' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'canvases' | 'canvas-node-types' | 'canvas-edge-types' | 'canvas-categories' | 'canvas-tags' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'post-tags' | 'customer-profile-stats' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags' | 'membership-plans' | 'membership-plan-prices' | 'canvas-nodes' | 'canvas-edges' | 'payment-sessions' | 'payment-refund-attempts' | 'customer-memberships';
|
|
4953
4972
|
id?: string | null;
|
|
@@ -4988,6 +5007,32 @@ interface WebhookOutboxDelivery {
|
|
|
4988
5007
|
updatedAt: string;
|
|
4989
5008
|
createdAt: string;
|
|
4990
5009
|
}
|
|
5010
|
+
/**
|
|
5011
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
5012
|
+
* via the `definition` "project-invitations".
|
|
5013
|
+
*/
|
|
5014
|
+
interface ProjectInvitation {
|
|
5015
|
+
id: string;
|
|
5016
|
+
project: string | Project;
|
|
5017
|
+
email: string;
|
|
5018
|
+
liveRoles?: {
|
|
5019
|
+
[k: string]: unknown;
|
|
5020
|
+
} | unknown[] | string | number | boolean | null;
|
|
5021
|
+
sandboxRoles?: {
|
|
5022
|
+
[k: string]: unknown;
|
|
5023
|
+
} | unknown[] | string | number | boolean | null;
|
|
5024
|
+
status: 'pending' | 'accepted' | 'revoked';
|
|
5025
|
+
tokenHash: string;
|
|
5026
|
+
tokenVersion: number;
|
|
5027
|
+
expiresAt: string;
|
|
5028
|
+
invitedBy?: (string | null) | User;
|
|
5029
|
+
acceptedBy?: (string | null) | User;
|
|
5030
|
+
acceptedAt?: string | null;
|
|
5031
|
+
revokedBy?: (string | null) | User;
|
|
5032
|
+
revokedAt?: string | null;
|
|
5033
|
+
updatedAt: string;
|
|
5034
|
+
createdAt: string;
|
|
5035
|
+
}
|
|
4991
5036
|
/**
|
|
4992
5037
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4993
5038
|
* via the `definition` "tenant-metadata".
|
|
@@ -5169,7 +5214,7 @@ interface TenantLogo {
|
|
|
5169
5214
|
*/
|
|
5170
5215
|
alt?: string | null;
|
|
5171
5216
|
/**
|
|
5172
|
-
*
|
|
5217
|
+
* A low-resolution preview of the image.
|
|
5173
5218
|
*/
|
|
5174
5219
|
lqip?: string | null;
|
|
5175
5220
|
palette?: {
|
|
@@ -5263,7 +5308,7 @@ interface TenantEntitlement {
|
|
|
5263
5308
|
tenant: string | Tenant;
|
|
5264
5309
|
plan: 'free' | 'starter' | 'basic' | 'pro' | 'enterprise';
|
|
5265
5310
|
/**
|
|
5266
|
-
*
|
|
5311
|
+
* The entitlement’s current lifecycle status. Only active entitlements count toward the current plan.
|
|
5267
5312
|
*/
|
|
5268
5313
|
status: 'active' | 'scheduled' | 'expired' | 'revoked';
|
|
5269
5314
|
sourceType: 'project_free' | 'subscription' | 'manual' | 'support' | 'promo' | 'trial' | 'enterprise_contract';
|
|
@@ -5274,7 +5319,7 @@ interface TenantEntitlement {
|
|
|
5274
5319
|
priority: number;
|
|
5275
5320
|
startsAt: string;
|
|
5276
5321
|
/**
|
|
5277
|
-
*
|
|
5322
|
+
* The date the entitlement expires. Required for promotion and trial entitlements, enforced by hook validation.
|
|
5278
5323
|
*/
|
|
5279
5324
|
endsAt?: string | null;
|
|
5280
5325
|
reason?: string | null;
|
|
@@ -5294,7 +5339,7 @@ interface TenantEntitlement {
|
|
|
5294
5339
|
interface Subscription {
|
|
5295
5340
|
id: string;
|
|
5296
5341
|
/**
|
|
5297
|
-
*
|
|
5342
|
+
* Billing is scoped to the project. The existing Live workspace link is retained for billing compatibility and historical evidence.
|
|
5298
5343
|
*/
|
|
5299
5344
|
project?: (string | null) | Project;
|
|
5300
5345
|
tenant: string | Tenant;
|
|
@@ -5389,7 +5434,13 @@ interface UsageRateCard {
|
|
|
5389
5434
|
notes?: string | null;
|
|
5390
5435
|
status: 'draft' | 'active' | 'archived';
|
|
5391
5436
|
currency: 'KRW';
|
|
5437
|
+
/**
|
|
5438
|
+
* Start of the new-registration window (inclusive).
|
|
5439
|
+
*/
|
|
5392
5440
|
effectiveFrom: string;
|
|
5441
|
+
/**
|
|
5442
|
+
* New registration is unavailable from this time.
|
|
5443
|
+
*/
|
|
5393
5444
|
effectiveTo?: string | null;
|
|
5394
5445
|
/**
|
|
5395
5446
|
* Base usage fee (KRW)
|
|
@@ -5624,7 +5675,7 @@ interface ApiUsage {
|
|
|
5624
5675
|
[k: string]: unknown;
|
|
5625
5676
|
} | unknown[] | string | number | boolean | null;
|
|
5626
5677
|
/**
|
|
5627
|
-
*
|
|
5678
|
+
* When the scheduled usage aggregation (cron) calculated usage for this month.
|
|
5628
5679
|
*/
|
|
5629
5680
|
snapshottedAt?: string | null;
|
|
5630
5681
|
updatedAt: string;
|
|
@@ -5771,28 +5822,28 @@ interface Refund {
|
|
|
5771
5822
|
status: 'succeeded' | 'failed';
|
|
5772
5823
|
source: 'return' | 'cancel' | 'operator' | 'adjustment';
|
|
5773
5824
|
/**
|
|
5774
|
-
*
|
|
5825
|
+
* Minor-unit amount in the refund ledger currency
|
|
5775
5826
|
*/
|
|
5776
5827
|
totalAmount: number;
|
|
5777
5828
|
fundingCheckout?: (string | null) | Checkout;
|
|
5778
5829
|
/**
|
|
5779
|
-
*
|
|
5830
|
+
* Minor-unit amount in the refund ledger currency
|
|
5780
5831
|
*/
|
|
5781
5832
|
creditAmount?: number | null;
|
|
5782
5833
|
/**
|
|
5783
|
-
*
|
|
5834
|
+
* Minor-unit amount in the refund ledger currency
|
|
5784
5835
|
*/
|
|
5785
5836
|
providerAmount?: number | null;
|
|
5786
5837
|
/**
|
|
5787
|
-
*
|
|
5838
|
+
* Minor-unit amount in the refund ledger currency
|
|
5788
5839
|
*/
|
|
5789
5840
|
lineAmount?: number | null;
|
|
5790
5841
|
/**
|
|
5791
|
-
*
|
|
5842
|
+
* Minor-unit amount in the refund ledger currency
|
|
5792
5843
|
*/
|
|
5793
5844
|
shippingAmount?: number | null;
|
|
5794
5845
|
/**
|
|
5795
|
-
*
|
|
5846
|
+
* Minor-unit amount in the refund ledger currency
|
|
5796
5847
|
*/
|
|
5797
5848
|
adjustmentAmount?: number | null;
|
|
5798
5849
|
currency?: string | null;
|
|
@@ -5819,12 +5870,12 @@ interface RefundLineItem {
|
|
|
5819
5870
|
lineType: 'item' | 'shipping' | 'adjustment';
|
|
5820
5871
|
quantity?: number | null;
|
|
5821
5872
|
/**
|
|
5822
|
-
*
|
|
5873
|
+
* Minor-unit amount in the parent refund currency
|
|
5823
5874
|
*/
|
|
5824
5875
|
amount: number;
|
|
5825
5876
|
restockAction?: ('return_to_stock' | 'discard' | 'no_restock') | null;
|
|
5826
5877
|
/**
|
|
5827
|
-
*
|
|
5878
|
+
* Minor-unit amount in the parent refund currency
|
|
5828
5879
|
*/
|
|
5829
5880
|
restockingFee?: number | null;
|
|
5830
5881
|
metadata?: {
|
|
@@ -6357,11 +6408,11 @@ interface InventoryReservation {
|
|
|
6357
6408
|
order?: (string | null) | Order;
|
|
6358
6409
|
orderItem?: (string | null) | OrderItem;
|
|
6359
6410
|
/**
|
|
6360
|
-
* Checkout
|
|
6411
|
+
* Checkout for this pre-payment inventory reservation. When the order is placed, the reservation is linked to that order.
|
|
6361
6412
|
*/
|
|
6362
6413
|
checkout?: (string | null) | Checkout;
|
|
6363
6414
|
/**
|
|
6364
|
-
* Checkout
|
|
6415
|
+
* Checkout item for this pre-payment inventory reservation. When the order is placed, the reservation is linked to that order item.
|
|
6365
6416
|
*/
|
|
6366
6417
|
checkoutItem?: (string | null) | CheckoutItem;
|
|
6367
6418
|
variant: string | ProductVariant;
|
|
@@ -6375,7 +6426,7 @@ interface InventoryReservation {
|
|
|
6375
6426
|
*/
|
|
6376
6427
|
statusChangedAt?: string | null;
|
|
6377
6428
|
/**
|
|
6378
|
-
* When a
|
|
6429
|
+
* When a reservation in the Pending state expires and is automatically released. Not recorded for other states.
|
|
6379
6430
|
*/
|
|
6380
6431
|
expiresAt?: string | null;
|
|
6381
6432
|
updatedAt: string;
|
|
@@ -6432,7 +6483,7 @@ interface OrderExportProfile {
|
|
|
6432
6483
|
[k: string]: unknown;
|
|
6433
6484
|
} | unknown[] | string | number | boolean | null;
|
|
6434
6485
|
/**
|
|
6435
|
-
* Short summary
|
|
6486
|
+
* Short summary
|
|
6436
6487
|
*/
|
|
6437
6488
|
description?: string | null;
|
|
6438
6489
|
/**
|
|
@@ -6528,7 +6579,7 @@ interface TenantCommerceConfig {
|
|
|
6528
6579
|
deletedAt?: string | null;
|
|
6529
6580
|
}
|
|
6530
6581
|
/**
|
|
6531
|
-
*
|
|
6582
|
+
* Server-recorded terms and privacy policy consent history from hosted signup and reconsent. Consent collected during direct signup is not included.
|
|
6532
6583
|
*
|
|
6533
6584
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6534
6585
|
* via the `definition` "customer-consent-receipts".
|
|
@@ -6629,7 +6680,7 @@ interface CustomerProfileList {
|
|
|
6629
6680
|
generateSlug?: boolean | null;
|
|
6630
6681
|
slug?: string | null;
|
|
6631
6682
|
/**
|
|
6632
|
-
* Short summary
|
|
6683
|
+
* Short summary
|
|
6633
6684
|
*/
|
|
6634
6685
|
description?: string | null;
|
|
6635
6686
|
isActive?: boolean | null;
|
|
@@ -6724,7 +6775,7 @@ interface DraftOrder {
|
|
|
6724
6775
|
*/
|
|
6725
6776
|
market?: (string | null) | Market;
|
|
6726
6777
|
/**
|
|
6727
|
-
*
|
|
6778
|
+
* Amounts saved from the last calculation.
|
|
6728
6779
|
*/
|
|
6729
6780
|
computedTotals?: {
|
|
6730
6781
|
subtotal?: number | null;
|
|
@@ -6797,7 +6848,7 @@ interface DraftOrderItem {
|
|
|
6797
6848
|
createdAt: string;
|
|
6798
6849
|
}
|
|
6799
6850
|
/**
|
|
6800
|
-
*
|
|
6851
|
+
* 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
6852
|
*
|
|
6802
6853
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6803
6854
|
* via the `definition` "benefit-voucher-definitions".
|
|
@@ -6813,7 +6864,7 @@ interface BenefitVoucherDefinition {
|
|
|
6813
6864
|
createdAt: string;
|
|
6814
6865
|
}
|
|
6815
6866
|
/**
|
|
6816
|
-
* Manage publishable
|
|
6867
|
+
* Manage publishable writing, authors, and classification.
|
|
6817
6868
|
*
|
|
6818
6869
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6819
6870
|
* via the `definition` "articles".
|
|
@@ -6828,7 +6879,7 @@ interface Article {
|
|
|
6828
6879
|
*/
|
|
6829
6880
|
subtitle?: string | null;
|
|
6830
6881
|
/**
|
|
6831
|
-
* Short summary
|
|
6882
|
+
* Short summary
|
|
6832
6883
|
*/
|
|
6833
6884
|
description?: string | null;
|
|
6834
6885
|
content?: {
|
|
@@ -6924,7 +6975,7 @@ interface Article {
|
|
|
6924
6975
|
deletedAt?: string | null;
|
|
6925
6976
|
}
|
|
6926
6977
|
/**
|
|
6927
|
-
* Manage
|
|
6978
|
+
* Manage contributor profiles and display details.
|
|
6928
6979
|
*
|
|
6929
6980
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6930
6981
|
* via the `definition` "article-authors".
|
|
@@ -6973,7 +7024,7 @@ interface ArticleCategory {
|
|
|
6973
7024
|
generateSlug?: boolean | null;
|
|
6974
7025
|
slug?: string | null;
|
|
6975
7026
|
/**
|
|
6976
|
-
* Short summary
|
|
7027
|
+
* Short summary
|
|
6977
7028
|
*/
|
|
6978
7029
|
description?: string | null;
|
|
6979
7030
|
/**
|
|
@@ -7007,7 +7058,7 @@ interface ArticleTag {
|
|
|
7007
7058
|
generateSlug?: boolean | null;
|
|
7008
7059
|
slug?: string | null;
|
|
7009
7060
|
/**
|
|
7010
|
-
* Short summary
|
|
7061
|
+
* Short summary
|
|
7011
7062
|
*/
|
|
7012
7063
|
description?: string | null;
|
|
7013
7064
|
/**
|
|
@@ -7023,7 +7074,7 @@ interface ArticleTag {
|
|
|
7023
7074
|
deletedAt?: string | null;
|
|
7024
7075
|
}
|
|
7025
7076
|
/**
|
|
7026
|
-
* Manage
|
|
7077
|
+
* Manage structured content and publishing status.
|
|
7027
7078
|
*
|
|
7028
7079
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7029
7080
|
* via the `definition` "documents".
|
|
@@ -7038,7 +7089,7 @@ interface Document {
|
|
|
7038
7089
|
*/
|
|
7039
7090
|
subtitle?: string | null;
|
|
7040
7091
|
/**
|
|
7041
|
-
* Short summary
|
|
7092
|
+
* Short summary
|
|
7042
7093
|
*/
|
|
7043
7094
|
description?: string | null;
|
|
7044
7095
|
content?: {
|
|
@@ -7162,7 +7213,7 @@ interface DocumentCategory {
|
|
|
7162
7213
|
generateSlug?: boolean | null;
|
|
7163
7214
|
slug?: string | null;
|
|
7164
7215
|
/**
|
|
7165
|
-
* Short summary
|
|
7216
|
+
* Short summary
|
|
7166
7217
|
*/
|
|
7167
7218
|
description?: string | null;
|
|
7168
7219
|
/**
|
|
@@ -7182,7 +7233,7 @@ interface DocumentCategory {
|
|
|
7182
7233
|
deletedAt?: string | null;
|
|
7183
7234
|
}
|
|
7184
7235
|
/**
|
|
7185
|
-
* Manage
|
|
7236
|
+
* Manage content formats used for classification.
|
|
7186
7237
|
*
|
|
7187
7238
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7188
7239
|
* via the `definition` "document-types".
|
|
@@ -7198,7 +7249,7 @@ interface DocumentType {
|
|
|
7198
7249
|
generateSlug?: boolean | null;
|
|
7199
7250
|
slug?: string | null;
|
|
7200
7251
|
/**
|
|
7201
|
-
* Short summary
|
|
7252
|
+
* Short summary
|
|
7202
7253
|
*/
|
|
7203
7254
|
description?: string | null;
|
|
7204
7255
|
/**
|
|
@@ -7229,7 +7280,7 @@ interface Playlist {
|
|
|
7229
7280
|
*/
|
|
7230
7281
|
subtitle?: string | null;
|
|
7231
7282
|
/**
|
|
7232
|
-
* Short summary
|
|
7283
|
+
* Short summary
|
|
7233
7284
|
*/
|
|
7234
7285
|
description?: string | null;
|
|
7235
7286
|
categories?: (string | PlaylistCategory)[] | null;
|
|
@@ -7301,7 +7352,7 @@ interface PlaylistCategory {
|
|
|
7301
7352
|
generateSlug?: boolean | null;
|
|
7302
7353
|
slug?: string | null;
|
|
7303
7354
|
/**
|
|
7304
|
-
* Short summary
|
|
7355
|
+
* Short summary
|
|
7305
7356
|
*/
|
|
7306
7357
|
description?: string | null;
|
|
7307
7358
|
/**
|
|
@@ -7335,7 +7386,7 @@ interface PlaylistTag {
|
|
|
7335
7386
|
generateSlug?: boolean | null;
|
|
7336
7387
|
slug?: string | null;
|
|
7337
7388
|
/**
|
|
7338
|
-
* Short summary
|
|
7389
|
+
* Short summary
|
|
7339
7390
|
*/
|
|
7340
7391
|
description?: string | null;
|
|
7341
7392
|
/**
|
|
@@ -7351,7 +7402,7 @@ interface PlaylistTag {
|
|
|
7351
7402
|
deletedAt?: string | null;
|
|
7352
7403
|
}
|
|
7353
7404
|
/**
|
|
7354
|
-
* Manage audio
|
|
7405
|
+
* Manage audio recordings and metadata used in playlists.
|
|
7355
7406
|
*
|
|
7356
7407
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7357
7408
|
* via the `definition` "tracks".
|
|
@@ -7362,7 +7413,7 @@ interface Track {
|
|
|
7362
7413
|
tenant?: (string | null) | Tenant;
|
|
7363
7414
|
title?: string | null;
|
|
7364
7415
|
/**
|
|
7365
|
-
* Short summary
|
|
7416
|
+
* Short summary
|
|
7366
7417
|
*/
|
|
7367
7418
|
description?: string | null;
|
|
7368
7419
|
artist?: string | null;
|
|
@@ -7416,7 +7467,7 @@ interface TrackCategory {
|
|
|
7416
7467
|
generateSlug?: boolean | null;
|
|
7417
7468
|
slug?: string | null;
|
|
7418
7469
|
/**
|
|
7419
|
-
* Short summary
|
|
7470
|
+
* Short summary
|
|
7420
7471
|
*/
|
|
7421
7472
|
description?: string | null;
|
|
7422
7473
|
/**
|
|
@@ -7450,7 +7501,7 @@ interface TrackTag {
|
|
|
7450
7501
|
generateSlug?: boolean | null;
|
|
7451
7502
|
slug?: string | null;
|
|
7452
7503
|
/**
|
|
7453
|
-
* Short summary
|
|
7504
|
+
* Short summary
|
|
7454
7505
|
*/
|
|
7455
7506
|
description?: string | null;
|
|
7456
7507
|
/**
|
|
@@ -7492,7 +7543,7 @@ interface TrackAsset {
|
|
|
7492
7543
|
focalY?: number | null;
|
|
7493
7544
|
}
|
|
7494
7545
|
/**
|
|
7495
|
-
* Manage image
|
|
7546
|
+
* Manage image groupings and display order.
|
|
7496
7547
|
*
|
|
7497
7548
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7498
7549
|
* via the `definition` "galleries".
|
|
@@ -7507,7 +7558,7 @@ interface Gallery {
|
|
|
7507
7558
|
*/
|
|
7508
7559
|
subtitle?: string | null;
|
|
7509
7560
|
/**
|
|
7510
|
-
* Short summary
|
|
7561
|
+
* Short summary
|
|
7511
7562
|
*/
|
|
7512
7563
|
description?: string | null;
|
|
7513
7564
|
/**
|
|
@@ -7585,7 +7636,7 @@ interface GalleryCategory {
|
|
|
7585
7636
|
generateSlug?: boolean | null;
|
|
7586
7637
|
slug?: string | null;
|
|
7587
7638
|
/**
|
|
7588
|
-
* Short summary
|
|
7639
|
+
* Short summary
|
|
7589
7640
|
*/
|
|
7590
7641
|
description?: string | null;
|
|
7591
7642
|
/**
|
|
@@ -7619,7 +7670,7 @@ interface GalleryTag {
|
|
|
7619
7670
|
generateSlug?: boolean | null;
|
|
7620
7671
|
slug?: string | null;
|
|
7621
7672
|
/**
|
|
7622
|
-
* Short summary
|
|
7673
|
+
* Short summary
|
|
7623
7674
|
*/
|
|
7624
7675
|
description?: string | null;
|
|
7625
7676
|
/**
|
|
@@ -7646,7 +7697,7 @@ interface GalleryItem {
|
|
|
7646
7697
|
gallery: string | Gallery;
|
|
7647
7698
|
title?: string | null;
|
|
7648
7699
|
/**
|
|
7649
|
-
* Short summary
|
|
7700
|
+
* Short summary
|
|
7650
7701
|
*/
|
|
7651
7702
|
description?: string | null;
|
|
7652
7703
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
@@ -7676,7 +7727,7 @@ interface GalleryItem {
|
|
|
7676
7727
|
deletedAt?: string | null;
|
|
7677
7728
|
}
|
|
7678
7729
|
/**
|
|
7679
|
-
* Manage external
|
|
7730
|
+
* Manage external addresses and related metadata.
|
|
7680
7731
|
*
|
|
7681
7732
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7682
7733
|
* via the `definition` "links".
|
|
@@ -7692,7 +7743,7 @@ interface Link {
|
|
|
7692
7743
|
subtitle?: string | null;
|
|
7693
7744
|
url: string;
|
|
7694
7745
|
/**
|
|
7695
|
-
* Short summary
|
|
7746
|
+
* Short summary
|
|
7696
7747
|
*/
|
|
7697
7748
|
description?: string | null;
|
|
7698
7749
|
categories?: (string | LinkCategory)[] | null;
|
|
@@ -7745,7 +7796,7 @@ interface LinkCategory {
|
|
|
7745
7796
|
generateSlug?: boolean | null;
|
|
7746
7797
|
slug?: string | null;
|
|
7747
7798
|
/**
|
|
7748
|
-
* Short summary
|
|
7799
|
+
* Short summary
|
|
7749
7800
|
*/
|
|
7750
7801
|
description?: string | null;
|
|
7751
7802
|
/**
|
|
@@ -7779,7 +7830,7 @@ interface LinkTag {
|
|
|
7779
7830
|
generateSlug?: boolean | null;
|
|
7780
7831
|
slug?: string | null;
|
|
7781
7832
|
/**
|
|
7782
|
-
* Short summary
|
|
7833
|
+
* Short summary
|
|
7783
7834
|
*/
|
|
7784
7835
|
description?: string | null;
|
|
7785
7836
|
/**
|
|
@@ -7795,7 +7846,7 @@ interface LinkTag {
|
|
|
7795
7846
|
deletedAt?: string | null;
|
|
7796
7847
|
}
|
|
7797
7848
|
/**
|
|
7798
|
-
* Manage visual
|
|
7849
|
+
* Manage visual work surfaces and publishing status.
|
|
7799
7850
|
*
|
|
7800
7851
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7801
7852
|
* via the `definition` "canvases".
|
|
@@ -7809,7 +7860,7 @@ interface Canvase {
|
|
|
7809
7860
|
*/
|
|
7810
7861
|
subtitle?: string | null;
|
|
7811
7862
|
/**
|
|
7812
|
-
* Short summary
|
|
7863
|
+
* Short summary
|
|
7813
7864
|
*/
|
|
7814
7865
|
description?: string | null;
|
|
7815
7866
|
/**
|
|
@@ -7885,7 +7936,7 @@ interface CanvasCategory {
|
|
|
7885
7936
|
generateSlug?: boolean | null;
|
|
7886
7937
|
slug?: string | null;
|
|
7887
7938
|
/**
|
|
7888
|
-
* Short summary
|
|
7939
|
+
* Short summary
|
|
7889
7940
|
*/
|
|
7890
7941
|
description?: string | null;
|
|
7891
7942
|
/**
|
|
@@ -7919,7 +7970,7 @@ interface CanvasTag {
|
|
|
7919
7970
|
generateSlug?: boolean | null;
|
|
7920
7971
|
slug?: string | null;
|
|
7921
7972
|
/**
|
|
7922
|
-
* Short summary
|
|
7973
|
+
* Short summary
|
|
7923
7974
|
*/
|
|
7924
7975
|
description?: string | null;
|
|
7925
7976
|
/**
|
|
@@ -7951,7 +8002,7 @@ interface CanvasNodeType {
|
|
|
7951
8002
|
generateSlug?: boolean | null;
|
|
7952
8003
|
slug?: string | null;
|
|
7953
8004
|
/**
|
|
7954
|
-
* Short summary
|
|
8005
|
+
* Short summary
|
|
7955
8006
|
*/
|
|
7956
8007
|
description?: string | null;
|
|
7957
8008
|
/**
|
|
@@ -8022,7 +8073,7 @@ interface CanvasEdgeType {
|
|
|
8022
8073
|
generateSlug?: boolean | null;
|
|
8023
8074
|
slug?: string | null;
|
|
8024
8075
|
/**
|
|
8025
|
-
* Short summary
|
|
8076
|
+
* Short summary
|
|
8026
8077
|
*/
|
|
8027
8078
|
description?: string | null;
|
|
8028
8079
|
/**
|
|
@@ -8117,7 +8168,7 @@ interface CanvasEdge {
|
|
|
8117
8168
|
deletedAt?: string | null;
|
|
8118
8169
|
}
|
|
8119
8170
|
/**
|
|
8120
|
-
* Manage community
|
|
8171
|
+
* Manage community contributions, visibility, and review status.
|
|
8121
8172
|
*
|
|
8122
8173
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8123
8174
|
* via the `definition` "posts".
|
|
@@ -8189,12 +8240,12 @@ interface Post {
|
|
|
8189
8240
|
*/
|
|
8190
8241
|
isPinned?: boolean | null;
|
|
8191
8242
|
/**
|
|
8192
|
-
* Author/operator discussion toggle. When
|
|
8243
|
+
* Author/operator discussion toggle. When disabled, new comments are blocked.
|
|
8193
8244
|
*/
|
|
8194
8245
|
allowsComments?: boolean | null;
|
|
8195
8246
|
visibility?: ('visible' | 'hidden') | null;
|
|
8196
8247
|
/**
|
|
8197
|
-
* Moderator lock. When
|
|
8248
|
+
* Moderator lock. When enabled, new comments are blocked regardless of the Allow comments setting.
|
|
8198
8249
|
*/
|
|
8199
8250
|
isLocked?: boolean | null;
|
|
8200
8251
|
editedAt?: string | null;
|
|
@@ -8228,7 +8279,7 @@ interface PostCategory {
|
|
|
8228
8279
|
generateSlug?: boolean | null;
|
|
8229
8280
|
slug?: string | null;
|
|
8230
8281
|
/**
|
|
8231
|
-
* Short summary
|
|
8282
|
+
* Short summary
|
|
8232
8283
|
*/
|
|
8233
8284
|
description?: string | null;
|
|
8234
8285
|
/**
|
|
@@ -8248,7 +8299,7 @@ interface PostCategory {
|
|
|
8248
8299
|
deletedAt?: string | null;
|
|
8249
8300
|
}
|
|
8250
8301
|
/**
|
|
8251
|
-
*
|
|
8302
|
+
* Flat labels for post search and loose topic grouping.
|
|
8252
8303
|
*
|
|
8253
8304
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8254
8305
|
* via the `definition` "post-tags".
|
|
@@ -8264,7 +8315,7 @@ interface PostTag {
|
|
|
8264
8315
|
generateSlug?: boolean | null;
|
|
8265
8316
|
slug?: string | null;
|
|
8266
8317
|
/**
|
|
8267
|
-
* Short summary
|
|
8318
|
+
* Short summary
|
|
8268
8319
|
*/
|
|
8269
8320
|
description?: string | null;
|
|
8270
8321
|
/**
|
|
@@ -8346,7 +8397,7 @@ interface Reaction {
|
|
|
8346
8397
|
createdAt: string;
|
|
8347
8398
|
}
|
|
8348
8399
|
/**
|
|
8349
|
-
* Configure
|
|
8400
|
+
* Configure available ways to respond in community interactions.
|
|
8350
8401
|
*
|
|
8351
8402
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8352
8403
|
* via the `definition` "reaction-types".
|
|
@@ -8442,7 +8493,7 @@ interface CommunityBan {
|
|
|
8442
8493
|
createdAt: string;
|
|
8443
8494
|
}
|
|
8444
8495
|
/**
|
|
8445
|
-
* Manage
|
|
8496
|
+
* Manage display settings and operational defaults.
|
|
8446
8497
|
*
|
|
8447
8498
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8448
8499
|
* via the `definition` "event-calendars".
|
|
@@ -8456,7 +8507,7 @@ interface EventCalendar {
|
|
|
8456
8507
|
*/
|
|
8457
8508
|
subtitle?: string | null;
|
|
8458
8509
|
/**
|
|
8459
|
-
* Short summary
|
|
8510
|
+
* Short summary
|
|
8460
8511
|
*/
|
|
8461
8512
|
description?: string | null;
|
|
8462
8513
|
content?: {
|
|
@@ -8475,7 +8526,7 @@ interface EventCalendar {
|
|
|
8475
8526
|
[k: string]: unknown;
|
|
8476
8527
|
} | null;
|
|
8477
8528
|
/**
|
|
8478
|
-
* Default
|
|
8529
|
+
* Default behavior for public listings.
|
|
8479
8530
|
*/
|
|
8480
8531
|
publicListing?: {
|
|
8481
8532
|
/**
|
|
@@ -8526,7 +8577,7 @@ interface EventCalendar {
|
|
|
8526
8577
|
slug?: string | null;
|
|
8527
8578
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
8528
8579
|
/**
|
|
8529
|
-
* Default
|
|
8580
|
+
* Default time zone for new events. Existing events keep their saved time zone.
|
|
8530
8581
|
*/
|
|
8531
8582
|
timezone?: string | null;
|
|
8532
8583
|
/**
|
|
@@ -8534,7 +8585,7 @@ interface EventCalendar {
|
|
|
8534
8585
|
*/
|
|
8535
8586
|
color?: string | null;
|
|
8536
8587
|
/**
|
|
8537
|
-
* Visibility
|
|
8588
|
+
* Visibility applied across the workspace.
|
|
8538
8589
|
*/
|
|
8539
8590
|
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
8540
8591
|
publishedAt?: string | null;
|
|
@@ -8561,7 +8612,7 @@ interface EventTicketPurchasePrice {
|
|
|
8561
8612
|
deletedAt?: string | null;
|
|
8562
8613
|
}
|
|
8563
8614
|
/**
|
|
8564
|
-
* Manage paid
|
|
8615
|
+
* Manage paid enrollment offerings and benefit groups.
|
|
8565
8616
|
*
|
|
8566
8617
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8567
8618
|
* via the `definition` "membership-plans".
|
|
@@ -8580,7 +8631,7 @@ interface MembershipPlan {
|
|
|
8580
8631
|
generateSlug?: boolean | null;
|
|
8581
8632
|
slug?: string | null;
|
|
8582
8633
|
/**
|
|
8583
|
-
*
|
|
8634
|
+
* Included in public query responses for active plans. Do not enter internal notes that must not be shared with customers.
|
|
8584
8635
|
*/
|
|
8585
8636
|
description?: string | null;
|
|
8586
8637
|
/**
|
|
@@ -8600,7 +8651,7 @@ interface MembershipPlan {
|
|
|
8600
8651
|
*/
|
|
8601
8652
|
memberGroup: string | CustomerGroup;
|
|
8602
8653
|
/**
|
|
8603
|
-
* Billing-cycle and amount options for this plan. Add and edit prices directly here and drag to reorder them.
|
|
8654
|
+
* 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
8655
|
*/
|
|
8605
8656
|
prices?: {
|
|
8606
8657
|
docs?: (string | MembershipPlanPrice)[];
|
|
@@ -8639,7 +8690,7 @@ interface MembershipPlanPrice {
|
|
|
8639
8690
|
currency: 'KRW' | 'USD' | 'EUR' | 'JPY';
|
|
8640
8691
|
billingInterval: 'month' | 'year';
|
|
8641
8692
|
/**
|
|
8642
|
-
*
|
|
8693
|
+
* For example, a monthly billing interval with a count of 3 bills every 3 months.
|
|
8643
8694
|
*/
|
|
8644
8695
|
intervalCount: number;
|
|
8645
8696
|
isActive?: boolean | null;
|
|
@@ -8677,7 +8728,7 @@ interface CustomerPaymentMethod {
|
|
|
8677
8728
|
deletedAt?: string | null;
|
|
8678
8729
|
}
|
|
8679
8730
|
/**
|
|
8680
|
-
* Review
|
|
8731
|
+
* Review enrollment status and renewal schedules.
|
|
8681
8732
|
*
|
|
8682
8733
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8683
8734
|
* via the `definition` "customer-memberships".
|
|
@@ -8703,19 +8754,19 @@ interface CustomerMembership {
|
|
|
8703
8754
|
billingInterval: 'month' | 'year';
|
|
8704
8755
|
intervalCount: number;
|
|
8705
8756
|
/**
|
|
8706
|
-
*
|
|
8757
|
+
* Free trial days saved when the subscription request was created.
|
|
8707
8758
|
*/
|
|
8708
8759
|
trialDaysSnapshot?: number | null;
|
|
8709
8760
|
/**
|
|
8710
|
-
*
|
|
8761
|
+
* Start time of the period set by the original subscription request; it cannot be changed.
|
|
8711
8762
|
*/
|
|
8712
8763
|
subscribePeriodStart?: string | null;
|
|
8713
8764
|
/**
|
|
8714
|
-
*
|
|
8765
|
+
* End time of the period set by the original subscription request; it cannot be changed.
|
|
8715
8766
|
*/
|
|
8716
8767
|
subscribePeriodEnd?: string | null;
|
|
8717
8768
|
/**
|
|
8718
|
-
*
|
|
8769
|
+
* Fingerprint of the historical paid-subscription recovery basis; it cannot be changed.
|
|
8719
8770
|
*/
|
|
8720
8771
|
historicalPaidRecoveryEvidence?: string | null;
|
|
8721
8772
|
currentPeriodStart?: string | null;
|
|
@@ -8748,7 +8799,7 @@ interface CustomerMembership {
|
|
|
8748
8799
|
deletedAt?: string | null;
|
|
8749
8800
|
}
|
|
8750
8801
|
/**
|
|
8751
|
-
*
|
|
8802
|
+
* Records of successful payment results that were not applied to membership activation or renewal at the time.
|
|
8752
8803
|
*
|
|
8753
8804
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8754
8805
|
* via the `definition` "membership-unapplied-paid-evidence".
|
|
@@ -8798,6 +8849,8 @@ interface MembershipCharge {
|
|
|
8798
8849
|
createdAt: string;
|
|
8799
8850
|
}
|
|
8800
8851
|
/**
|
|
8852
|
+
* Manage the membership delegated billing connection and charge URL.
|
|
8853
|
+
*
|
|
8801
8854
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8802
8855
|
* via the `definition` "tenant-payment-credentials".
|
|
8803
8856
|
*/
|
|
@@ -8858,7 +8911,7 @@ interface DirectUploadSession {
|
|
|
8858
8911
|
createdAt: string;
|
|
8859
8912
|
}
|
|
8860
8913
|
/**
|
|
8861
|
-
* Manage
|
|
8914
|
+
* Manage input structure and publishing status.
|
|
8862
8915
|
*
|
|
8863
8916
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8864
8917
|
* via the `definition` "forms".
|
|
@@ -8869,7 +8922,7 @@ interface Form {
|
|
|
8869
8922
|
tenant?: (string | null) | Tenant;
|
|
8870
8923
|
title: string;
|
|
8871
8924
|
/**
|
|
8872
|
-
* Short summary
|
|
8925
|
+
* Short summary
|
|
8873
8926
|
*/
|
|
8874
8927
|
description?: string | null;
|
|
8875
8928
|
isActive?: boolean | null;
|
|
@@ -9002,6 +9055,9 @@ interface Form {
|
|
|
9002
9055
|
redirect?: {
|
|
9003
9056
|
url: string;
|
|
9004
9057
|
};
|
|
9058
|
+
/**
|
|
9059
|
+
* Form submission emails are not sent. Settings are retained for compatibility.
|
|
9060
|
+
*/
|
|
9005
9061
|
emails?: {
|
|
9006
9062
|
emailTo?: string | null;
|
|
9007
9063
|
cc?: string | null;
|
|
@@ -9118,6 +9174,7 @@ interface PayloadMigration {
|
|
|
9118
9174
|
*/
|
|
9119
9175
|
interface UsersSelect<T extends boolean = true> {
|
|
9120
9176
|
_users_members_order?: T;
|
|
9177
|
+
invitationEmailVerified?: T;
|
|
9121
9178
|
roles?: T;
|
|
9122
9179
|
tenants?: T | {
|
|
9123
9180
|
tenant?: T;
|
|
@@ -9489,6 +9546,27 @@ interface ProjectsSelect<T extends boolean = true> {
|
|
|
9489
9546
|
updatedAt?: T;
|
|
9490
9547
|
createdAt?: T;
|
|
9491
9548
|
}
|
|
9549
|
+
/**
|
|
9550
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
9551
|
+
* via the `definition` "project-invitations_select".
|
|
9552
|
+
*/
|
|
9553
|
+
interface ProjectInvitationsSelect<T extends boolean = true> {
|
|
9554
|
+
project?: T;
|
|
9555
|
+
email?: T;
|
|
9556
|
+
liveRoles?: T;
|
|
9557
|
+
sandboxRoles?: T;
|
|
9558
|
+
status?: T;
|
|
9559
|
+
tokenHash?: T;
|
|
9560
|
+
tokenVersion?: T;
|
|
9561
|
+
expiresAt?: T;
|
|
9562
|
+
invitedBy?: T;
|
|
9563
|
+
acceptedBy?: T;
|
|
9564
|
+
acceptedAt?: T;
|
|
9565
|
+
revokedBy?: T;
|
|
9566
|
+
revokedAt?: T;
|
|
9567
|
+
updatedAt?: T;
|
|
9568
|
+
createdAt?: T;
|
|
9569
|
+
}
|
|
9492
9570
|
/**
|
|
9493
9571
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
9494
9572
|
* via the `definition` "tenants_select".
|
|
@@ -10792,6 +10870,7 @@ interface OrderStagedChangesSelect<T extends boolean = true> {
|
|
|
10792
10870
|
*/
|
|
10793
10871
|
interface PaymentSessionsSelect<T extends boolean = true> {
|
|
10794
10872
|
tenant?: T;
|
|
10873
|
+
standardLongTailAlertedAt?: T;
|
|
10795
10874
|
finalizationAlertedAt?: T;
|
|
10796
10875
|
status?: T;
|
|
10797
10876
|
providerStatus?: T;
|
|
@@ -11284,6 +11363,7 @@ interface FulfillmentOrdersSelect<T extends boolean = true> {
|
|
|
11284
11363
|
items?: T;
|
|
11285
11364
|
adminNotes?: T;
|
|
11286
11365
|
metadata?: T;
|
|
11366
|
+
method?: T;
|
|
11287
11367
|
updatedAt?: T;
|
|
11288
11368
|
createdAt?: T;
|
|
11289
11369
|
deletedAt?: T;
|
|
@@ -11320,6 +11400,7 @@ interface FulfillmentsSelect<T extends boolean = true> {
|
|
|
11320
11400
|
items?: T;
|
|
11321
11401
|
adminNotes?: T;
|
|
11322
11402
|
metadata?: T;
|
|
11403
|
+
method?: T;
|
|
11323
11404
|
updatedAt?: T;
|
|
11324
11405
|
createdAt?: T;
|
|
11325
11406
|
deletedAt?: T;
|
|
@@ -11962,6 +12043,7 @@ interface CheckoutsSelect<T extends boolean = true> {
|
|
|
11962
12043
|
deliveryMessage?: T;
|
|
11963
12044
|
};
|
|
11964
12045
|
deliveryMethod?: T;
|
|
12046
|
+
source?: T;
|
|
11965
12047
|
items?: T;
|
|
11966
12048
|
activePaymentSession?: T;
|
|
11967
12049
|
currency?: T;
|
|
@@ -13450,12 +13532,12 @@ interface EventOccurrencesSelect<T extends boolean = true> {
|
|
|
13450
13532
|
*/
|
|
13451
13533
|
interface EventRegistrationsSelect<T extends boolean = true> {
|
|
13452
13534
|
tenant?: T;
|
|
13453
|
-
event?: T;
|
|
13454
|
-
occurrence?: T;
|
|
13455
|
-
customer?: T;
|
|
13456
13535
|
registrationStatus?: T;
|
|
13457
13536
|
attendanceStatus?: T;
|
|
13458
13537
|
quantity?: T;
|
|
13538
|
+
event?: T;
|
|
13539
|
+
occurrence?: T;
|
|
13540
|
+
customer?: T;
|
|
13459
13541
|
attendeeSnapshot?: T | {
|
|
13460
13542
|
name?: T;
|
|
13461
13543
|
email?: T;
|