@01.software/sdk 0.41.1 → 0.43.0
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 +246 -0
- package/README.md +88 -19
- package/dist/analytics/react.cjs +71 -3
- package/dist/analytics/react.cjs.map +1 -1
- package/dist/analytics/react.d.cts +18 -2
- package/dist/analytics/react.d.ts +18 -2
- package/dist/analytics/react.js +67 -3
- package/dist/analytics/react.js.map +1 -1
- package/dist/analytics.cjs +6 -2
- package/dist/analytics.cjs.map +1 -1
- package/dist/analytics.d.cts +17 -4
- package/dist/analytics.d.ts +17 -4
- package/dist/analytics.js +6 -2
- package/dist/analytics.js.map +1 -1
- package/dist/client.cjs +233 -47
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +9 -6
- package/dist/client.d.ts +9 -6
- package/dist/client.js +233 -47
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-Bk--pNzW.d.cts → collection-client-U70KizLf.d.cts} +3 -3
- package/dist/{collection-client-BdcxkW7l.d.ts → collection-client-gWsA7BVP.d.ts} +3 -3
- package/dist/{const-qGGI7Uii.d.cts → const-BBynifk0.d.cts} +5 -5
- package/dist/{const-HwdntWtG.d.ts → const-_WWHU-gX.d.ts} +5 -5
- package/dist/{index-B1oW50RY.d.ts → index-DPi5NWU8.d.ts} +4 -4
- package/dist/{index-DiXtjVab.d.cts → index-Dg4Y6Aq7.d.cts} +4 -4
- package/dist/index.cjs +225 -358
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +41 -8
- package/dist/index.d.ts +41 -8
- package/dist/index.js +225 -358
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-CqJOgON7.d.cts → payload-types-DLxkB7Mv.d.cts} +561 -123
- package/dist/{payload-types-CqJOgON7.d.ts → payload-types-DLxkB7Mv.d.ts} +561 -123
- package/dist/query.cjs +59 -7
- package/dist/query.cjs.map +1 -1
- package/dist/query.d.cts +5 -5
- package/dist/query.d.ts +5 -5
- package/dist/query.js +59 -7
- package/dist/query.js.map +1 -1
- package/dist/realtime.cjs +1 -1
- package/dist/realtime.cjs.map +1 -1
- package/dist/realtime.d.cts +2 -2
- package/dist/realtime.d.ts +2 -2
- package/dist/realtime.js +1 -1
- package/dist/realtime.js.map +1 -1
- package/dist/server.cjs +318 -61
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +12 -7
- package/dist/server.d.ts +12 -7
- package/dist/server.js +318 -61
- package/dist/server.js.map +1 -1
- package/dist/{types-ByLSG-O3.d.cts → types-B1ngKbWI.d.cts} +1 -1
- package/dist/{types-BKa9z9s2.d.cts → types-B9lGhZlB.d.ts} +229 -15
- package/dist/{types-BMI3M0nb.d.ts → types-BiKNBwRA.d.ts} +1 -1
- package/dist/{types-DgfXb7iV.d.ts → types-Bpx5sYKo.d.cts} +229 -15
- package/dist/ui/canvas.cjs.map +1 -1
- package/dist/ui/canvas.js.map +1 -1
- 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.cjs +3 -1
- package/dist/webhook.cjs.map +1 -1
- package/dist/webhook.d.cts +4 -4
- package/dist/webhook.d.ts +4 -4
- package/dist/webhook.js +3 -1
- package/dist/webhook.js.map +1 -1
- package/package.json +1 -1
|
@@ -61,6 +61,7 @@ interface Config {
|
|
|
61
61
|
'shipping-policies': ShippingPolicy;
|
|
62
62
|
'shipping-zones': ShippingZone;
|
|
63
63
|
'tenant-commerce-config': TenantCommerceConfig;
|
|
64
|
+
markets: Market;
|
|
64
65
|
customers: Customer;
|
|
65
66
|
'customer-profiles': CustomerProfile;
|
|
66
67
|
'customer-profile-stats': CustomerProfileStat;
|
|
@@ -119,6 +120,11 @@ interface Config {
|
|
|
119
120
|
'event-tags': EventTag;
|
|
120
121
|
'event-occurrences': EventOccurrence;
|
|
121
122
|
'event-registrations': EventRegistration;
|
|
123
|
+
'membership-plans': MembershipPlan;
|
|
124
|
+
'customer-payment-methods': CustomerPaymentMethod;
|
|
125
|
+
'customer-memberships': CustomerMembership;
|
|
126
|
+
'membership-charges': MembershipCharge;
|
|
127
|
+
'tenant-payment-credentials': TenantPaymentCredential;
|
|
122
128
|
'direct-upload-sessions': DirectUploadSession;
|
|
123
129
|
forms: Form;
|
|
124
130
|
'form-submissions': FormSubmission;
|
|
@@ -251,6 +257,7 @@ interface Config {
|
|
|
251
257
|
'shipping-policies': ShippingPoliciesSelect<false> | ShippingPoliciesSelect<true>;
|
|
252
258
|
'shipping-zones': ShippingZonesSelect<false> | ShippingZonesSelect<true>;
|
|
253
259
|
'tenant-commerce-config': TenantCommerceConfigSelect<false> | TenantCommerceConfigSelect<true>;
|
|
260
|
+
markets: MarketsSelect<false> | MarketsSelect<true>;
|
|
254
261
|
customers: CustomersSelect<false> | CustomersSelect<true>;
|
|
255
262
|
'customer-profiles': CustomerProfilesSelect<false> | CustomerProfilesSelect<true>;
|
|
256
263
|
'customer-profile-stats': CustomerProfileStatsSelect<false> | CustomerProfileStatsSelect<true>;
|
|
@@ -309,6 +316,11 @@ interface Config {
|
|
|
309
316
|
'event-tags': EventTagsSelect<false> | EventTagsSelect<true>;
|
|
310
317
|
'event-occurrences': EventOccurrencesSelect<false> | EventOccurrencesSelect<true>;
|
|
311
318
|
'event-registrations': EventRegistrationsSelect<false> | EventRegistrationsSelect<true>;
|
|
319
|
+
'membership-plans': MembershipPlansSelect<false> | MembershipPlansSelect<true>;
|
|
320
|
+
'customer-payment-methods': CustomerPaymentMethodsSelect<false> | CustomerPaymentMethodsSelect<true>;
|
|
321
|
+
'customer-memberships': CustomerMembershipsSelect<false> | CustomerMembershipsSelect<true>;
|
|
322
|
+
'membership-charges': MembershipChargesSelect<false> | MembershipChargesSelect<true>;
|
|
323
|
+
'tenant-payment-credentials': TenantPaymentCredentialsSelect<false> | TenantPaymentCredentialsSelect<true>;
|
|
312
324
|
'direct-upload-sessions': DirectUploadSessionsSelect<false> | DirectUploadSessionsSelect<true>;
|
|
313
325
|
forms: FormsSelect<false> | FormsSelect<true>;
|
|
314
326
|
'form-submissions': FormSubmissionsSelect<false> | FormSubmissionsSelect<true>;
|
|
@@ -442,7 +454,7 @@ interface Image {
|
|
|
442
454
|
id: string;
|
|
443
455
|
tenant?: (string | null) | Tenant;
|
|
444
456
|
/**
|
|
445
|
-
*
|
|
457
|
+
* Alt text for the image, used by screen readers and search/share previews.
|
|
446
458
|
*/
|
|
447
459
|
alt?: string | null;
|
|
448
460
|
/**
|
|
@@ -545,6 +557,10 @@ interface Tenant {
|
|
|
545
557
|
draftPath?: string | null;
|
|
546
558
|
id?: string | null;
|
|
547
559
|
}[] | null;
|
|
560
|
+
/**
|
|
561
|
+
* Base currency for the tenant store.
|
|
562
|
+
*/
|
|
563
|
+
shopCurrency?: string | null;
|
|
548
564
|
/**
|
|
549
565
|
* Tenant owner. Only the owner can delete the tenant or transfer ownership.
|
|
550
566
|
*/
|
|
@@ -552,7 +568,7 @@ interface Tenant {
|
|
|
552
568
|
/**
|
|
553
569
|
* Only features checked above will be enabled for this tenant.
|
|
554
570
|
*/
|
|
555
|
-
enabledFeatures?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'articles' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community' | 'events')[] | null;
|
|
571
|
+
enabledFeatures?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'articles' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community' | 'events' | 'membership')[] | null;
|
|
556
572
|
/**
|
|
557
573
|
* Only selected relationship recipes are active for this tenant. Recipes whose required features are disabled keep their stored intent but remain inactive at runtime.
|
|
558
574
|
*/
|
|
@@ -562,7 +578,7 @@ interface Tenant {
|
|
|
562
578
|
[k: string]: unknown;
|
|
563
579
|
} | unknown[] | string | number | boolean | null;
|
|
564
580
|
/**
|
|
565
|
-
* Tenant lifecycle status. Managed
|
|
581
|
+
* Tenant lifecycle status. Managed automatically.
|
|
566
582
|
*/
|
|
567
583
|
status?: ('active' | 'paused' | 'past_due' | 'canceled' | 'pending_deletion') | null;
|
|
568
584
|
/**
|
|
@@ -600,10 +616,45 @@ interface Tenant {
|
|
|
600
616
|
* Allow customer email sends for this event.
|
|
601
617
|
*/
|
|
602
618
|
returnRequested?: boolean | null;
|
|
619
|
+
/**
|
|
620
|
+
* Allow customer email sends for this event.
|
|
621
|
+
*/
|
|
622
|
+
returnApproved?: boolean | null;
|
|
623
|
+
/**
|
|
624
|
+
* Allow customer email sends for this event.
|
|
625
|
+
*/
|
|
626
|
+
returnRejected?: boolean | null;
|
|
603
627
|
/**
|
|
604
628
|
* Allow customer email sends for this event.
|
|
605
629
|
*/
|
|
606
630
|
returnCompleted?: boolean | null;
|
|
631
|
+
/**
|
|
632
|
+
* Brand name shown in the recipient's inbox. Leave blank to use the platform default sender. (The send-from address stays on the platform domain.)
|
|
633
|
+
*/
|
|
634
|
+
senderDisplayName?: string | null;
|
|
635
|
+
/**
|
|
636
|
+
* Address that receives customer replies to notification emails. Leave blank to omit reply-to.
|
|
637
|
+
*/
|
|
638
|
+
senderReplyTo?: string | null;
|
|
639
|
+
/**
|
|
640
|
+
* Your own sending domain (e.g. mail.example.com). After registration and verification, mail is sent from this domain. Until verified, sending safely falls back to the platform sender.
|
|
641
|
+
*/
|
|
642
|
+
senderDomain?: string | null;
|
|
643
|
+
/**
|
|
644
|
+
* The part of the from-address before @ (e.g. noreply, orders). Defaults to noreply when blank.
|
|
645
|
+
*/
|
|
646
|
+
senderLocalpart?: string | null;
|
|
647
|
+
/**
|
|
648
|
+
* Sending domain verification status. Managed automatically.
|
|
649
|
+
*/
|
|
650
|
+
senderDomainStatus?: string | null;
|
|
651
|
+
senderDomainResendId?: string | null;
|
|
652
|
+
/**
|
|
653
|
+
* DNS records required to verify the domain. Filled in automatically.
|
|
654
|
+
*/
|
|
655
|
+
senderDomainRecords?: {
|
|
656
|
+
[k: string]: unknown;
|
|
657
|
+
} | unknown[] | string | number | boolean | null;
|
|
607
658
|
};
|
|
608
659
|
/**
|
|
609
660
|
* Users connected to this tenant
|
|
@@ -636,7 +687,7 @@ interface User {
|
|
|
636
687
|
acceptsUsageAlerts?: boolean | null;
|
|
637
688
|
};
|
|
638
689
|
/**
|
|
639
|
-
* Admin contact phone number.
|
|
690
|
+
* Admin contact phone number.
|
|
640
691
|
*/
|
|
641
692
|
phone?: string | null;
|
|
642
693
|
isPhoneVerified?: boolean | null;
|
|
@@ -826,7 +877,7 @@ interface EmailLog {
|
|
|
826
877
|
* Commerce notification send audit metadata. Consent classification remains owned by recipientConsent.
|
|
827
878
|
*/
|
|
828
879
|
commerceNotification?: {
|
|
829
|
-
event?: ('orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnCompleted') | null;
|
|
880
|
+
event?: ('orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnApproved' | 'returnRejected' | 'returnCompleted') | null;
|
|
830
881
|
intent?: (string | null) | CommerceNotificationIntent;
|
|
831
882
|
dedupeKey?: string | null;
|
|
832
883
|
order?: (string | null) | Order;
|
|
@@ -848,7 +899,7 @@ interface CommerceNotificationIntent {
|
|
|
848
899
|
* Stable key that prevents duplicate notification intents within a tenant.
|
|
849
900
|
*/
|
|
850
901
|
dedupeKey: string;
|
|
851
|
-
event: 'orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnCompleted';
|
|
902
|
+
event: 'orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnApproved' | 'returnRejected' | 'returnCompleted';
|
|
852
903
|
status: 'queued' | 'processing' | 'sent' | 'failed' | 'canceled';
|
|
853
904
|
/**
|
|
854
905
|
* Customer email address targeted by this notification.
|
|
@@ -897,7 +948,7 @@ interface Order {
|
|
|
897
948
|
/**
|
|
898
949
|
* Fulfillment status used for order lists and filters.
|
|
899
950
|
*/
|
|
900
|
-
displayFulfillmentStatus: 'unfulfilled' | 'in_progress' | 'on_hold' | 'shipped' | 'fulfilled' | 'canceled';
|
|
951
|
+
displayFulfillmentStatus: 'unfulfilled' | 'in_progress' | 'on_hold' | 'partially_fulfilled' | 'shipped' | 'fulfilled' | 'canceled';
|
|
901
952
|
/**
|
|
902
953
|
* Return status used for order lists and filters. Orders without active returns read as no_return.
|
|
903
954
|
*/
|
|
@@ -972,6 +1023,10 @@ interface Order {
|
|
|
972
1023
|
* Cumulative refunded amount
|
|
973
1024
|
*/
|
|
974
1025
|
refundedAmount?: number | null;
|
|
1026
|
+
/**
|
|
1027
|
+
* Current order total after refunds (totalAmount − refundedAmount)
|
|
1028
|
+
*/
|
|
1029
|
+
currentTotalAmount?: number | null;
|
|
975
1030
|
taxAmount?: number | null;
|
|
976
1031
|
/**
|
|
977
1032
|
* Initial shipping refund policy snapshot at order time
|
|
@@ -991,6 +1046,10 @@ interface Order {
|
|
|
991
1046
|
placedAt?: string | null;
|
|
992
1047
|
confirmedAt?: string | null;
|
|
993
1048
|
cancelReason?: string | null;
|
|
1049
|
+
/**
|
|
1050
|
+
* Structured cancel reason code (Shopify cancelReason parity), set automatically on cancel. Free-text detail stays in the cancel reason field.
|
|
1051
|
+
*/
|
|
1052
|
+
cancelReasonCode?: ('customer' | 'inventory' | 'fraud' | 'declined' | 'staff' | 'other') | null;
|
|
994
1053
|
canceledAt?: string | null;
|
|
995
1054
|
completedAt?: string | null;
|
|
996
1055
|
billingAddress?: {
|
|
@@ -1065,7 +1124,7 @@ interface Customer {
|
|
|
1065
1124
|
defaultShippingAddress?: (string | null) | CustomerAddress;
|
|
1066
1125
|
defaultBillingAddress?: (string | null) | CustomerAddress;
|
|
1067
1126
|
/**
|
|
1068
|
-
* Read-only
|
|
1127
|
+
* Read-only number of this customer's completed orders. Counted automatically.
|
|
1069
1128
|
*/
|
|
1070
1129
|
totalOrderCount?: number | null;
|
|
1071
1130
|
lifetimeValue?: number | null;
|
|
@@ -1261,7 +1320,7 @@ interface CustomerAddress {
|
|
|
1261
1320
|
*/
|
|
1262
1321
|
deliveryRequest?: ('security_office' | 'handoff_in_person' | 'call_before' | 'leave_at_door' | 'other') | null;
|
|
1263
1322
|
/**
|
|
1264
|
-
* Free-form delivery note
|
|
1323
|
+
* Free-form delivery note for the courier.
|
|
1265
1324
|
*/
|
|
1266
1325
|
deliveryNote?: string | null;
|
|
1267
1326
|
updatedAt: string;
|
|
@@ -1314,13 +1373,13 @@ interface OrderItem {
|
|
|
1314
1373
|
tenant?: (string | null) | Tenant;
|
|
1315
1374
|
order: string | Order;
|
|
1316
1375
|
/**
|
|
1317
|
-
*
|
|
1376
|
+
* Product purchased at order time.
|
|
1318
1377
|
*/
|
|
1319
1378
|
product: string | Product;
|
|
1320
1379
|
variant?: (string | null) | ProductVariant;
|
|
1321
1380
|
quantity: number;
|
|
1322
1381
|
/**
|
|
1323
|
-
* Unit-price snapshot at order time.
|
|
1382
|
+
* Unit-price snapshot at order time.
|
|
1324
1383
|
*/
|
|
1325
1384
|
unitPrice: number;
|
|
1326
1385
|
variantTitle?: string | null;
|
|
@@ -1334,7 +1393,7 @@ interface OrderItem {
|
|
|
1334
1393
|
totalPrice: number;
|
|
1335
1394
|
productTitle?: string | null;
|
|
1336
1395
|
/**
|
|
1337
|
-
* Option combination snapshot at order time.
|
|
1396
|
+
* Option combination snapshot at order time.
|
|
1338
1397
|
*/
|
|
1339
1398
|
optionSelection?: {
|
|
1340
1399
|
[k: string]: unknown;
|
|
@@ -1348,15 +1407,15 @@ interface OrderItem {
|
|
|
1348
1407
|
*/
|
|
1349
1408
|
currency?: string | null;
|
|
1350
1409
|
/**
|
|
1351
|
-
* Snapshot of the discount amount allocated to this line at order time
|
|
1410
|
+
* Snapshot of the discount amount allocated to this line at order time.
|
|
1352
1411
|
*/
|
|
1353
1412
|
discountAllocation?: number | null;
|
|
1354
1413
|
/**
|
|
1355
|
-
* Per-unit price snapshot after discount allocation
|
|
1414
|
+
* Per-unit price snapshot after discount allocation at order time.
|
|
1356
1415
|
*/
|
|
1357
1416
|
discountedUnitPrice?: number | null;
|
|
1358
1417
|
/**
|
|
1359
|
-
* Line total snapshot after discount allocation at order time
|
|
1418
|
+
* Line total snapshot after discount allocation at order time.
|
|
1360
1419
|
*/
|
|
1361
1420
|
discountedTotalPrice?: number | null;
|
|
1362
1421
|
updatedAt: string;
|
|
@@ -1387,7 +1446,7 @@ interface Product {
|
|
|
1387
1446
|
*/
|
|
1388
1447
|
images?: (string | Image)[] | null;
|
|
1389
1448
|
/**
|
|
1390
|
-
*
|
|
1449
|
+
* Attach videos to this content.
|
|
1391
1450
|
*/
|
|
1392
1451
|
videos?: (string | Video)[] | null;
|
|
1393
1452
|
/**
|
|
@@ -1424,6 +1483,10 @@ interface Product {
|
|
|
1424
1483
|
* Brand used for storefront filtering.
|
|
1425
1484
|
*/
|
|
1426
1485
|
brand?: (string | null) | Brand;
|
|
1486
|
+
/**
|
|
1487
|
+
* Markets where this product is available. Leave empty to exclude it from market-aware catalogs.
|
|
1488
|
+
*/
|
|
1489
|
+
markets?: (string | Market)[] | null;
|
|
1427
1490
|
/**
|
|
1428
1491
|
* Shipping policy for this product.
|
|
1429
1492
|
*/
|
|
@@ -1502,7 +1565,7 @@ interface Product {
|
|
|
1502
1565
|
*/
|
|
1503
1566
|
description?: string | null;
|
|
1504
1567
|
/**
|
|
1505
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
1568
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
1506
1569
|
*/
|
|
1507
1570
|
image?: (string | null) | Image;
|
|
1508
1571
|
};
|
|
@@ -1577,7 +1640,7 @@ interface Video {
|
|
|
1577
1640
|
categories?: (string | VideoCategory)[] | null;
|
|
1578
1641
|
tags?: (string | VideoTag)[] | null;
|
|
1579
1642
|
/**
|
|
1580
|
-
* Mux processing status. Updated
|
|
1643
|
+
* Mux processing status. Updated automatically.
|
|
1581
1644
|
*/
|
|
1582
1645
|
muxStatus?: ('waiting' | 'preparing' | 'ready' | 'errored') | null;
|
|
1583
1646
|
durationSeconds?: number | null;
|
|
@@ -1615,7 +1678,7 @@ interface Video {
|
|
|
1615
1678
|
*/
|
|
1616
1679
|
description?: string | null;
|
|
1617
1680
|
/**
|
|
1618
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
1681
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
1619
1682
|
*/
|
|
1620
1683
|
image?: (string | null) | Image;
|
|
1621
1684
|
};
|
|
@@ -1676,7 +1739,7 @@ interface LiveStream {
|
|
|
1676
1739
|
*/
|
|
1677
1740
|
reconnectWindowSeconds?: number | null;
|
|
1678
1741
|
/**
|
|
1679
|
-
* Mux live stream status. Updated
|
|
1742
|
+
* Mux live stream status. Updated automatically.
|
|
1680
1743
|
*/
|
|
1681
1744
|
muxStatus?: ('idle' | 'active' | 'disabled') | null;
|
|
1682
1745
|
muxLiveStreamId?: string | null;
|
|
@@ -1713,7 +1776,7 @@ interface LiveStream {
|
|
|
1713
1776
|
*/
|
|
1714
1777
|
description?: string | null;
|
|
1715
1778
|
/**
|
|
1716
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
1779
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
1717
1780
|
*/
|
|
1718
1781
|
image?: (string | null) | Image;
|
|
1719
1782
|
};
|
|
@@ -1761,7 +1824,7 @@ interface VideoCategory {
|
|
|
1761
1824
|
*/
|
|
1762
1825
|
description?: string | null;
|
|
1763
1826
|
/**
|
|
1764
|
-
* Single representative
|
|
1827
|
+
* Single representative image for this taxonomy entry.
|
|
1765
1828
|
*/
|
|
1766
1829
|
image?: (string | null) | Image;
|
|
1767
1830
|
/**
|
|
@@ -1769,7 +1832,7 @@ interface VideoCategory {
|
|
|
1769
1832
|
*/
|
|
1770
1833
|
parent?: (string | null) | VideoCategory;
|
|
1771
1834
|
/**
|
|
1772
|
-
* Optional #RRGGBB
|
|
1835
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
1773
1836
|
*/
|
|
1774
1837
|
color?: string | null;
|
|
1775
1838
|
updatedAt: string;
|
|
@@ -1795,11 +1858,11 @@ interface VideoTag {
|
|
|
1795
1858
|
*/
|
|
1796
1859
|
description?: string | null;
|
|
1797
1860
|
/**
|
|
1798
|
-
* Single representative
|
|
1861
|
+
* Single representative image for this taxonomy entry.
|
|
1799
1862
|
*/
|
|
1800
1863
|
image?: (string | null) | Image;
|
|
1801
1864
|
/**
|
|
1802
|
-
* Optional #RRGGBB
|
|
1865
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
1803
1866
|
*/
|
|
1804
1867
|
color?: string | null;
|
|
1805
1868
|
updatedAt: string;
|
|
@@ -1840,6 +1903,10 @@ interface ProductVariant {
|
|
|
1840
1903
|
* Sell without tracking inventory
|
|
1841
1904
|
*/
|
|
1842
1905
|
isUnlimited?: boolean | null;
|
|
1906
|
+
/**
|
|
1907
|
+
* Whether to allow backorder (overselling) when stock reaches zero. Not applicable to unlimited variants.
|
|
1908
|
+
*/
|
|
1909
|
+
inventoryPolicy?: ('deny' | 'continue') | null;
|
|
1843
1910
|
/**
|
|
1844
1911
|
* Available quantity is stock minus reserved stock.
|
|
1845
1912
|
*/
|
|
@@ -1877,7 +1944,7 @@ interface ProductVariant {
|
|
|
1877
1944
|
*/
|
|
1878
1945
|
barcode?: string | null;
|
|
1879
1946
|
/**
|
|
1880
|
-
*
|
|
1947
|
+
* Enter this variant weight as an integer in grams.
|
|
1881
1948
|
*/
|
|
1882
1949
|
weight?: number | null;
|
|
1883
1950
|
/**
|
|
@@ -1938,7 +2005,7 @@ interface InventoryAdjustment {
|
|
|
1938
2005
|
availableBefore: number;
|
|
1939
2006
|
availableAfter: number;
|
|
1940
2007
|
/**
|
|
1941
|
-
*
|
|
2008
|
+
* Who performed the adjustment (a user, a customer, or the system).
|
|
1942
2009
|
*/
|
|
1943
2010
|
actor: string;
|
|
1944
2011
|
note?: string | null;
|
|
@@ -1969,6 +2036,10 @@ interface Return {
|
|
|
1969
2036
|
* Reason category for the return or refund request. Used for reporting and operations.
|
|
1970
2037
|
*/
|
|
1971
2038
|
reason?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other') | null;
|
|
2039
|
+
/**
|
|
2040
|
+
* Structured return rejection reason code, set automatically on rejection and used in the customer notification.
|
|
2041
|
+
*/
|
|
2042
|
+
rejectionReasonCode?: ('window_expired' | 'used_or_damaged' | 'non_returnable' | 'other') | null;
|
|
1972
2043
|
/**
|
|
1973
2044
|
* Detailed return reason
|
|
1974
2045
|
*/
|
|
@@ -2147,7 +2218,7 @@ interface ProductCategory {
|
|
|
2147
2218
|
*/
|
|
2148
2219
|
description?: string | null;
|
|
2149
2220
|
/**
|
|
2150
|
-
* Single representative
|
|
2221
|
+
* Single representative image for this taxonomy entry.
|
|
2151
2222
|
*/
|
|
2152
2223
|
image?: (string | null) | Image;
|
|
2153
2224
|
/**
|
|
@@ -2155,7 +2226,7 @@ interface ProductCategory {
|
|
|
2155
2226
|
*/
|
|
2156
2227
|
parent?: (string | null) | ProductCategory;
|
|
2157
2228
|
/**
|
|
2158
|
-
* Optional #RRGGBB
|
|
2229
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
2159
2230
|
*/
|
|
2160
2231
|
color?: string | null;
|
|
2161
2232
|
updatedAt: string;
|
|
@@ -2183,11 +2254,11 @@ interface ProductTag {
|
|
|
2183
2254
|
*/
|
|
2184
2255
|
description?: string | null;
|
|
2185
2256
|
/**
|
|
2186
|
-
* Single representative
|
|
2257
|
+
* Single representative image for this taxonomy entry.
|
|
2187
2258
|
*/
|
|
2188
2259
|
image?: (string | null) | Image;
|
|
2189
2260
|
/**
|
|
2190
|
-
* Optional #RRGGBB
|
|
2261
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
2191
2262
|
*/
|
|
2192
2263
|
color?: string | null;
|
|
2193
2264
|
updatedAt: string;
|
|
@@ -2267,7 +2338,7 @@ interface Brand {
|
|
|
2267
2338
|
*/
|
|
2268
2339
|
description?: string | null;
|
|
2269
2340
|
/**
|
|
2270
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
2341
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
2271
2342
|
*/
|
|
2272
2343
|
image?: (string | null) | BrandLogo;
|
|
2273
2344
|
};
|
|
@@ -2295,7 +2366,7 @@ interface BrandLogo {
|
|
|
2295
2366
|
id: string;
|
|
2296
2367
|
tenant?: (string | null) | Tenant;
|
|
2297
2368
|
/**
|
|
2298
|
-
*
|
|
2369
|
+
* Alt text for the image, used by screen readers and search/share previews.
|
|
2299
2370
|
*/
|
|
2300
2371
|
alt?: string | null;
|
|
2301
2372
|
/**
|
|
@@ -2382,6 +2453,28 @@ interface BrandLogo {
|
|
|
2382
2453
|
};
|
|
2383
2454
|
};
|
|
2384
2455
|
}
|
|
2456
|
+
/**
|
|
2457
|
+
* Manage selling countries, base currencies, and product availability.
|
|
2458
|
+
*
|
|
2459
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
2460
|
+
* via the `definition` "markets".
|
|
2461
|
+
*/
|
|
2462
|
+
interface Market {
|
|
2463
|
+
id: string;
|
|
2464
|
+
tenant?: (string | null) | Tenant;
|
|
2465
|
+
name: string;
|
|
2466
|
+
handle: string;
|
|
2467
|
+
countryCode: string;
|
|
2468
|
+
currency: string;
|
|
2469
|
+
isPrimary?: boolean | null;
|
|
2470
|
+
isActive?: boolean | null;
|
|
2471
|
+
metadata?: {
|
|
2472
|
+
[k: string]: unknown;
|
|
2473
|
+
} | unknown[] | string | number | boolean | null;
|
|
2474
|
+
updatedAt: string;
|
|
2475
|
+
createdAt: string;
|
|
2476
|
+
deletedAt?: string | null;
|
|
2477
|
+
}
|
|
2385
2478
|
/**
|
|
2386
2479
|
* Manage shipping fee rules and default shipping policies.
|
|
2387
2480
|
*
|
|
@@ -2525,7 +2618,7 @@ interface ProductCollection {
|
|
|
2525
2618
|
*/
|
|
2526
2619
|
description?: string | null;
|
|
2527
2620
|
/**
|
|
2528
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
2621
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
2529
2622
|
*/
|
|
2530
2623
|
image?: (string | null) | Image;
|
|
2531
2624
|
};
|
|
@@ -2660,7 +2753,7 @@ interface Transaction {
|
|
|
2660
2753
|
order: string | Order;
|
|
2661
2754
|
amount?: number | null;
|
|
2662
2755
|
/**
|
|
2663
|
-
* Payment method snapshot returned by the provider.
|
|
2756
|
+
* Payment method snapshot returned by the provider.
|
|
2664
2757
|
*/
|
|
2665
2758
|
paymentMethod?: string | null;
|
|
2666
2759
|
/**
|
|
@@ -2730,25 +2823,25 @@ interface ApiKey {
|
|
|
2730
2823
|
*/
|
|
2731
2824
|
displaySuffix: string;
|
|
2732
2825
|
/**
|
|
2733
|
-
* Capability scopes. Default is read+write
|
|
2826
|
+
* Capability scopes for the key. Default is read+write.
|
|
2734
2827
|
*/
|
|
2735
2828
|
scopes?: ('read' | 'write' | 'webhook' | 'analytics' | 'super-admin')[] | null;
|
|
2736
2829
|
/**
|
|
2737
|
-
* User who issued the key
|
|
2830
|
+
* User who issued the key for audit traceability.
|
|
2738
2831
|
*/
|
|
2739
2832
|
createdBy?: (string | null) | User;
|
|
2740
2833
|
/**
|
|
2741
|
-
* IP address of the key creation request.
|
|
2834
|
+
* Privacy-bearing IP address of the key creation request.
|
|
2742
2835
|
*/
|
|
2743
2836
|
createdByIp?: string | null;
|
|
2744
2837
|
lastUsedAt?: string | null;
|
|
2745
2838
|
/**
|
|
2746
|
-
*
|
|
2839
|
+
* Privacy-bearing last IP address that used the key.
|
|
2747
2840
|
*/
|
|
2748
2841
|
lastUsedIp?: string | null;
|
|
2749
2842
|
revokedAt?: string | null;
|
|
2750
2843
|
/**
|
|
2751
|
-
* User who revoked the key
|
|
2844
|
+
* User who revoked the key for audit traceability.
|
|
2752
2845
|
*/
|
|
2753
2846
|
revokedBy?: (string | null) | User;
|
|
2754
2847
|
/**
|
|
@@ -2784,17 +2877,17 @@ interface PersonalAccessToken {
|
|
|
2784
2877
|
*/
|
|
2785
2878
|
defaultTenant?: string | null;
|
|
2786
2879
|
/**
|
|
2787
|
-
* IP address of the PAT creation request.
|
|
2880
|
+
* Privacy-bearing IP address of the PAT creation request.
|
|
2788
2881
|
*/
|
|
2789
2882
|
createdByIp?: string | null;
|
|
2790
2883
|
lastUsedAt?: string | null;
|
|
2791
2884
|
/**
|
|
2792
|
-
*
|
|
2885
|
+
* Privacy-bearing last IP address that used the PAT.
|
|
2793
2886
|
*/
|
|
2794
2887
|
lastUsedIp?: string | null;
|
|
2795
2888
|
revokedAt?: string | null;
|
|
2796
2889
|
/**
|
|
2797
|
-
* User who revoked the PAT
|
|
2890
|
+
* User who revoked the PAT for audit traceability.
|
|
2798
2891
|
*/
|
|
2799
2892
|
revokedBy?: (string | null) | User;
|
|
2800
2893
|
/**
|
|
@@ -2965,7 +3058,7 @@ interface Webhook {
|
|
|
2965
3058
|
/**
|
|
2966
3059
|
* Receives create/update events for this collection.
|
|
2967
3060
|
*/
|
|
2968
|
-
collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | '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' | 'canvas-nodes' | 'canvas-edges';
|
|
3061
|
+
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' | 'canvas-nodes' | 'canvas-edges';
|
|
2969
3062
|
id?: string | null;
|
|
2970
3063
|
}[] | null;
|
|
2971
3064
|
isActive?: boolean | null;
|
|
@@ -3150,7 +3243,7 @@ interface TenantLogo {
|
|
|
3150
3243
|
id: string;
|
|
3151
3244
|
tenant?: (string | null) | Tenant;
|
|
3152
3245
|
/**
|
|
3153
|
-
*
|
|
3246
|
+
* Alt text for the image, used by screen readers and search/share previews.
|
|
3154
3247
|
*/
|
|
3155
3248
|
alt?: string | null;
|
|
3156
3249
|
/**
|
|
@@ -3257,7 +3350,7 @@ interface TenantEntitlement {
|
|
|
3257
3350
|
priority: number;
|
|
3258
3351
|
startsAt: string;
|
|
3259
3352
|
/**
|
|
3260
|
-
* Entitlement end date.
|
|
3353
|
+
* Entitlement end date. Hook validation requires it for promo / trial sources.
|
|
3261
3354
|
*/
|
|
3262
3355
|
endsAt?: string | null;
|
|
3263
3356
|
reason?: string | null;
|
|
@@ -3413,7 +3506,7 @@ interface Plan {
|
|
|
3413
3506
|
/**
|
|
3414
3507
|
* Reference-only feature list; enforced elsewhere.
|
|
3415
3508
|
*/
|
|
3416
|
-
featuresAllowed?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'articles' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community' | 'events')[] | null;
|
|
3509
|
+
featuresAllowed?: ('ecommerce' | 'customers' | 'playlists' | 'galleries' | 'links' | 'forms' | 'articles' | 'documents' | 'canvas' | 'videos' | 'live-streaming' | 'community' | 'events' | 'membership')[] | null;
|
|
3417
3510
|
/**
|
|
3418
3511
|
* Reference-only quotas such as storageBytes; enforced by entitlement and usage policy elsewhere.
|
|
3419
3512
|
*/
|
|
@@ -3487,6 +3580,10 @@ interface TenantAnalyticsDaily {
|
|
|
3487
3580
|
eventsDropped?: {
|
|
3488
3581
|
cardinality?: number | null;
|
|
3489
3582
|
schema?: number | null;
|
|
3583
|
+
schemaUnknownEvent?: number | null;
|
|
3584
|
+
schemaUnknownDim?: number | null;
|
|
3585
|
+
schemaBadValue?: number | null;
|
|
3586
|
+
schemaInvalidProps?: number | null;
|
|
3490
3587
|
late?: number | null;
|
|
3491
3588
|
origin?: number | null;
|
|
3492
3589
|
key?: number | null;
|
|
@@ -3586,7 +3683,7 @@ interface AnalyticsEventSchema {
|
|
|
3586
3683
|
key: string;
|
|
3587
3684
|
type: 'enum' | 'boolean';
|
|
3588
3685
|
/**
|
|
3589
|
-
* Comma-separated values. Required when type=enum, optional otherwise. Boolean auto-derives {true,false}. Max 20 per key.
|
|
3686
|
+
* Comma-separated values. Required when type=enum, optional otherwise. Collection compares exact String(value), so case and numeric serialization must match. Boolean auto-derives {true,false}. Max 20 per key.
|
|
3590
3687
|
*/
|
|
3591
3688
|
allowedValues?: string | null;
|
|
3592
3689
|
description?: string | null;
|
|
@@ -3661,15 +3758,15 @@ interface OrderStatusLog {
|
|
|
3661
3758
|
tenant?: (string | null) | Tenant;
|
|
3662
3759
|
order: string | Order;
|
|
3663
3760
|
/**
|
|
3664
|
-
*
|
|
3761
|
+
* Order status before the change.
|
|
3665
3762
|
*/
|
|
3666
3763
|
fromStatus: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3667
3764
|
/**
|
|
3668
|
-
*
|
|
3765
|
+
* Order status after the change.
|
|
3669
3766
|
*/
|
|
3670
3767
|
toStatus: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3671
3768
|
/**
|
|
3672
|
-
*
|
|
3769
|
+
* Who changed the status (a user, the API, or a system process).
|
|
3673
3770
|
*/
|
|
3674
3771
|
changedBy: string;
|
|
3675
3772
|
reason?: string | null;
|
|
@@ -3699,7 +3796,7 @@ interface InventoryReservation {
|
|
|
3699
3796
|
variant: string | ProductVariant;
|
|
3700
3797
|
quantity: number;
|
|
3701
3798
|
/**
|
|
3702
|
-
*
|
|
3799
|
+
* Inventory reservation status. Managed automatically by the server.
|
|
3703
3800
|
*/
|
|
3704
3801
|
status: 'pending' | 'held' | 'released' | 'consumed';
|
|
3705
3802
|
/**
|
|
@@ -3793,6 +3890,10 @@ interface Cart {
|
|
|
3793
3890
|
detailAddress?: string | null;
|
|
3794
3891
|
deliveryMessage?: string | null;
|
|
3795
3892
|
};
|
|
3893
|
+
/**
|
|
3894
|
+
* Cart shipping policy. Falls back to the default policy when unset.
|
|
3895
|
+
*/
|
|
3896
|
+
shippingPolicy?: (string | null) | ShippingPolicy;
|
|
3796
3897
|
discountCode?: string | null;
|
|
3797
3898
|
/**
|
|
3798
3899
|
* Customer note
|
|
@@ -3810,6 +3911,7 @@ interface Cart {
|
|
|
3810
3911
|
* Amount in KRW (won)
|
|
3811
3912
|
*/
|
|
3812
3913
|
shippingAmount?: number | null;
|
|
3914
|
+
freeShippingDiscount?: boolean | null;
|
|
3813
3915
|
/**
|
|
3814
3916
|
* Amount in KRW (won)
|
|
3815
3917
|
*/
|
|
@@ -3844,15 +3946,19 @@ interface CartItem {
|
|
|
3844
3946
|
*/
|
|
3845
3947
|
unitPrice: number;
|
|
3846
3948
|
/**
|
|
3847
|
-
*
|
|
3949
|
+
* Shipping requirement snapshot from the time this line was added to the cart.
|
|
3950
|
+
*/
|
|
3951
|
+
requiresShipping?: boolean | null;
|
|
3952
|
+
/**
|
|
3953
|
+
* Header discount allocated to this line. Calculated automatically.
|
|
3848
3954
|
*/
|
|
3849
3955
|
discountAllocation?: number | null;
|
|
3850
3956
|
/**
|
|
3851
|
-
* Per-unit price after discount allocation
|
|
3957
|
+
* Per-unit price after discount allocation. Calculated automatically.
|
|
3852
3958
|
*/
|
|
3853
3959
|
discountedUnitPrice?: number | null;
|
|
3854
3960
|
/**
|
|
3855
|
-
* Line total after discount allocation
|
|
3961
|
+
* Line total after discount allocation. Calculated automatically.
|
|
3856
3962
|
*/
|
|
3857
3963
|
discountedTotalPrice?: number | null;
|
|
3858
3964
|
metadata?: {
|
|
@@ -3883,6 +3989,10 @@ interface CheckoutItem {
|
|
|
3883
3989
|
*/
|
|
3884
3990
|
unitPrice: number;
|
|
3885
3991
|
totalPrice: number;
|
|
3992
|
+
/**
|
|
3993
|
+
* Shipping requirement snapshot from the time this checkout line was created.
|
|
3994
|
+
*/
|
|
3995
|
+
requiresShipping?: boolean | null;
|
|
3886
3996
|
discountAllocation?: number | null;
|
|
3887
3997
|
discountedUnitPrice?: number | null;
|
|
3888
3998
|
discountedTotalPrice?: number | null;
|
|
@@ -3991,6 +4101,10 @@ interface TenantCommerceConfig {
|
|
|
3991
4101
|
multiReturnInitialShippingRefund?: 'once_only' | null;
|
|
3992
4102
|
legacyOrderPolicyMode?: 'shipping_amount_manual_cap' | null;
|
|
3993
4103
|
};
|
|
4104
|
+
/**
|
|
4105
|
+
* Non-shipping workspaces hide shipping setup, notifications, and order-view copy, and new variants start as non-shipping.
|
|
4106
|
+
*/
|
|
4107
|
+
fulfillmentMode?: ('shipping' | 'none') | null;
|
|
3994
4108
|
/**
|
|
3995
4109
|
* Reusable option name and value lists for the Product Editor. Up to 20 presets.
|
|
3996
4110
|
*/
|
|
@@ -4034,15 +4148,15 @@ interface CustomerProfileStat {
|
|
|
4034
4148
|
tenant?: (string | null) | Tenant;
|
|
4035
4149
|
profile: string | CustomerProfile;
|
|
4036
4150
|
/**
|
|
4037
|
-
* Read-only
|
|
4151
|
+
* Read-only number of community posts authored by this profile. Counted automatically.
|
|
4038
4152
|
*/
|
|
4039
4153
|
postCount?: number | null;
|
|
4040
4154
|
/**
|
|
4041
|
-
* Read-only
|
|
4155
|
+
* Read-only number of community comments authored by this profile. Counted automatically.
|
|
4042
4156
|
*/
|
|
4043
4157
|
commentCount?: number | null;
|
|
4044
4158
|
/**
|
|
4045
|
-
* Read-only
|
|
4159
|
+
* Read-only number of community reactions made by this profile. Counted automatically.
|
|
4046
4160
|
*/
|
|
4047
4161
|
reactionCount?: number | null;
|
|
4048
4162
|
}
|
|
@@ -4223,7 +4337,7 @@ interface Article {
|
|
|
4223
4337
|
categories?: (string | ArticleCategory)[] | null;
|
|
4224
4338
|
tags?: (string | ArticleTag)[] | null;
|
|
4225
4339
|
/**
|
|
4226
|
-
*
|
|
4340
|
+
* Attach videos to this content.
|
|
4227
4341
|
*/
|
|
4228
4342
|
videos?: (string | Video)[] | null;
|
|
4229
4343
|
seo?: {
|
|
@@ -4253,7 +4367,7 @@ interface Article {
|
|
|
4253
4367
|
*/
|
|
4254
4368
|
description?: string | null;
|
|
4255
4369
|
/**
|
|
4256
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
4370
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
4257
4371
|
*/
|
|
4258
4372
|
image?: (string | null) | Image;
|
|
4259
4373
|
};
|
|
@@ -4313,7 +4427,7 @@ interface ArticleAuthor {
|
|
|
4313
4427
|
bio?: string | null;
|
|
4314
4428
|
email?: string | null;
|
|
4315
4429
|
/**
|
|
4316
|
-
* Articles linked to this author.
|
|
4430
|
+
* Articles linked to this author.
|
|
4317
4431
|
*/
|
|
4318
4432
|
articles?: {
|
|
4319
4433
|
docs?: (string | Article)[];
|
|
@@ -4347,7 +4461,7 @@ interface ArticleCategory {
|
|
|
4347
4461
|
*/
|
|
4348
4462
|
description?: string | null;
|
|
4349
4463
|
/**
|
|
4350
|
-
* Single representative
|
|
4464
|
+
* Single representative image for this taxonomy entry.
|
|
4351
4465
|
*/
|
|
4352
4466
|
image?: (string | null) | Image;
|
|
4353
4467
|
/**
|
|
@@ -4355,7 +4469,7 @@ interface ArticleCategory {
|
|
|
4355
4469
|
*/
|
|
4356
4470
|
parent?: (string | null) | ArticleCategory;
|
|
4357
4471
|
/**
|
|
4358
|
-
* Optional #RRGGBB
|
|
4472
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4359
4473
|
*/
|
|
4360
4474
|
color?: string | null;
|
|
4361
4475
|
updatedAt: string;
|
|
@@ -4381,11 +4495,11 @@ interface ArticleTag {
|
|
|
4381
4495
|
*/
|
|
4382
4496
|
description?: string | null;
|
|
4383
4497
|
/**
|
|
4384
|
-
* Single representative
|
|
4498
|
+
* Single representative image for this taxonomy entry.
|
|
4385
4499
|
*/
|
|
4386
4500
|
image?: (string | null) | Image;
|
|
4387
4501
|
/**
|
|
4388
|
-
* Optional #RRGGBB
|
|
4502
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4389
4503
|
*/
|
|
4390
4504
|
color?: string | null;
|
|
4391
4505
|
updatedAt: string;
|
|
@@ -4427,7 +4541,7 @@ interface Document {
|
|
|
4427
4541
|
[k: string]: unknown;
|
|
4428
4542
|
} | null;
|
|
4429
4543
|
/**
|
|
4430
|
-
*
|
|
4544
|
+
* Attach videos to this content.
|
|
4431
4545
|
*/
|
|
4432
4546
|
videos?: (string | Video)[] | null;
|
|
4433
4547
|
/**
|
|
@@ -4485,7 +4599,7 @@ interface Document {
|
|
|
4485
4599
|
*/
|
|
4486
4600
|
description?: string | null;
|
|
4487
4601
|
/**
|
|
4488
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
4602
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
4489
4603
|
*/
|
|
4490
4604
|
image?: (string | null) | Image;
|
|
4491
4605
|
};
|
|
@@ -4536,7 +4650,7 @@ interface DocumentCategory {
|
|
|
4536
4650
|
*/
|
|
4537
4651
|
description?: string | null;
|
|
4538
4652
|
/**
|
|
4539
|
-
* Single representative
|
|
4653
|
+
* Single representative image for this taxonomy entry.
|
|
4540
4654
|
*/
|
|
4541
4655
|
image?: (string | null) | Image;
|
|
4542
4656
|
/**
|
|
@@ -4544,7 +4658,7 @@ interface DocumentCategory {
|
|
|
4544
4658
|
*/
|
|
4545
4659
|
parent?: (string | null) | DocumentCategory;
|
|
4546
4660
|
/**
|
|
4547
|
-
* Optional #RRGGBB
|
|
4661
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4548
4662
|
*/
|
|
4549
4663
|
color?: string | null;
|
|
4550
4664
|
updatedAt: string;
|
|
@@ -4572,11 +4686,11 @@ interface DocumentType {
|
|
|
4572
4686
|
*/
|
|
4573
4687
|
description?: string | null;
|
|
4574
4688
|
/**
|
|
4575
|
-
* Single representative
|
|
4689
|
+
* Single representative image for this taxonomy entry.
|
|
4576
4690
|
*/
|
|
4577
4691
|
image?: (string | null) | Image;
|
|
4578
4692
|
/**
|
|
4579
|
-
* Optional #RRGGBB
|
|
4693
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4580
4694
|
*/
|
|
4581
4695
|
color?: string | null;
|
|
4582
4696
|
updatedAt: string;
|
|
@@ -4605,7 +4719,7 @@ interface Playlist {
|
|
|
4605
4719
|
categories?: (string | PlaylistCategory)[] | null;
|
|
4606
4720
|
tags?: (string | PlaylistTag)[] | null;
|
|
4607
4721
|
/**
|
|
4608
|
-
* Tracks included in this playlist.
|
|
4722
|
+
* Tracks included in this playlist.
|
|
4609
4723
|
*/
|
|
4610
4724
|
tracks?: (string | Track)[] | null;
|
|
4611
4725
|
seo?: {
|
|
@@ -4635,7 +4749,7 @@ interface Playlist {
|
|
|
4635
4749
|
*/
|
|
4636
4750
|
description?: string | null;
|
|
4637
4751
|
/**
|
|
4638
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
4752
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
4639
4753
|
*/
|
|
4640
4754
|
image?: (string | null) | Image;
|
|
4641
4755
|
};
|
|
@@ -4675,7 +4789,7 @@ interface PlaylistCategory {
|
|
|
4675
4789
|
*/
|
|
4676
4790
|
description?: string | null;
|
|
4677
4791
|
/**
|
|
4678
|
-
* Single representative
|
|
4792
|
+
* Single representative image for this taxonomy entry.
|
|
4679
4793
|
*/
|
|
4680
4794
|
image?: (string | null) | Image;
|
|
4681
4795
|
/**
|
|
@@ -4683,7 +4797,7 @@ interface PlaylistCategory {
|
|
|
4683
4797
|
*/
|
|
4684
4798
|
parent?: (string | null) | PlaylistCategory;
|
|
4685
4799
|
/**
|
|
4686
|
-
* Optional #RRGGBB
|
|
4800
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4687
4801
|
*/
|
|
4688
4802
|
color?: string | null;
|
|
4689
4803
|
updatedAt: string;
|
|
@@ -4709,11 +4823,11 @@ interface PlaylistTag {
|
|
|
4709
4823
|
*/
|
|
4710
4824
|
description?: string | null;
|
|
4711
4825
|
/**
|
|
4712
|
-
* Single representative
|
|
4826
|
+
* Single representative image for this taxonomy entry.
|
|
4713
4827
|
*/
|
|
4714
4828
|
image?: (string | null) | Image;
|
|
4715
4829
|
/**
|
|
4716
|
-
* Optional #RRGGBB
|
|
4830
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4717
4831
|
*/
|
|
4718
4832
|
color?: string | null;
|
|
4719
4833
|
updatedAt: string;
|
|
@@ -4790,7 +4904,7 @@ interface TrackCategory {
|
|
|
4790
4904
|
*/
|
|
4791
4905
|
description?: string | null;
|
|
4792
4906
|
/**
|
|
4793
|
-
* Single representative
|
|
4907
|
+
* Single representative image for this taxonomy entry.
|
|
4794
4908
|
*/
|
|
4795
4909
|
image?: (string | null) | Image;
|
|
4796
4910
|
/**
|
|
@@ -4798,7 +4912,7 @@ interface TrackCategory {
|
|
|
4798
4912
|
*/
|
|
4799
4913
|
parent?: (string | null) | TrackCategory;
|
|
4800
4914
|
/**
|
|
4801
|
-
* Optional #RRGGBB
|
|
4915
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4802
4916
|
*/
|
|
4803
4917
|
color?: string | null;
|
|
4804
4918
|
updatedAt: string;
|
|
@@ -4824,11 +4938,11 @@ interface TrackTag {
|
|
|
4824
4938
|
*/
|
|
4825
4939
|
description?: string | null;
|
|
4826
4940
|
/**
|
|
4827
|
-
* Single representative
|
|
4941
|
+
* Single representative image for this taxonomy entry.
|
|
4828
4942
|
*/
|
|
4829
4943
|
image?: (string | null) | Image;
|
|
4830
4944
|
/**
|
|
4831
|
-
* Optional #RRGGBB
|
|
4945
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4832
4946
|
*/
|
|
4833
4947
|
color?: string | null;
|
|
4834
4948
|
updatedAt: string;
|
|
@@ -4880,7 +4994,7 @@ interface Gallery {
|
|
|
4880
4994
|
*/
|
|
4881
4995
|
description?: string | null;
|
|
4882
4996
|
/**
|
|
4883
|
-
*
|
|
4997
|
+
* Attach videos to this content.
|
|
4884
4998
|
*/
|
|
4885
4999
|
videos?: (string | Video)[] | null;
|
|
4886
5000
|
categories?: (string | GalleryCategory)[] | null;
|
|
@@ -4917,7 +5031,7 @@ interface Gallery {
|
|
|
4917
5031
|
*/
|
|
4918
5032
|
description?: string | null;
|
|
4919
5033
|
/**
|
|
4920
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
5034
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
4921
5035
|
*/
|
|
4922
5036
|
image?: (string | null) | Image;
|
|
4923
5037
|
};
|
|
@@ -4958,7 +5072,7 @@ interface GalleryCategory {
|
|
|
4958
5072
|
*/
|
|
4959
5073
|
description?: string | null;
|
|
4960
5074
|
/**
|
|
4961
|
-
* Single representative
|
|
5075
|
+
* Single representative image for this taxonomy entry.
|
|
4962
5076
|
*/
|
|
4963
5077
|
image?: (string | null) | Image;
|
|
4964
5078
|
/**
|
|
@@ -4966,7 +5080,7 @@ interface GalleryCategory {
|
|
|
4966
5080
|
*/
|
|
4967
5081
|
parent?: (string | null) | GalleryCategory;
|
|
4968
5082
|
/**
|
|
4969
|
-
* Optional #RRGGBB
|
|
5083
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
4970
5084
|
*/
|
|
4971
5085
|
color?: string | null;
|
|
4972
5086
|
updatedAt: string;
|
|
@@ -4992,11 +5106,11 @@ interface GalleryTag {
|
|
|
4992
5106
|
*/
|
|
4993
5107
|
description?: string | null;
|
|
4994
5108
|
/**
|
|
4995
|
-
* Single representative
|
|
5109
|
+
* Single representative image for this taxonomy entry.
|
|
4996
5110
|
*/
|
|
4997
5111
|
image?: (string | null) | Image;
|
|
4998
5112
|
/**
|
|
4999
|
-
* Optional #RRGGBB
|
|
5113
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5000
5114
|
*/
|
|
5001
5115
|
color?: string | null;
|
|
5002
5116
|
updatedAt: string;
|
|
@@ -5116,7 +5230,7 @@ interface LinkCategory {
|
|
|
5116
5230
|
*/
|
|
5117
5231
|
description?: string | null;
|
|
5118
5232
|
/**
|
|
5119
|
-
* Single representative
|
|
5233
|
+
* Single representative image for this taxonomy entry.
|
|
5120
5234
|
*/
|
|
5121
5235
|
image?: (string | null) | Image;
|
|
5122
5236
|
/**
|
|
@@ -5124,7 +5238,7 @@ interface LinkCategory {
|
|
|
5124
5238
|
*/
|
|
5125
5239
|
parent?: (string | null) | LinkCategory;
|
|
5126
5240
|
/**
|
|
5127
|
-
* Optional #RRGGBB
|
|
5241
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5128
5242
|
*/
|
|
5129
5243
|
color?: string | null;
|
|
5130
5244
|
updatedAt: string;
|
|
@@ -5150,11 +5264,11 @@ interface LinkTag {
|
|
|
5150
5264
|
*/
|
|
5151
5265
|
description?: string | null;
|
|
5152
5266
|
/**
|
|
5153
|
-
* Single representative
|
|
5267
|
+
* Single representative image for this taxonomy entry.
|
|
5154
5268
|
*/
|
|
5155
5269
|
image?: (string | null) | Image;
|
|
5156
5270
|
/**
|
|
5157
|
-
* Optional #RRGGBB
|
|
5271
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5158
5272
|
*/
|
|
5159
5273
|
color?: string | null;
|
|
5160
5274
|
updatedAt: string;
|
|
@@ -5180,7 +5294,7 @@ interface Canvase {
|
|
|
5180
5294
|
*/
|
|
5181
5295
|
description?: string | null;
|
|
5182
5296
|
/**
|
|
5183
|
-
*
|
|
5297
|
+
* Attach videos to this content.
|
|
5184
5298
|
*/
|
|
5185
5299
|
videos?: (string | Video)[] | null;
|
|
5186
5300
|
canvas?: {
|
|
@@ -5215,7 +5329,7 @@ interface Canvase {
|
|
|
5215
5329
|
*/
|
|
5216
5330
|
description?: string | null;
|
|
5217
5331
|
/**
|
|
5218
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
5332
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
5219
5333
|
*/
|
|
5220
5334
|
image?: (string | null) | Image;
|
|
5221
5335
|
};
|
|
@@ -5232,6 +5346,7 @@ interface Canvase {
|
|
|
5232
5346
|
metadata?: {
|
|
5233
5347
|
[k: string]: unknown;
|
|
5234
5348
|
} | unknown[] | string | number | boolean | null;
|
|
5349
|
+
canvasRevision?: string | null;
|
|
5235
5350
|
updatedAt: string;
|
|
5236
5351
|
createdAt: string;
|
|
5237
5352
|
deletedAt?: string | null;
|
|
@@ -5255,7 +5370,7 @@ interface CanvasCategory {
|
|
|
5255
5370
|
*/
|
|
5256
5371
|
description?: string | null;
|
|
5257
5372
|
/**
|
|
5258
|
-
* Single representative
|
|
5373
|
+
* Single representative image for this taxonomy entry.
|
|
5259
5374
|
*/
|
|
5260
5375
|
image?: (string | null) | Image;
|
|
5261
5376
|
/**
|
|
@@ -5263,7 +5378,7 @@ interface CanvasCategory {
|
|
|
5263
5378
|
*/
|
|
5264
5379
|
parent?: (string | null) | CanvasCategory;
|
|
5265
5380
|
/**
|
|
5266
|
-
* Optional #RRGGBB
|
|
5381
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5267
5382
|
*/
|
|
5268
5383
|
color?: string | null;
|
|
5269
5384
|
updatedAt: string;
|
|
@@ -5289,11 +5404,11 @@ interface CanvasTag {
|
|
|
5289
5404
|
*/
|
|
5290
5405
|
description?: string | null;
|
|
5291
5406
|
/**
|
|
5292
|
-
* Single representative
|
|
5407
|
+
* Single representative image for this taxonomy entry.
|
|
5293
5408
|
*/
|
|
5294
5409
|
image?: (string | null) | Image;
|
|
5295
5410
|
/**
|
|
5296
|
-
* Optional #RRGGBB
|
|
5411
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5297
5412
|
*/
|
|
5298
5413
|
color?: string | null;
|
|
5299
5414
|
updatedAt: string;
|
|
@@ -5539,11 +5654,11 @@ interface Post {
|
|
|
5539
5654
|
*/
|
|
5540
5655
|
viewCount?: number | null;
|
|
5541
5656
|
/**
|
|
5542
|
-
* Read-only
|
|
5657
|
+
* Read-only number of comments on this post. Counted automatically.
|
|
5543
5658
|
*/
|
|
5544
5659
|
commentCount?: number | null;
|
|
5545
5660
|
/**
|
|
5546
|
-
* Read-only
|
|
5661
|
+
* Read-only number of reactions on this post. Counted automatically.
|
|
5547
5662
|
*/
|
|
5548
5663
|
reactionCount?: number | null;
|
|
5549
5664
|
/**
|
|
@@ -5598,7 +5713,7 @@ interface PostCategory {
|
|
|
5598
5713
|
*/
|
|
5599
5714
|
description?: string | null;
|
|
5600
5715
|
/**
|
|
5601
|
-
* Single representative
|
|
5716
|
+
* Single representative image for this taxonomy entry.
|
|
5602
5717
|
*/
|
|
5603
5718
|
image?: (string | null) | Image;
|
|
5604
5719
|
/**
|
|
@@ -5606,7 +5721,7 @@ interface PostCategory {
|
|
|
5606
5721
|
*/
|
|
5607
5722
|
parent?: (string | null) | PostCategory;
|
|
5608
5723
|
/**
|
|
5609
|
-
* Optional #RRGGBB
|
|
5724
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5610
5725
|
*/
|
|
5611
5726
|
color?: string | null;
|
|
5612
5727
|
updatedAt: string;
|
|
@@ -5634,11 +5749,11 @@ interface PostTag {
|
|
|
5634
5749
|
*/
|
|
5635
5750
|
description?: string | null;
|
|
5636
5751
|
/**
|
|
5637
|
-
* Single representative
|
|
5752
|
+
* Single representative image for this taxonomy entry.
|
|
5638
5753
|
*/
|
|
5639
5754
|
image?: (string | null) | Image;
|
|
5640
5755
|
/**
|
|
5641
|
-
* Optional #RRGGBB
|
|
5756
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
5642
5757
|
*/
|
|
5643
5758
|
color?: string | null;
|
|
5644
5759
|
updatedAt: string;
|
|
@@ -5664,7 +5779,7 @@ interface Comment {
|
|
|
5664
5779
|
body?: string | null;
|
|
5665
5780
|
parent?: (string | null) | Comment;
|
|
5666
5781
|
/**
|
|
5667
|
-
* Comment nesting depth. Calculated
|
|
5782
|
+
* Comment nesting depth. Calculated automatically.
|
|
5668
5783
|
*/
|
|
5669
5784
|
depth?: number | null;
|
|
5670
5785
|
/**
|
|
@@ -5677,7 +5792,7 @@ interface Comment {
|
|
|
5677
5792
|
editedAt?: string | null;
|
|
5678
5793
|
isEdited?: boolean | null;
|
|
5679
5794
|
/**
|
|
5680
|
-
* Read-only
|
|
5795
|
+
* Read-only number of reactions on this comment. Counted automatically.
|
|
5681
5796
|
*/
|
|
5682
5797
|
reactionCount?: number | null;
|
|
5683
5798
|
/**
|
|
@@ -5685,7 +5800,7 @@ interface Comment {
|
|
|
5685
5800
|
*/
|
|
5686
5801
|
reportCount?: number | null;
|
|
5687
5802
|
/**
|
|
5688
|
-
* Read-only
|
|
5803
|
+
* Read-only number of replies to this comment. Counted automatically.
|
|
5689
5804
|
*/
|
|
5690
5805
|
replyCount?: number | null;
|
|
5691
5806
|
metadata?: {
|
|
@@ -5815,7 +5930,6 @@ interface CommunityBan {
|
|
|
5815
5930
|
*/
|
|
5816
5931
|
interface EventCalendar {
|
|
5817
5932
|
id: string;
|
|
5818
|
-
_order?: string | null;
|
|
5819
5933
|
tenant?: (string | null) | Tenant;
|
|
5820
5934
|
title?: string | null;
|
|
5821
5935
|
/**
|
|
@@ -5881,7 +5995,7 @@ interface EventCalendar {
|
|
|
5881
5995
|
*/
|
|
5882
5996
|
description?: string | null;
|
|
5883
5997
|
/**
|
|
5884
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
5998
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
5885
5999
|
*/
|
|
5886
6000
|
image?: (string | null) | Image;
|
|
5887
6001
|
};
|
|
@@ -5961,11 +6075,11 @@ interface Event {
|
|
|
5961
6075
|
user?: (string | null) | User;
|
|
5962
6076
|
};
|
|
5963
6077
|
/**
|
|
5964
|
-
* Primary start time. For recurring events, this is the first occurrence anchor.
|
|
6078
|
+
* Primary start time. For recurring events, this is the first occurrence anchor.
|
|
5965
6079
|
*/
|
|
5966
6080
|
startsAt: string;
|
|
5967
6081
|
/**
|
|
5968
|
-
* Primary end time. Must be after the start time.
|
|
6082
|
+
* Primary end time. Must be after the start time.
|
|
5969
6083
|
*/
|
|
5970
6084
|
endsAt: string;
|
|
5971
6085
|
/**
|
|
@@ -6075,7 +6189,7 @@ interface Event {
|
|
|
6075
6189
|
*/
|
|
6076
6190
|
description?: string | null;
|
|
6077
6191
|
/**
|
|
6078
|
-
* OG / Twitter Card image (1200×630 recommended).
|
|
6192
|
+
* OG / Twitter Card image (1200×630 recommended).
|
|
6079
6193
|
*/
|
|
6080
6194
|
image?: (string | null) | Image;
|
|
6081
6195
|
};
|
|
@@ -6085,6 +6199,9 @@ interface Event {
|
|
|
6085
6199
|
*/
|
|
6086
6200
|
generateSlug?: boolean | null;
|
|
6087
6201
|
slug?: string | null;
|
|
6202
|
+
/**
|
|
6203
|
+
* Only published events are public API and occurrence materialization candidates. Archived is an operator archive state; canceled marks a canceled event.
|
|
6204
|
+
*/
|
|
6088
6205
|
status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
|
|
6089
6206
|
coverImage?: (string | null) | Image;
|
|
6090
6207
|
/**
|
|
@@ -6130,7 +6247,7 @@ interface EventCategory {
|
|
|
6130
6247
|
*/
|
|
6131
6248
|
description?: string | null;
|
|
6132
6249
|
/**
|
|
6133
|
-
* Single representative
|
|
6250
|
+
* Single representative image for this taxonomy entry.
|
|
6134
6251
|
*/
|
|
6135
6252
|
image?: (string | null) | Image;
|
|
6136
6253
|
/**
|
|
@@ -6138,7 +6255,7 @@ interface EventCategory {
|
|
|
6138
6255
|
*/
|
|
6139
6256
|
parent?: (string | null) | EventCategory;
|
|
6140
6257
|
/**
|
|
6141
|
-
* Optional #RRGGBB
|
|
6258
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
6142
6259
|
*/
|
|
6143
6260
|
color?: string | null;
|
|
6144
6261
|
updatedAt: string;
|
|
@@ -6164,11 +6281,11 @@ interface EventTag {
|
|
|
6164
6281
|
*/
|
|
6165
6282
|
description?: string | null;
|
|
6166
6283
|
/**
|
|
6167
|
-
* Single representative
|
|
6284
|
+
* Single representative image for this taxonomy entry.
|
|
6168
6285
|
*/
|
|
6169
6286
|
image?: (string | null) | Image;
|
|
6170
6287
|
/**
|
|
6171
|
-
* Optional #RRGGBB
|
|
6288
|
+
* Optional #RRGGBB color for taxonomy badges or filter UI.
|
|
6172
6289
|
*/
|
|
6173
6290
|
color?: string | null;
|
|
6174
6291
|
updatedAt: string;
|
|
@@ -6194,13 +6311,16 @@ interface EventOccurrence {
|
|
|
6194
6311
|
*/
|
|
6195
6312
|
instanceKey?: string | null;
|
|
6196
6313
|
/**
|
|
6197
|
-
*
|
|
6314
|
+
* Occurrence start time.
|
|
6198
6315
|
*/
|
|
6199
6316
|
startsAt: string;
|
|
6200
6317
|
/**
|
|
6201
|
-
*
|
|
6318
|
+
* Occurrence end time.
|
|
6202
6319
|
*/
|
|
6203
6320
|
endsAt: string;
|
|
6321
|
+
/**
|
|
6322
|
+
* IANA time zone used for occurrence identity. Existing occurrences cannot change it.
|
|
6323
|
+
*/
|
|
6204
6324
|
timezone?: string | null;
|
|
6205
6325
|
isAllDay?: boolean | null;
|
|
6206
6326
|
status?: ('scheduled' | 'canceled' | 'completed') | null;
|
|
@@ -6222,11 +6342,11 @@ interface EventOccurrence {
|
|
|
6222
6342
|
waitlistCount?: number | null;
|
|
6223
6343
|
checkInWindow?: {
|
|
6224
6344
|
/**
|
|
6225
|
-
*
|
|
6345
|
+
* Check-in opens at this time.
|
|
6226
6346
|
*/
|
|
6227
6347
|
opensAt?: string | null;
|
|
6228
6348
|
/**
|
|
6229
|
-
*
|
|
6349
|
+
* Check-in closes at this time.
|
|
6230
6350
|
*/
|
|
6231
6351
|
closesAt?: string | null;
|
|
6232
6352
|
};
|
|
@@ -6291,7 +6411,7 @@ interface EventRegistration {
|
|
|
6291
6411
|
phone?: string | null;
|
|
6292
6412
|
};
|
|
6293
6413
|
/**
|
|
6294
|
-
* Internal attendee email.
|
|
6414
|
+
* Internal attendee email PII. Duplicates the registration-time snapshot email for search/listing and is hidden from publishable-key reads.
|
|
6295
6415
|
*/
|
|
6296
6416
|
attendeeEmail?: string | null;
|
|
6297
6417
|
/**
|
|
@@ -6333,7 +6453,7 @@ interface EventRegistration {
|
|
|
6333
6453
|
*/
|
|
6334
6454
|
guestTokenExpiresAt?: string | null;
|
|
6335
6455
|
/**
|
|
6336
|
-
* Retention deadline for attendee PII.
|
|
6456
|
+
* Retention deadline for attendee PII. Owned by retention cleanup, which may redact PII after this timestamp.
|
|
6337
6457
|
*/
|
|
6338
6458
|
piiRetentionUntil?: string | null;
|
|
6339
6459
|
/**
|
|
@@ -6347,6 +6467,164 @@ interface EventRegistration {
|
|
|
6347
6467
|
createdAt: string;
|
|
6348
6468
|
deletedAt?: string | null;
|
|
6349
6469
|
}
|
|
6470
|
+
/**
|
|
6471
|
+
* Manage paid membership plans and billing intervals.
|
|
6472
|
+
*
|
|
6473
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
6474
|
+
* via the `definition` "membership-plans".
|
|
6475
|
+
*/
|
|
6476
|
+
interface MembershipPlan {
|
|
6477
|
+
id: string;
|
|
6478
|
+
_order?: string | null;
|
|
6479
|
+
tenant?: (string | null) | Tenant;
|
|
6480
|
+
title?: string | null;
|
|
6481
|
+
/**
|
|
6482
|
+
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
6483
|
+
*/
|
|
6484
|
+
generateSlug?: boolean | null;
|
|
6485
|
+
slug?: string | null;
|
|
6486
|
+
/**
|
|
6487
|
+
* Short summary for listing/cards
|
|
6488
|
+
*/
|
|
6489
|
+
description?: string | null;
|
|
6490
|
+
/**
|
|
6491
|
+
* Charge amount (integer minor unit of currency)
|
|
6492
|
+
*/
|
|
6493
|
+
price: number;
|
|
6494
|
+
currency: 'KRW' | 'USD' | 'EUR' | 'JPY';
|
|
6495
|
+
billingInterval: 'month' | 'year';
|
|
6496
|
+
/**
|
|
6497
|
+
* e.g. quarterly = month × 3
|
|
6498
|
+
*/
|
|
6499
|
+
intervalCount: number;
|
|
6500
|
+
/**
|
|
6501
|
+
* Free trial days (optional)
|
|
6502
|
+
*/
|
|
6503
|
+
trialDays?: number | null;
|
|
6504
|
+
/**
|
|
6505
|
+
* Customer group active members are auto-added to (benefit join point)
|
|
6506
|
+
*/
|
|
6507
|
+
memberGroup: string | CustomerGroup;
|
|
6508
|
+
isActive?: boolean | null;
|
|
6509
|
+
displayOrder?: number | null;
|
|
6510
|
+
publicTitle?: string | null;
|
|
6511
|
+
publicDescription?: string | null;
|
|
6512
|
+
updatedAt: string;
|
|
6513
|
+
createdAt: string;
|
|
6514
|
+
deletedAt?: string | null;
|
|
6515
|
+
}
|
|
6516
|
+
/**
|
|
6517
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
6518
|
+
* via the `definition` "customer-payment-methods".
|
|
6519
|
+
*/
|
|
6520
|
+
interface CustomerPaymentMethod {
|
|
6521
|
+
id: string;
|
|
6522
|
+
tenant?: (string | null) | Tenant;
|
|
6523
|
+
customer: string | Customer;
|
|
6524
|
+
provider: string;
|
|
6525
|
+
/**
|
|
6526
|
+
* Pinned at issuance; the cron resolves the adapter from this
|
|
6527
|
+
*/
|
|
6528
|
+
mode: 'connect' | 'backend-charge' | 'delegated';
|
|
6529
|
+
/**
|
|
6530
|
+
* Encrypted payment token (written in P2)
|
|
6531
|
+
*/
|
|
6532
|
+
token?: string | null;
|
|
6533
|
+
customerRef?: string | null;
|
|
6534
|
+
connectedAccountRef?: string | null;
|
|
6535
|
+
submallRef?: string | null;
|
|
6536
|
+
channelRef?: string | null;
|
|
6537
|
+
card?: {
|
|
6538
|
+
last4?: string | null;
|
|
6539
|
+
brand?: string | null;
|
|
6540
|
+
};
|
|
6541
|
+
status: 'active' | 'revoked';
|
|
6542
|
+
revokedAt?: string | null;
|
|
6543
|
+
updatedAt: string;
|
|
6544
|
+
createdAt: string;
|
|
6545
|
+
deletedAt?: string | null;
|
|
6546
|
+
}
|
|
6547
|
+
/**
|
|
6548
|
+
* Review customer membership status and renewal schedules.
|
|
6549
|
+
*
|
|
6550
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
6551
|
+
* via the `definition` "customer-memberships".
|
|
6552
|
+
*/
|
|
6553
|
+
interface CustomerMembership {
|
|
6554
|
+
id: string;
|
|
6555
|
+
tenant?: (string | null) | Tenant;
|
|
6556
|
+
customer: string | Customer;
|
|
6557
|
+
plan: string | MembershipPlan;
|
|
6558
|
+
paymentMethod?: (string | null) | CustomerPaymentMethod;
|
|
6559
|
+
status: 'incomplete' | 'trialing' | 'active' | 'past_due' | 'cancelled' | 'expired';
|
|
6560
|
+
/**
|
|
6561
|
+
* Price snapshot at subscribe (renewals charge this)
|
|
6562
|
+
*/
|
|
6563
|
+
amount?: number | null;
|
|
6564
|
+
currency?: ('KRW' | 'USD' | 'EUR' | 'JPY') | null;
|
|
6565
|
+
currentPeriodStart?: string | null;
|
|
6566
|
+
currentPeriodEnd?: string | null;
|
|
6567
|
+
nextBillingAt?: string | null;
|
|
6568
|
+
nextRetryAt?: string | null;
|
|
6569
|
+
cancelAtPeriodEnd?: boolean | null;
|
|
6570
|
+
startedAt?: string | null;
|
|
6571
|
+
cancelledAt?: string | null;
|
|
6572
|
+
pastDueAt?: string | null;
|
|
6573
|
+
failureCount?: number | null;
|
|
6574
|
+
/**
|
|
6575
|
+
* First-charge idempotency anchor (unique index added in migration)
|
|
6576
|
+
*/
|
|
6577
|
+
subscribeIntentKey?: string | null;
|
|
6578
|
+
updatedAt: string;
|
|
6579
|
+
createdAt: string;
|
|
6580
|
+
deletedAt?: string | null;
|
|
6581
|
+
}
|
|
6582
|
+
/**
|
|
6583
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
6584
|
+
* via the `definition` "membership-charges".
|
|
6585
|
+
*/
|
|
6586
|
+
interface MembershipCharge {
|
|
6587
|
+
id: string;
|
|
6588
|
+
tenant?: (string | null) | Tenant;
|
|
6589
|
+
membership: string | CustomerMembership;
|
|
6590
|
+
customer?: (string | null) | Customer;
|
|
6591
|
+
amount: number;
|
|
6592
|
+
currency: 'KRW' | 'USD' | 'EUR' | 'JPY';
|
|
6593
|
+
status: 'pending' | 'paid' | 'failed' | 'refunded' | 'voided' | 'disputed';
|
|
6594
|
+
refundedAmount?: number | null;
|
|
6595
|
+
pgPaymentId?: string | null;
|
|
6596
|
+
pgRefundId?: string | null;
|
|
6597
|
+
pgProvider?: string | null;
|
|
6598
|
+
periodStart: string;
|
|
6599
|
+
periodEnd?: string | null;
|
|
6600
|
+
paidAt?: string | null;
|
|
6601
|
+
idempotencyKey?: string | null;
|
|
6602
|
+
updatedAt: string;
|
|
6603
|
+
createdAt: string;
|
|
6604
|
+
}
|
|
6605
|
+
/**
|
|
6606
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
6607
|
+
* via the `definition` "tenant-payment-credentials".
|
|
6608
|
+
*/
|
|
6609
|
+
interface TenantPaymentCredential {
|
|
6610
|
+
id: string;
|
|
6611
|
+
tenant?: (string | null) | Tenant;
|
|
6612
|
+
provider: string;
|
|
6613
|
+
mode: 'connect' | 'backend-charge' | 'delegated';
|
|
6614
|
+
connectedAccountRef?: string | null;
|
|
6615
|
+
submallRef?: string | null;
|
|
6616
|
+
secretKey?: string | null;
|
|
6617
|
+
clientKey?: string | null;
|
|
6618
|
+
storeId?: string | null;
|
|
6619
|
+
channelKey?: string | null;
|
|
6620
|
+
webhookSecret?: string | null;
|
|
6621
|
+
delegateChargeUrl?: string | null;
|
|
6622
|
+
isActive?: boolean | null;
|
|
6623
|
+
connectedAt?: string | null;
|
|
6624
|
+
updatedAt: string;
|
|
6625
|
+
createdAt: string;
|
|
6626
|
+
deletedAt?: string | null;
|
|
6627
|
+
}
|
|
6350
6628
|
/**
|
|
6351
6629
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6352
6630
|
* via the `definition` "direct-upload-sessions".
|
|
@@ -6396,7 +6674,7 @@ interface Form {
|
|
|
6396
6674
|
generateSlug?: boolean | null;
|
|
6397
6675
|
slug?: string | null;
|
|
6398
6676
|
/**
|
|
6399
|
-
* Submissions received through this form.
|
|
6677
|
+
* Submissions received through this form.
|
|
6400
6678
|
*/
|
|
6401
6679
|
submissions?: {
|
|
6402
6680
|
docs?: (string | FormSubmission)[];
|
|
@@ -6976,6 +7254,7 @@ interface TenantsSelect<T extends boolean = true> {
|
|
|
6976
7254
|
draftPath?: T;
|
|
6977
7255
|
id?: T;
|
|
6978
7256
|
};
|
|
7257
|
+
shopCurrency?: T;
|
|
6979
7258
|
owner?: T;
|
|
6980
7259
|
enabledFeatures?: T;
|
|
6981
7260
|
enabledRelationshipRecipes?: T;
|
|
@@ -6993,7 +7272,16 @@ interface TenantsSelect<T extends boolean = true> {
|
|
|
6993
7272
|
fulfillmentShipped?: T;
|
|
6994
7273
|
orderDelivered?: T;
|
|
6995
7274
|
returnRequested?: T;
|
|
7275
|
+
returnApproved?: T;
|
|
7276
|
+
returnRejected?: T;
|
|
6996
7277
|
returnCompleted?: T;
|
|
7278
|
+
senderDisplayName?: T;
|
|
7279
|
+
senderReplyTo?: T;
|
|
7280
|
+
senderDomain?: T;
|
|
7281
|
+
senderLocalpart?: T;
|
|
7282
|
+
senderDomainStatus?: T;
|
|
7283
|
+
senderDomainResendId?: T;
|
|
7284
|
+
senderDomainRecords?: T;
|
|
6997
7285
|
};
|
|
6998
7286
|
members?: T;
|
|
6999
7287
|
updatedAt?: T;
|
|
@@ -7334,6 +7622,10 @@ interface TenantAnalyticsDailySelect<T extends boolean = true> {
|
|
|
7334
7622
|
eventsDropped?: T | {
|
|
7335
7623
|
cardinality?: T;
|
|
7336
7624
|
schema?: T;
|
|
7625
|
+
schemaUnknownEvent?: T;
|
|
7626
|
+
schemaUnknownDim?: T;
|
|
7627
|
+
schemaBadValue?: T;
|
|
7628
|
+
schemaInvalidProps?: T;
|
|
7337
7629
|
late?: T;
|
|
7338
7630
|
origin?: T;
|
|
7339
7631
|
key?: T;
|
|
@@ -7460,6 +7752,7 @@ interface ProductsSelect<T extends boolean = true> {
|
|
|
7460
7752
|
categories?: T;
|
|
7461
7753
|
tags?: T;
|
|
7462
7754
|
brand?: T;
|
|
7755
|
+
markets?: T;
|
|
7463
7756
|
shippingPolicy?: T;
|
|
7464
7757
|
weight?: T;
|
|
7465
7758
|
vendor?: T;
|
|
@@ -7524,6 +7817,7 @@ interface ProductVariantsSelect<T extends boolean = true> {
|
|
|
7524
7817
|
price?: T;
|
|
7525
7818
|
compareAtPrice?: T;
|
|
7526
7819
|
isUnlimited?: T;
|
|
7820
|
+
inventoryPolicy?: T;
|
|
7527
7821
|
stock?: T;
|
|
7528
7822
|
stockAdjustmentReason?: T;
|
|
7529
7823
|
stockAdjustmentNote?: T;
|
|
@@ -7857,6 +8151,7 @@ interface OrdersSelect<T extends boolean = true> {
|
|
|
7857
8151
|
discountCode?: T;
|
|
7858
8152
|
discountAmount?: T;
|
|
7859
8153
|
refundedAmount?: T;
|
|
8154
|
+
currentTotalAmount?: T;
|
|
7860
8155
|
taxAmount?: T;
|
|
7861
8156
|
returnShippingRefundPolicySnapshot?: T;
|
|
7862
8157
|
returns?: T;
|
|
@@ -7864,6 +8159,7 @@ interface OrdersSelect<T extends boolean = true> {
|
|
|
7864
8159
|
placedAt?: T;
|
|
7865
8160
|
confirmedAt?: T;
|
|
7866
8161
|
cancelReason?: T;
|
|
8162
|
+
cancelReasonCode?: T;
|
|
7867
8163
|
canceledAt?: T;
|
|
7868
8164
|
completedAt?: T;
|
|
7869
8165
|
billingAddress?: T | {
|
|
@@ -8074,6 +8370,7 @@ interface ReturnsSelect<T extends boolean = true> {
|
|
|
8074
8370
|
exchangeOrder?: T;
|
|
8075
8371
|
status?: T;
|
|
8076
8372
|
reason?: T;
|
|
8373
|
+
rejectionReasonCode?: T;
|
|
8077
8374
|
reasonDetail?: T;
|
|
8078
8375
|
items?: T;
|
|
8079
8376
|
adminNotes?: T;
|
|
@@ -8189,6 +8486,7 @@ interface TenantCommerceConfigSelect<T extends boolean = true> {
|
|
|
8189
8486
|
multiReturnInitialShippingRefund?: T;
|
|
8190
8487
|
legacyOrderPolicyMode?: T;
|
|
8191
8488
|
};
|
|
8489
|
+
fulfillmentMode?: T;
|
|
8192
8490
|
optionPresets?: T | {
|
|
8193
8491
|
name?: T;
|
|
8194
8492
|
options?: T | {
|
|
@@ -8205,6 +8503,23 @@ interface TenantCommerceConfigSelect<T extends boolean = true> {
|
|
|
8205
8503
|
createdAt?: T;
|
|
8206
8504
|
deletedAt?: T;
|
|
8207
8505
|
}
|
|
8506
|
+
/**
|
|
8507
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
8508
|
+
* via the `definition` "markets_select".
|
|
8509
|
+
*/
|
|
8510
|
+
interface MarketsSelect<T extends boolean = true> {
|
|
8511
|
+
tenant?: T;
|
|
8512
|
+
name?: T;
|
|
8513
|
+
handle?: T;
|
|
8514
|
+
countryCode?: T;
|
|
8515
|
+
currency?: T;
|
|
8516
|
+
isPrimary?: T;
|
|
8517
|
+
isActive?: T;
|
|
8518
|
+
metadata?: T;
|
|
8519
|
+
updatedAt?: T;
|
|
8520
|
+
createdAt?: T;
|
|
8521
|
+
deletedAt?: T;
|
|
8522
|
+
}
|
|
8208
8523
|
/**
|
|
8209
8524
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
8210
8525
|
* via the `definition` "customers_select".
|
|
@@ -8409,6 +8724,7 @@ interface CartsSelect<T extends boolean = true> {
|
|
|
8409
8724
|
detailAddress?: T;
|
|
8410
8725
|
deliveryMessage?: T;
|
|
8411
8726
|
};
|
|
8727
|
+
shippingPolicy?: T;
|
|
8412
8728
|
discountCode?: T;
|
|
8413
8729
|
customerNote?: T;
|
|
8414
8730
|
items?: T;
|
|
@@ -8416,6 +8732,7 @@ interface CartsSelect<T extends boolean = true> {
|
|
|
8416
8732
|
currency?: T;
|
|
8417
8733
|
subtotalAmount?: T;
|
|
8418
8734
|
shippingAmount?: T;
|
|
8735
|
+
freeShippingDiscount?: T;
|
|
8419
8736
|
discountAmount?: T;
|
|
8420
8737
|
totalAmount?: T;
|
|
8421
8738
|
cartToken?: T;
|
|
@@ -8437,6 +8754,7 @@ interface CartItemsSelect<T extends boolean = true> {
|
|
|
8437
8754
|
variant?: T;
|
|
8438
8755
|
quantity?: T;
|
|
8439
8756
|
unitPrice?: T;
|
|
8757
|
+
requiresShipping?: T;
|
|
8440
8758
|
discountAllocation?: T;
|
|
8441
8759
|
discountedUnitPrice?: T;
|
|
8442
8760
|
discountedTotalPrice?: T;
|
|
@@ -8502,6 +8820,7 @@ interface CheckoutItemsSelect<T extends boolean = true> {
|
|
|
8502
8820
|
optionSelection?: T;
|
|
8503
8821
|
unitPrice?: T;
|
|
8504
8822
|
totalPrice?: T;
|
|
8823
|
+
requiresShipping?: T;
|
|
8505
8824
|
discountAllocation?: T;
|
|
8506
8825
|
discountedUnitPrice?: T;
|
|
8507
8826
|
discountedTotalPrice?: T;
|
|
@@ -9085,6 +9404,7 @@ interface CanvasesSelect<T extends boolean = true> {
|
|
|
9085
9404
|
isFeatured?: T;
|
|
9086
9405
|
publishedAt?: T;
|
|
9087
9406
|
metadata?: T;
|
|
9407
|
+
canvasRevision?: T;
|
|
9088
9408
|
updatedAt?: T;
|
|
9089
9409
|
createdAt?: T;
|
|
9090
9410
|
deletedAt?: T;
|
|
@@ -9545,7 +9865,6 @@ interface CommunityBansSelect<T extends boolean = true> {
|
|
|
9545
9865
|
* via the `definition` "event-calendars_select".
|
|
9546
9866
|
*/
|
|
9547
9867
|
interface EventCalendarsSelect<T extends boolean = true> {
|
|
9548
|
-
_order?: T;
|
|
9549
9868
|
tenant?: T;
|
|
9550
9869
|
title?: T;
|
|
9551
9870
|
subtitle?: T;
|
|
@@ -9778,6 +10097,125 @@ interface EventRegistrationsSelect<T extends boolean = true> {
|
|
|
9778
10097
|
createdAt?: T;
|
|
9779
10098
|
deletedAt?: T;
|
|
9780
10099
|
}
|
|
10100
|
+
/**
|
|
10101
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
10102
|
+
* via the `definition` "membership-plans_select".
|
|
10103
|
+
*/
|
|
10104
|
+
interface MembershipPlansSelect<T extends boolean = true> {
|
|
10105
|
+
_order?: T;
|
|
10106
|
+
tenant?: T;
|
|
10107
|
+
title?: T;
|
|
10108
|
+
generateSlug?: T;
|
|
10109
|
+
slug?: T;
|
|
10110
|
+
description?: T;
|
|
10111
|
+
price?: T;
|
|
10112
|
+
currency?: T;
|
|
10113
|
+
billingInterval?: T;
|
|
10114
|
+
intervalCount?: T;
|
|
10115
|
+
trialDays?: T;
|
|
10116
|
+
memberGroup?: T;
|
|
10117
|
+
isActive?: T;
|
|
10118
|
+
displayOrder?: T;
|
|
10119
|
+
publicTitle?: T;
|
|
10120
|
+
publicDescription?: T;
|
|
10121
|
+
updatedAt?: T;
|
|
10122
|
+
createdAt?: T;
|
|
10123
|
+
deletedAt?: T;
|
|
10124
|
+
}
|
|
10125
|
+
/**
|
|
10126
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
10127
|
+
* via the `definition` "customer-payment-methods_select".
|
|
10128
|
+
*/
|
|
10129
|
+
interface CustomerPaymentMethodsSelect<T extends boolean = true> {
|
|
10130
|
+
tenant?: T;
|
|
10131
|
+
customer?: T;
|
|
10132
|
+
provider?: T;
|
|
10133
|
+
mode?: T;
|
|
10134
|
+
token?: T;
|
|
10135
|
+
customerRef?: T;
|
|
10136
|
+
connectedAccountRef?: T;
|
|
10137
|
+
submallRef?: T;
|
|
10138
|
+
channelRef?: T;
|
|
10139
|
+
card?: T | {
|
|
10140
|
+
last4?: T;
|
|
10141
|
+
brand?: T;
|
|
10142
|
+
};
|
|
10143
|
+
status?: T;
|
|
10144
|
+
revokedAt?: T;
|
|
10145
|
+
updatedAt?: T;
|
|
10146
|
+
createdAt?: T;
|
|
10147
|
+
deletedAt?: T;
|
|
10148
|
+
}
|
|
10149
|
+
/**
|
|
10150
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
10151
|
+
* via the `definition` "customer-memberships_select".
|
|
10152
|
+
*/
|
|
10153
|
+
interface CustomerMembershipsSelect<T extends boolean = true> {
|
|
10154
|
+
tenant?: T;
|
|
10155
|
+
customer?: T;
|
|
10156
|
+
plan?: T;
|
|
10157
|
+
paymentMethod?: T;
|
|
10158
|
+
status?: T;
|
|
10159
|
+
amount?: T;
|
|
10160
|
+
currency?: T;
|
|
10161
|
+
currentPeriodStart?: T;
|
|
10162
|
+
currentPeriodEnd?: T;
|
|
10163
|
+
nextBillingAt?: T;
|
|
10164
|
+
nextRetryAt?: T;
|
|
10165
|
+
cancelAtPeriodEnd?: T;
|
|
10166
|
+
startedAt?: T;
|
|
10167
|
+
cancelledAt?: T;
|
|
10168
|
+
pastDueAt?: T;
|
|
10169
|
+
failureCount?: T;
|
|
10170
|
+
subscribeIntentKey?: T;
|
|
10171
|
+
updatedAt?: T;
|
|
10172
|
+
createdAt?: T;
|
|
10173
|
+
deletedAt?: T;
|
|
10174
|
+
}
|
|
10175
|
+
/**
|
|
10176
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
10177
|
+
* via the `definition` "membership-charges_select".
|
|
10178
|
+
*/
|
|
10179
|
+
interface MembershipChargesSelect<T extends boolean = true> {
|
|
10180
|
+
tenant?: T;
|
|
10181
|
+
membership?: T;
|
|
10182
|
+
customer?: T;
|
|
10183
|
+
amount?: T;
|
|
10184
|
+
currency?: T;
|
|
10185
|
+
status?: T;
|
|
10186
|
+
refundedAmount?: T;
|
|
10187
|
+
pgPaymentId?: T;
|
|
10188
|
+
pgRefundId?: T;
|
|
10189
|
+
pgProvider?: T;
|
|
10190
|
+
periodStart?: T;
|
|
10191
|
+
periodEnd?: T;
|
|
10192
|
+
paidAt?: T;
|
|
10193
|
+
idempotencyKey?: T;
|
|
10194
|
+
updatedAt?: T;
|
|
10195
|
+
createdAt?: T;
|
|
10196
|
+
}
|
|
10197
|
+
/**
|
|
10198
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
10199
|
+
* via the `definition` "tenant-payment-credentials_select".
|
|
10200
|
+
*/
|
|
10201
|
+
interface TenantPaymentCredentialsSelect<T extends boolean = true> {
|
|
10202
|
+
tenant?: T;
|
|
10203
|
+
provider?: T;
|
|
10204
|
+
mode?: T;
|
|
10205
|
+
connectedAccountRef?: T;
|
|
10206
|
+
submallRef?: T;
|
|
10207
|
+
secretKey?: T;
|
|
10208
|
+
clientKey?: T;
|
|
10209
|
+
storeId?: T;
|
|
10210
|
+
channelKey?: T;
|
|
10211
|
+
webhookSecret?: T;
|
|
10212
|
+
delegateChargeUrl?: T;
|
|
10213
|
+
isActive?: T;
|
|
10214
|
+
connectedAt?: T;
|
|
10215
|
+
updatedAt?: T;
|
|
10216
|
+
createdAt?: T;
|
|
10217
|
+
deletedAt?: T;
|
|
10218
|
+
}
|
|
9781
10219
|
/**
|
|
9782
10220
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
9783
10221
|
* via the `definition` "direct-upload-sessions_select".
|