@01.software/sdk 0.26.0 → 0.28.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/README.md +153 -4
- package/dist/analytics/react.cjs +249 -0
- package/dist/analytics/react.cjs.map +1 -0
- package/dist/analytics/react.d.cts +8 -0
- package/dist/analytics/react.d.ts +8 -0
- package/dist/analytics/react.js +228 -0
- package/dist/analytics/react.js.map +1 -0
- package/dist/analytics.cjs.map +1 -1
- package/dist/analytics.js.map +1 -1
- package/dist/{const-R3AyqOHY.d.ts → const-Cz9Ki_I7.d.cts} +6 -6
- package/dist/{const-CEiFBZMW.d.cts → const-mdQQtIOz.d.ts} +6 -6
- package/dist/{image-TT8lTsk5.d.cts → image-BDz2-AaO.d.cts} +1 -1
- package/dist/{image-TT8lTsk5.d.ts → image-BDz2-AaO.d.ts} +1 -1
- package/dist/index.cjs +97 -10
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +21 -10
- package/dist/index.d.ts +21 -10
- package/dist/index.js +97 -10
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-BF8VVFt6.d.cts → payload-types-BrSYb-sh.d.cts} +365 -122
- package/dist/{payload-types-BF8VVFt6.d.ts → payload-types-BrSYb-sh.d.ts} +365 -122
- 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.map +1 -1
- package/dist/{server-DLdbWJVv.d.cts → server-BINWywT8.d.cts} +1 -1
- package/dist/{server-DLdbWJVv.d.ts → server-BINWywT8.d.ts} +1 -1
- package/dist/{server-CZrUwqDs.d.cts → server-C2Q9R-Lu.d.ts} +251 -9
- package/dist/{server-DULueNYi.d.ts → server-D369bCVJ.d.cts} +251 -9
- package/dist/server.cjs +79 -4
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +4 -4
- package/dist/server.d.ts +4 -4
- package/dist/server.js +79 -4
- package/dist/server.js.map +1 -1
- package/dist/{types-CZ1laT6s.d.ts → types-BLUb4cYq.d.ts} +1 -1
- package/dist/{types-lPRgx_rC.d.cts → types-CW4PaIL7.d.cts} +1 -1
- package/dist/ui/canvas/server.cjs.map +1 -1
- package/dist/ui/canvas/server.d.cts +1 -1
- package/dist/ui/canvas/server.d.ts +1 -1
- package/dist/ui/canvas/server.js.map +1 -1
- package/dist/ui/canvas.cjs.map +1 -1
- package/dist/ui/canvas.d.cts +3 -3
- package/dist/ui/canvas.d.ts +3 -3
- 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/image.d.cts +1 -1
- package/dist/ui/image.d.ts +1 -1
- package/dist/ui/video.d.cts +2 -2
- package/dist/ui/video.d.ts +2 -2
- package/dist/{video-DbLL8yuc.d.cts → video-WR_TFO9a.d.cts} +1 -1
- package/dist/{video-DbLL8yuc.d.ts → video-WR_TFO9a.d.ts} +1 -1
- package/dist/webhook.d.cts +3 -3
- package/dist/webhook.d.ts +3 -3
- package/package.json +40 -24
|
@@ -47,11 +47,13 @@ interface Config {
|
|
|
47
47
|
'order-items': OrderItem;
|
|
48
48
|
transactions: Transaction;
|
|
49
49
|
'order-status-logs': OrderStatusLog;
|
|
50
|
+
'inventory-reservations': InventoryReservation;
|
|
50
51
|
fulfillments: Fulfillment;
|
|
51
52
|
'fulfillment-items': FulfillmentItem;
|
|
52
53
|
returns: Return;
|
|
53
54
|
'return-items': ReturnItem;
|
|
54
55
|
'shipping-policies': ShippingPolicy;
|
|
56
|
+
'shipping-zones': ShippingZone;
|
|
55
57
|
customers: Customer;
|
|
56
58
|
'customer-profiles': CustomerProfile;
|
|
57
59
|
'customer-profile-lists': CustomerProfileList;
|
|
@@ -60,7 +62,6 @@ interface Config {
|
|
|
60
62
|
carts: Cart;
|
|
61
63
|
'cart-items': CartItem;
|
|
62
64
|
discounts: Discount;
|
|
63
|
-
promotions: Promotion;
|
|
64
65
|
articles: Article;
|
|
65
66
|
'article-authors': ArticleAuthor;
|
|
66
67
|
'article-categories': ArticleCategory;
|
|
@@ -160,6 +161,13 @@ interface Config {
|
|
|
160
161
|
posts: {
|
|
161
162
|
comments: 'comments';
|
|
162
163
|
};
|
|
164
|
+
events: {
|
|
165
|
+
occurrences: 'event-occurrences';
|
|
166
|
+
registrations: 'event-registrations';
|
|
167
|
+
};
|
|
168
|
+
'event-occurrences': {
|
|
169
|
+
registrations: 'event-registrations';
|
|
170
|
+
};
|
|
163
171
|
'payload-folders': {
|
|
164
172
|
documentsAndFolders: 'payload-folders' | 'images' | 'system-media';
|
|
165
173
|
};
|
|
@@ -202,11 +210,13 @@ interface Config {
|
|
|
202
210
|
'order-items': OrderItemsSelect<false> | OrderItemsSelect<true>;
|
|
203
211
|
transactions: TransactionsSelect<false> | TransactionsSelect<true>;
|
|
204
212
|
'order-status-logs': OrderStatusLogsSelect<false> | OrderStatusLogsSelect<true>;
|
|
213
|
+
'inventory-reservations': InventoryReservationsSelect<false> | InventoryReservationsSelect<true>;
|
|
205
214
|
fulfillments: FulfillmentsSelect<false> | FulfillmentsSelect<true>;
|
|
206
215
|
'fulfillment-items': FulfillmentItemsSelect<false> | FulfillmentItemsSelect<true>;
|
|
207
216
|
returns: ReturnsSelect<false> | ReturnsSelect<true>;
|
|
208
217
|
'return-items': ReturnItemsSelect<false> | ReturnItemsSelect<true>;
|
|
209
218
|
'shipping-policies': ShippingPoliciesSelect<false> | ShippingPoliciesSelect<true>;
|
|
219
|
+
'shipping-zones': ShippingZonesSelect<false> | ShippingZonesSelect<true>;
|
|
210
220
|
customers: CustomersSelect<false> | CustomersSelect<true>;
|
|
211
221
|
'customer-profiles': CustomerProfilesSelect<false> | CustomerProfilesSelect<true>;
|
|
212
222
|
'customer-profile-lists': CustomerProfileListsSelect<false> | CustomerProfileListsSelect<true>;
|
|
@@ -215,7 +225,6 @@ interface Config {
|
|
|
215
225
|
carts: CartsSelect<false> | CartsSelect<true>;
|
|
216
226
|
'cart-items': CartItemsSelect<false> | CartItemsSelect<true>;
|
|
217
227
|
discounts: DiscountsSelect<false> | DiscountsSelect<true>;
|
|
218
|
-
promotions: PromotionsSelect<false> | PromotionsSelect<true>;
|
|
219
228
|
articles: ArticlesSelect<false> | ArticlesSelect<true>;
|
|
220
229
|
'article-authors': ArticleAuthorsSelect<false> | ArticleAuthorsSelect<true>;
|
|
221
230
|
'article-categories': ArticleCategoriesSelect<false> | ArticleCategoriesSelect<true>;
|
|
@@ -961,7 +970,7 @@ interface Webhook {
|
|
|
961
970
|
/**
|
|
962
971
|
* Receives create/update events for this collection.
|
|
963
972
|
*/
|
|
964
|
-
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' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | '
|
|
973
|
+
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' | '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' | 'canvas-nodes' | 'canvas-edges' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags';
|
|
965
974
|
id?: string | null;
|
|
966
975
|
}[] | null;
|
|
967
976
|
isActive?: boolean | null;
|
|
@@ -1646,7 +1655,7 @@ interface Product {
|
|
|
1646
1655
|
id: string;
|
|
1647
1656
|
_order?: string | null;
|
|
1648
1657
|
tenant?: (string | null) | Tenant;
|
|
1649
|
-
title
|
|
1658
|
+
title?: string | null;
|
|
1650
1659
|
/**
|
|
1651
1660
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
1652
1661
|
*/
|
|
@@ -1714,13 +1723,37 @@ interface Product {
|
|
|
1714
1723
|
* Derived listing projection for product cards and search
|
|
1715
1724
|
*/
|
|
1716
1725
|
listing?: {
|
|
1726
|
+
/**
|
|
1727
|
+
* Variant prioritized for product cards. Automatically derived from sellable variants, active variants, and sort order.
|
|
1728
|
+
*/
|
|
1717
1729
|
selectionHintVariant?: (string | null) | ProductVariant;
|
|
1730
|
+
/**
|
|
1731
|
+
* Primary image for product cards/search. Product media is preferred, then variant media is used as fallback.
|
|
1732
|
+
*/
|
|
1718
1733
|
primaryImage?: (string | null) | Image;
|
|
1734
|
+
/**
|
|
1735
|
+
* Lowest active variant price. Automatically recalculated when variants change.
|
|
1736
|
+
*/
|
|
1719
1737
|
minPrice?: number | null;
|
|
1738
|
+
/**
|
|
1739
|
+
* Highest active variant price. Automatically recalculated when variants change.
|
|
1740
|
+
*/
|
|
1720
1741
|
maxPrice?: number | null;
|
|
1742
|
+
/**
|
|
1743
|
+
* Lowest compare-at price across active variants. Automatically recalculated when variants change.
|
|
1744
|
+
*/
|
|
1721
1745
|
minCompareAtPrice?: number | null;
|
|
1746
|
+
/**
|
|
1747
|
+
* Highest compare-at price across active variants. Automatically recalculated when variants change.
|
|
1748
|
+
*/
|
|
1722
1749
|
maxCompareAtPrice?: number | null;
|
|
1750
|
+
/**
|
|
1751
|
+
* Automatically enabled when the minimum and maximum active variant prices differ.
|
|
1752
|
+
*/
|
|
1723
1753
|
isPriceRange?: boolean | null;
|
|
1754
|
+
/**
|
|
1755
|
+
* Automatically enabled when at least one active variant is sellable.
|
|
1756
|
+
*/
|
|
1724
1757
|
availableForSale?: boolean | null;
|
|
1725
1758
|
};
|
|
1726
1759
|
metadata?: {
|
|
@@ -1785,7 +1818,7 @@ interface Product {
|
|
|
1785
1818
|
interface Video {
|
|
1786
1819
|
id: string;
|
|
1787
1820
|
tenant?: (string | null) | Tenant;
|
|
1788
|
-
title
|
|
1821
|
+
title?: string | null;
|
|
1789
1822
|
/**
|
|
1790
1823
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
1791
1824
|
*/
|
|
@@ -1892,7 +1925,7 @@ interface Video {
|
|
|
1892
1925
|
interface LiveStream {
|
|
1893
1926
|
id: string;
|
|
1894
1927
|
tenant?: (string | null) | Tenant;
|
|
1895
|
-
title
|
|
1928
|
+
title?: string | null;
|
|
1896
1929
|
/**
|
|
1897
1930
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
1898
1931
|
*/
|
|
@@ -1985,7 +2018,7 @@ interface VideoCategory {
|
|
|
1985
2018
|
id: string;
|
|
1986
2019
|
_order?: string | null;
|
|
1987
2020
|
tenant?: (string | null) | Tenant;
|
|
1988
|
-
title
|
|
2021
|
+
title?: string | null;
|
|
1989
2022
|
/**
|
|
1990
2023
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
1991
2024
|
*/
|
|
@@ -2010,7 +2043,7 @@ interface VideoTag {
|
|
|
2010
2043
|
id: string;
|
|
2011
2044
|
_order?: string | null;
|
|
2012
2045
|
tenant?: (string | null) | Tenant;
|
|
2013
|
-
title
|
|
2046
|
+
title?: string | null;
|
|
2014
2047
|
/**
|
|
2015
2048
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
2016
2049
|
*/
|
|
@@ -2036,7 +2069,13 @@ interface ProductVariant {
|
|
|
2036
2069
|
'_product-variants_variants_order'?: string | null;
|
|
2037
2070
|
_order?: string | null;
|
|
2038
2071
|
tenant?: (string | null) | Tenant;
|
|
2072
|
+
/**
|
|
2073
|
+
* Parent product for this variant. It cannot be moved to another product after creation.
|
|
2074
|
+
*/
|
|
2039
2075
|
product: string | Product;
|
|
2076
|
+
/**
|
|
2077
|
+
* Optional variant display label. The option value combination remains the canonical variant identity.
|
|
2078
|
+
*/
|
|
2040
2079
|
title?: string | null;
|
|
2041
2080
|
thumbnail?: (string | null) | Image;
|
|
2042
2081
|
images?: (string | Image)[] | null;
|
|
@@ -2056,6 +2095,9 @@ interface ProductVariant {
|
|
|
2056
2095
|
* Sell without tracking inventory
|
|
2057
2096
|
*/
|
|
2058
2097
|
isUnlimited?: boolean | null;
|
|
2098
|
+
/**
|
|
2099
|
+
* Tracked inventory. Available quantity is stock - reservedStock; isUnlimited bypasses stock tracking.
|
|
2100
|
+
*/
|
|
2059
2101
|
stock?: number | null;
|
|
2060
2102
|
/**
|
|
2061
2103
|
* Paid orders in transit (available quantity is stock - reservedStock)
|
|
@@ -2069,6 +2111,9 @@ interface ProductVariant {
|
|
|
2069
2111
|
* Variant-specific weight (g)
|
|
2070
2112
|
*/
|
|
2071
2113
|
weight?: number | null;
|
|
2114
|
+
/**
|
|
2115
|
+
* Enable for physical variants that require shipping.
|
|
2116
|
+
*/
|
|
2072
2117
|
requiresShipping?: boolean | null;
|
|
2073
2118
|
/**
|
|
2074
2119
|
* External system ID
|
|
@@ -2096,6 +2141,9 @@ interface ProductOptionValue {
|
|
|
2096
2141
|
'_product-option-values_values_order'?: string | null;
|
|
2097
2142
|
_order?: string | null;
|
|
2098
2143
|
tenant?: (string | null) | Tenant;
|
|
2144
|
+
/**
|
|
2145
|
+
* Parent option for this value. It cannot be moved to another option after creation.
|
|
2146
|
+
*/
|
|
2099
2147
|
option: string | ProductOption;
|
|
2100
2148
|
/**
|
|
2101
2149
|
* Display label (e.g. Black, S)
|
|
@@ -2128,6 +2176,9 @@ interface ProductOption {
|
|
|
2128
2176
|
'_product-options_options_order'?: string | null;
|
|
2129
2177
|
_order?: string | null;
|
|
2130
2178
|
tenant?: (string | null) | Tenant;
|
|
2179
|
+
/**
|
|
2180
|
+
* Parent product for this option. It cannot be moved to another product after creation.
|
|
2181
|
+
*/
|
|
2131
2182
|
product: string | Product;
|
|
2132
2183
|
/**
|
|
2133
2184
|
* Option name (e.g. Color, Size)
|
|
@@ -2150,7 +2201,7 @@ interface ProductCategory {
|
|
|
2150
2201
|
id: string;
|
|
2151
2202
|
_order?: string | null;
|
|
2152
2203
|
tenant?: (string | null) | Tenant;
|
|
2153
|
-
title
|
|
2204
|
+
title?: string | null;
|
|
2154
2205
|
/**
|
|
2155
2206
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
2156
2207
|
*/
|
|
@@ -2175,7 +2226,7 @@ interface ProductTag {
|
|
|
2175
2226
|
id: string;
|
|
2176
2227
|
_order?: string | null;
|
|
2177
2228
|
tenant?: (string | null) | Tenant;
|
|
2178
|
-
title
|
|
2229
|
+
title?: string | null;
|
|
2179
2230
|
/**
|
|
2180
2231
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
2181
2232
|
*/
|
|
@@ -2389,7 +2440,7 @@ interface ShippingPolicy {
|
|
|
2389
2440
|
/**
|
|
2390
2441
|
* e.g. Standard shipping, Large items
|
|
2391
2442
|
*/
|
|
2392
|
-
title
|
|
2443
|
+
title?: string | null;
|
|
2393
2444
|
/**
|
|
2394
2445
|
* Amount in KRW (won)
|
|
2395
2446
|
*/
|
|
@@ -2436,7 +2487,7 @@ interface ProductCollection {
|
|
|
2436
2487
|
id: string;
|
|
2437
2488
|
_order?: string | null;
|
|
2438
2489
|
tenant?: (string | null) | Tenant;
|
|
2439
|
-
title
|
|
2490
|
+
title?: string | null;
|
|
2440
2491
|
/**
|
|
2441
2492
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
2442
2493
|
*/
|
|
@@ -2760,7 +2811,7 @@ interface CustomerGroup {
|
|
|
2760
2811
|
id: string;
|
|
2761
2812
|
_order?: string | null;
|
|
2762
2813
|
tenant?: (string | null) | Tenant;
|
|
2763
|
-
title
|
|
2814
|
+
title?: string | null;
|
|
2764
2815
|
/**
|
|
2765
2816
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
2766
2817
|
*/
|
|
@@ -2926,6 +2977,12 @@ interface OrderItem {
|
|
|
2926
2977
|
*/
|
|
2927
2978
|
totalPrice: number;
|
|
2928
2979
|
productTitle?: string | null;
|
|
2980
|
+
/**
|
|
2981
|
+
* Option combination snapshot at order time. Later variant/option changes do not rewrite it.
|
|
2982
|
+
*/
|
|
2983
|
+
optionSelection?: {
|
|
2984
|
+
[k: string]: unknown;
|
|
2985
|
+
} | unknown[] | string | number | boolean | null;
|
|
2929
2986
|
/**
|
|
2930
2987
|
* Tax rate at time of order (%)
|
|
2931
2988
|
*/
|
|
@@ -2934,6 +2991,18 @@ interface OrderItem {
|
|
|
2934
2991
|
* Currency at time of order (ISO-4217)
|
|
2935
2992
|
*/
|
|
2936
2993
|
currency?: string | null;
|
|
2994
|
+
/**
|
|
2995
|
+
* Snapshot of the discount amount allocated to this line at order time (minor units).
|
|
2996
|
+
*/
|
|
2997
|
+
discountAllocation?: number | null;
|
|
2998
|
+
/**
|
|
2999
|
+
* Per-unit price snapshot after discount allocation. round(discountedTotalPrice / quantity).
|
|
3000
|
+
*/
|
|
3001
|
+
discountedUnitPrice?: number | null;
|
|
3002
|
+
/**
|
|
3003
|
+
* Line total snapshot after discount allocation at order time (totalPrice - discountAllocation).
|
|
3004
|
+
*/
|
|
3005
|
+
discountedTotalPrice?: number | null;
|
|
2937
3006
|
updatedAt: string;
|
|
2938
3007
|
createdAt: string;
|
|
2939
3008
|
deletedAt?: string | null;
|
|
@@ -2962,6 +3031,12 @@ interface Transaction {
|
|
|
2962
3031
|
receiptUrl?: string | null;
|
|
2963
3032
|
pgPaymentId?: string | null;
|
|
2964
3033
|
pgOrderId?: string | null;
|
|
3034
|
+
providerEventId?: string | null;
|
|
3035
|
+
providerStatus?: string | null;
|
|
3036
|
+
confirmedAmount?: number | null;
|
|
3037
|
+
confirmedCurrency?: string | null;
|
|
3038
|
+
confirmedAt?: string | null;
|
|
3039
|
+
confirmationSource?: ('provider_webhook' | 'provider_lookup' | 'provider_api_confirm' | 'manual_server') | null;
|
|
2965
3040
|
cashReceipt?: {
|
|
2966
3041
|
issuanceType?: ('none' | 'personal' | 'business') | null;
|
|
2967
3042
|
/**
|
|
@@ -3089,6 +3164,14 @@ interface Return {
|
|
|
3089
3164
|
*/
|
|
3090
3165
|
refundReceiptUrl?: string | null;
|
|
3091
3166
|
refundAmount: number;
|
|
3167
|
+
/**
|
|
3168
|
+
* Return shipping fee deducted from refundAmount
|
|
3169
|
+
*/
|
|
3170
|
+
returnShippingFee?: number | null;
|
|
3171
|
+
/**
|
|
3172
|
+
* Exchange balance (positive: extra charge, negative: extra refund)
|
|
3173
|
+
*/
|
|
3174
|
+
exchangeDifference?: number | null;
|
|
3092
3175
|
metadata?: {
|
|
3093
3176
|
[k: string]: unknown;
|
|
3094
3177
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -3111,6 +3194,10 @@ interface ReturnItem {
|
|
|
3111
3194
|
variant?: (string | null) | ProductVariant;
|
|
3112
3195
|
quantity: number;
|
|
3113
3196
|
restockAction: 'return_to_stock' | 'discard';
|
|
3197
|
+
/**
|
|
3198
|
+
* Restocking fee for this line (deducted from line refund)
|
|
3199
|
+
*/
|
|
3200
|
+
restockingFee?: number | null;
|
|
3114
3201
|
productTitle?: string | null;
|
|
3115
3202
|
updatedAt: string;
|
|
3116
3203
|
createdAt: string;
|
|
@@ -3137,6 +3224,58 @@ interface OrderStatusLog {
|
|
|
3137
3224
|
updatedAt: string;
|
|
3138
3225
|
createdAt: string;
|
|
3139
3226
|
}
|
|
3227
|
+
/**
|
|
3228
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
3229
|
+
* via the `definition` "inventory-reservations".
|
|
3230
|
+
*/
|
|
3231
|
+
interface InventoryReservation {
|
|
3232
|
+
id: string;
|
|
3233
|
+
tenant?: (string | null) | Tenant;
|
|
3234
|
+
order: string | Order;
|
|
3235
|
+
orderItem: string | OrderItem;
|
|
3236
|
+
variant: string | ProductVariant;
|
|
3237
|
+
quantity: number;
|
|
3238
|
+
status: 'held' | 'released' | 'consumed';
|
|
3239
|
+
statusChangedAt?: string | null;
|
|
3240
|
+
updatedAt: string;
|
|
3241
|
+
createdAt: string;
|
|
3242
|
+
deletedAt?: string | null;
|
|
3243
|
+
}
|
|
3244
|
+
/**
|
|
3245
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
3246
|
+
* via the `definition` "shipping-zones".
|
|
3247
|
+
*/
|
|
3248
|
+
interface ShippingZone {
|
|
3249
|
+
id: string;
|
|
3250
|
+
_order?: string | null;
|
|
3251
|
+
tenant?: (string | null) | Tenant;
|
|
3252
|
+
/**
|
|
3253
|
+
* Display name (e.g. Jeju, Remote Islands) for operator reference
|
|
3254
|
+
*/
|
|
3255
|
+
title?: string | null;
|
|
3256
|
+
/**
|
|
3257
|
+
* kind=jeju|remote-islands routes surcharge through shipping-policies fields; kind=custom uses this zone's extraAmount.
|
|
3258
|
+
*/
|
|
3259
|
+
kind: 'jeju' | 'remote-islands' | 'custom';
|
|
3260
|
+
postalCodePatterns: {
|
|
3261
|
+
/**
|
|
3262
|
+
* Postal code prefix (e.g. 230, 525) or numeric range (e.g. 63000-63644)
|
|
3263
|
+
*/
|
|
3264
|
+
pattern: string;
|
|
3265
|
+
id?: string | null;
|
|
3266
|
+
}[];
|
|
3267
|
+
/**
|
|
3268
|
+
* Surcharge applied when kind=custom. Ignored for jeju and remote-islands (those route through shipping-policies).
|
|
3269
|
+
*/
|
|
3270
|
+
extraAmount?: number | null;
|
|
3271
|
+
isActive?: boolean | null;
|
|
3272
|
+
metadata?: {
|
|
3273
|
+
[k: string]: unknown;
|
|
3274
|
+
} | unknown[] | string | number | boolean | null;
|
|
3275
|
+
updatedAt: string;
|
|
3276
|
+
createdAt: string;
|
|
3277
|
+
deletedAt?: string | null;
|
|
3278
|
+
}
|
|
3140
3279
|
/**
|
|
3141
3280
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3142
3281
|
* via the `definition` "customer-profile-lists".
|
|
@@ -3145,7 +3284,7 @@ interface CustomerProfileList {
|
|
|
3145
3284
|
id: string;
|
|
3146
3285
|
_order?: string | null;
|
|
3147
3286
|
tenant?: (string | null) | Tenant;
|
|
3148
|
-
title
|
|
3287
|
+
title?: string | null;
|
|
3149
3288
|
/**
|
|
3150
3289
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3151
3290
|
*/
|
|
@@ -3248,6 +3387,18 @@ interface CartItem {
|
|
|
3248
3387
|
* Price at the time of adding to cart
|
|
3249
3388
|
*/
|
|
3250
3389
|
unitPrice: number;
|
|
3390
|
+
/**
|
|
3391
|
+
* Minor-unit discount allocated to this line from the header discount. Populated by recalculateCartTotals.
|
|
3392
|
+
*/
|
|
3393
|
+
discountAllocation?: number | null;
|
|
3394
|
+
/**
|
|
3395
|
+
* Per-unit price after discount allocation (display). round(discountedTotalPrice / quantity).
|
|
3396
|
+
*/
|
|
3397
|
+
discountedUnitPrice?: number | null;
|
|
3398
|
+
/**
|
|
3399
|
+
* Line total after discount allocation (totalPrice - discountAllocation). Populated by recalculateCartTotals.
|
|
3400
|
+
*/
|
|
3401
|
+
discountedTotalPrice?: number | null;
|
|
3251
3402
|
metadata?: {
|
|
3252
3403
|
[k: string]: unknown;
|
|
3253
3404
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -3348,29 +3499,6 @@ interface Discount {
|
|
|
3348
3499
|
createdAt: string;
|
|
3349
3500
|
deletedAt?: string | null;
|
|
3350
3501
|
}
|
|
3351
|
-
/**
|
|
3352
|
-
* This interface was referenced by `Config`'s JSON-Schema
|
|
3353
|
-
* via the `definition` "promotions".
|
|
3354
|
-
*/
|
|
3355
|
-
interface Promotion {
|
|
3356
|
-
id: string;
|
|
3357
|
-
tenant?: (string | null) | Tenant;
|
|
3358
|
-
/**
|
|
3359
|
-
* Promotion code
|
|
3360
|
-
*/
|
|
3361
|
-
code: string;
|
|
3362
|
-
discountType: 'percent' | 'fixed' | 'free-shipping';
|
|
3363
|
-
/**
|
|
3364
|
-
* Discount value (percent: 0-100, fixed: minor unit)
|
|
3365
|
-
*/
|
|
3366
|
-
discountValue?: number | null;
|
|
3367
|
-
validFrom?: string | null;
|
|
3368
|
-
validUntil?: string | null;
|
|
3369
|
-
status: 'draft' | 'active' | 'paused' | 'expired';
|
|
3370
|
-
updatedAt: string;
|
|
3371
|
-
createdAt: string;
|
|
3372
|
-
deletedAt?: string | null;
|
|
3373
|
-
}
|
|
3374
3502
|
/**
|
|
3375
3503
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3376
3504
|
* via the `definition` "articles".
|
|
@@ -3379,7 +3507,7 @@ interface Article {
|
|
|
3379
3507
|
id: string;
|
|
3380
3508
|
_order?: string | null;
|
|
3381
3509
|
tenant?: (string | null) | Tenant;
|
|
3382
|
-
title
|
|
3510
|
+
title?: string | null;
|
|
3383
3511
|
/**
|
|
3384
3512
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
3385
3513
|
*/
|
|
@@ -3522,7 +3650,7 @@ interface ArticleCategory {
|
|
|
3522
3650
|
id: string;
|
|
3523
3651
|
_order?: string | null;
|
|
3524
3652
|
tenant?: (string | null) | Tenant;
|
|
3525
|
-
title
|
|
3653
|
+
title?: string | null;
|
|
3526
3654
|
/**
|
|
3527
3655
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3528
3656
|
*/
|
|
@@ -3547,7 +3675,7 @@ interface ArticleTag {
|
|
|
3547
3675
|
id: string;
|
|
3548
3676
|
_order?: string | null;
|
|
3549
3677
|
tenant?: (string | null) | Tenant;
|
|
3550
|
-
title
|
|
3678
|
+
title?: string | null;
|
|
3551
3679
|
/**
|
|
3552
3680
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3553
3681
|
*/
|
|
@@ -3572,7 +3700,7 @@ interface Document {
|
|
|
3572
3700
|
id: string;
|
|
3573
3701
|
_order?: string | null;
|
|
3574
3702
|
tenant?: (string | null) | Tenant;
|
|
3575
|
-
title
|
|
3703
|
+
title?: string | null;
|
|
3576
3704
|
/**
|
|
3577
3705
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
3578
3706
|
*/
|
|
@@ -3692,7 +3820,7 @@ interface DocumentCategory {
|
|
|
3692
3820
|
id: string;
|
|
3693
3821
|
_order?: string | null;
|
|
3694
3822
|
tenant?: (string | null) | Tenant;
|
|
3695
|
-
title
|
|
3823
|
+
title?: string | null;
|
|
3696
3824
|
/**
|
|
3697
3825
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3698
3826
|
*/
|
|
@@ -3717,7 +3845,7 @@ interface DocumentType {
|
|
|
3717
3845
|
id: string;
|
|
3718
3846
|
_order?: string | null;
|
|
3719
3847
|
tenant?: (string | null) | Tenant;
|
|
3720
|
-
title
|
|
3848
|
+
title?: string | null;
|
|
3721
3849
|
/**
|
|
3722
3850
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3723
3851
|
*/
|
|
@@ -3741,7 +3869,7 @@ interface Playlist {
|
|
|
3741
3869
|
id: string;
|
|
3742
3870
|
_order?: string | null;
|
|
3743
3871
|
tenant?: (string | null) | Tenant;
|
|
3744
|
-
title
|
|
3872
|
+
title?: string | null;
|
|
3745
3873
|
/**
|
|
3746
3874
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
3747
3875
|
*/
|
|
@@ -3750,7 +3878,6 @@ interface Playlist {
|
|
|
3750
3878
|
* Short summary for listing/cards
|
|
3751
3879
|
*/
|
|
3752
3880
|
description?: string | null;
|
|
3753
|
-
videos?: (string | Video)[] | null;
|
|
3754
3881
|
categories?: (string | PlaylistCategory)[] | null;
|
|
3755
3882
|
tags?: (string | PlaylistTag)[] | null;
|
|
3756
3883
|
/**
|
|
@@ -3790,8 +3917,6 @@ interface Playlist {
|
|
|
3790
3917
|
};
|
|
3791
3918
|
};
|
|
3792
3919
|
thumbnail?: (string | null) | Image;
|
|
3793
|
-
coverArt?: (string | null) | Image;
|
|
3794
|
-
isCollaborative?: boolean | null;
|
|
3795
3920
|
/**
|
|
3796
3921
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3797
3922
|
*/
|
|
@@ -3815,7 +3940,7 @@ interface PlaylistCategory {
|
|
|
3815
3940
|
id: string;
|
|
3816
3941
|
_order?: string | null;
|
|
3817
3942
|
tenant?: (string | null) | Tenant;
|
|
3818
|
-
title
|
|
3943
|
+
title?: string | null;
|
|
3819
3944
|
/**
|
|
3820
3945
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3821
3946
|
*/
|
|
@@ -3840,7 +3965,7 @@ interface PlaylistTag {
|
|
|
3840
3965
|
id: string;
|
|
3841
3966
|
_order?: string | null;
|
|
3842
3967
|
tenant?: (string | null) | Tenant;
|
|
3843
|
-
title
|
|
3968
|
+
title?: string | null;
|
|
3844
3969
|
/**
|
|
3845
3970
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3846
3971
|
*/
|
|
@@ -3865,26 +3990,11 @@ interface Track {
|
|
|
3865
3990
|
id: string;
|
|
3866
3991
|
_order?: string | null;
|
|
3867
3992
|
tenant?: (string | null) | Tenant;
|
|
3868
|
-
title
|
|
3993
|
+
title?: string | null;
|
|
3869
3994
|
/**
|
|
3870
3995
|
* Short summary for listing/cards
|
|
3871
3996
|
*/
|
|
3872
3997
|
description?: string | null;
|
|
3873
|
-
content?: {
|
|
3874
|
-
root: {
|
|
3875
|
-
type: string;
|
|
3876
|
-
children: {
|
|
3877
|
-
type: any;
|
|
3878
|
-
version: number;
|
|
3879
|
-
[k: string]: unknown;
|
|
3880
|
-
}[];
|
|
3881
|
-
direction: ('ltr' | 'rtl') | null;
|
|
3882
|
-
format: 'left' | 'start' | 'center' | 'right' | 'end' | 'justify' | '';
|
|
3883
|
-
indent: number;
|
|
3884
|
-
version: number;
|
|
3885
|
-
};
|
|
3886
|
-
[k: string]: unknown;
|
|
3887
|
-
} | null;
|
|
3888
3998
|
artist?: string | null;
|
|
3889
3999
|
album?: string | null;
|
|
3890
4000
|
releaseDate?: string | null;
|
|
@@ -3898,13 +4008,10 @@ interface Track {
|
|
|
3898
4008
|
slug?: string | null;
|
|
3899
4009
|
thumbnail?: (string | null) | Image;
|
|
3900
4010
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
3901
|
-
isFeatured?: boolean | null;
|
|
3902
|
-
publishedAt?: string | null;
|
|
3903
4011
|
/**
|
|
3904
4012
|
* Duration in seconds
|
|
3905
4013
|
*/
|
|
3906
4014
|
durationSeconds?: number | null;
|
|
3907
|
-
isEmbeddable?: boolean | null;
|
|
3908
4015
|
metadata?: {
|
|
3909
4016
|
[k: string]: unknown;
|
|
3910
4017
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -3932,7 +4039,7 @@ interface TrackCategory {
|
|
|
3932
4039
|
id: string;
|
|
3933
4040
|
_order?: string | null;
|
|
3934
4041
|
tenant?: (string | null) | Tenant;
|
|
3935
|
-
title
|
|
4042
|
+
title?: string | null;
|
|
3936
4043
|
/**
|
|
3937
4044
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3938
4045
|
*/
|
|
@@ -3957,7 +4064,7 @@ interface TrackTag {
|
|
|
3957
4064
|
id: string;
|
|
3958
4065
|
_order?: string | null;
|
|
3959
4066
|
tenant?: (string | null) | Tenant;
|
|
3960
|
-
title
|
|
4067
|
+
title?: string | null;
|
|
3961
4068
|
/**
|
|
3962
4069
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3963
4070
|
*/
|
|
@@ -4007,7 +4114,7 @@ interface Gallery {
|
|
|
4007
4114
|
id: string;
|
|
4008
4115
|
_order?: string | null;
|
|
4009
4116
|
tenant?: (string | null) | Tenant;
|
|
4010
|
-
title
|
|
4117
|
+
title?: string | null;
|
|
4011
4118
|
/**
|
|
4012
4119
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
4013
4120
|
*/
|
|
@@ -4084,7 +4191,7 @@ interface GalleryCategory {
|
|
|
4084
4191
|
id: string;
|
|
4085
4192
|
_order?: string | null;
|
|
4086
4193
|
tenant?: (string | null) | Tenant;
|
|
4087
|
-
title
|
|
4194
|
+
title?: string | null;
|
|
4088
4195
|
/**
|
|
4089
4196
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4090
4197
|
*/
|
|
@@ -4109,7 +4216,7 @@ interface GalleryTag {
|
|
|
4109
4216
|
id: string;
|
|
4110
4217
|
_order?: string | null;
|
|
4111
4218
|
tenant?: (string | null) | Tenant;
|
|
4112
|
-
title
|
|
4219
|
+
title?: string | null;
|
|
4113
4220
|
/**
|
|
4114
4221
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4115
4222
|
*/
|
|
@@ -4173,7 +4280,7 @@ interface Link {
|
|
|
4173
4280
|
id: string;
|
|
4174
4281
|
_order?: string | null;
|
|
4175
4282
|
tenant?: (string | null) | Tenant;
|
|
4176
|
-
title
|
|
4283
|
+
title?: string | null;
|
|
4177
4284
|
/**
|
|
4178
4285
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
4179
4286
|
*/
|
|
@@ -4235,7 +4342,7 @@ interface LinkCategory {
|
|
|
4235
4342
|
id: string;
|
|
4236
4343
|
_order?: string | null;
|
|
4237
4344
|
tenant?: (string | null) | Tenant;
|
|
4238
|
-
title
|
|
4345
|
+
title?: string | null;
|
|
4239
4346
|
/**
|
|
4240
4347
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4241
4348
|
*/
|
|
@@ -4260,7 +4367,7 @@ interface LinkTag {
|
|
|
4260
4367
|
id: string;
|
|
4261
4368
|
_order?: string | null;
|
|
4262
4369
|
tenant?: (string | null) | Tenant;
|
|
4263
|
-
title
|
|
4370
|
+
title?: string | null;
|
|
4264
4371
|
/**
|
|
4265
4372
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4266
4373
|
*/
|
|
@@ -4284,7 +4391,7 @@ interface LinkTag {
|
|
|
4284
4391
|
interface Canvase {
|
|
4285
4392
|
id: string;
|
|
4286
4393
|
tenant?: (string | null) | Tenant;
|
|
4287
|
-
title
|
|
4394
|
+
title?: string | null;
|
|
4288
4395
|
/**
|
|
4289
4396
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
4290
4397
|
*/
|
|
@@ -4355,7 +4462,7 @@ interface CanvasCategory {
|
|
|
4355
4462
|
id: string;
|
|
4356
4463
|
_order?: string | null;
|
|
4357
4464
|
tenant?: (string | null) | Tenant;
|
|
4358
|
-
title
|
|
4465
|
+
title?: string | null;
|
|
4359
4466
|
/**
|
|
4360
4467
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4361
4468
|
*/
|
|
@@ -4380,7 +4487,7 @@ interface CanvasTag {
|
|
|
4380
4487
|
id: string;
|
|
4381
4488
|
_order?: string | null;
|
|
4382
4489
|
tenant?: (string | null) | Tenant;
|
|
4383
|
-
title
|
|
4490
|
+
title?: string | null;
|
|
4384
4491
|
/**
|
|
4385
4492
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4386
4493
|
*/
|
|
@@ -4405,7 +4512,7 @@ interface CanvasNodeType {
|
|
|
4405
4512
|
id: string;
|
|
4406
4513
|
_order?: string | null;
|
|
4407
4514
|
tenant?: (string | null) | Tenant;
|
|
4408
|
-
title
|
|
4515
|
+
title?: string | null;
|
|
4409
4516
|
/**
|
|
4410
4517
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4411
4518
|
*/
|
|
@@ -4470,7 +4577,7 @@ interface CanvasEdgeType {
|
|
|
4470
4577
|
id: string;
|
|
4471
4578
|
_order?: string | null;
|
|
4472
4579
|
tenant?: (string | null) | Tenant;
|
|
4473
|
-
title
|
|
4580
|
+
title?: string | null;
|
|
4474
4581
|
/**
|
|
4475
4582
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4476
4583
|
*/
|
|
@@ -4667,7 +4774,7 @@ interface PostCategory {
|
|
|
4667
4774
|
id: string;
|
|
4668
4775
|
_order?: string | null;
|
|
4669
4776
|
tenant?: (string | null) | Tenant;
|
|
4670
|
-
title
|
|
4777
|
+
title?: string | null;
|
|
4671
4778
|
/**
|
|
4672
4779
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4673
4780
|
*/
|
|
@@ -4758,7 +4865,7 @@ interface ReactionType {
|
|
|
4758
4865
|
id: string;
|
|
4759
4866
|
_order?: string | null;
|
|
4760
4867
|
tenant?: (string | null) | Tenant;
|
|
4761
|
-
title
|
|
4868
|
+
title?: string | null;
|
|
4762
4869
|
/**
|
|
4763
4870
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
4764
4871
|
*/
|
|
@@ -4852,7 +4959,7 @@ interface EventCalendar {
|
|
|
4852
4959
|
id: string;
|
|
4853
4960
|
_order?: string | null;
|
|
4854
4961
|
tenant?: (string | null) | Tenant;
|
|
4855
|
-
title
|
|
4962
|
+
title?: string | null;
|
|
4856
4963
|
/**
|
|
4857
4964
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
4858
4965
|
*/
|
|
@@ -4876,8 +4983,17 @@ interface EventCalendar {
|
|
|
4876
4983
|
};
|
|
4877
4984
|
[k: string]: unknown;
|
|
4878
4985
|
} | null;
|
|
4986
|
+
/**
|
|
4987
|
+
* Default listing behavior for the public event calendar.
|
|
4988
|
+
*/
|
|
4879
4989
|
publicListing?: {
|
|
4990
|
+
/**
|
|
4991
|
+
* Controls whether public listings include past occurrences.
|
|
4992
|
+
*/
|
|
4880
4993
|
showPastOccurrences?: boolean | null;
|
|
4994
|
+
/**
|
|
4995
|
+
* Default number of future months shown in public listings.
|
|
4996
|
+
*/
|
|
4881
4997
|
defaultRangeMonths?: number | null;
|
|
4882
4998
|
};
|
|
4883
4999
|
seo?: {
|
|
@@ -4918,9 +5034,15 @@ interface EventCalendar {
|
|
|
4918
5034
|
generateSlug?: boolean | null;
|
|
4919
5035
|
slug?: string | null;
|
|
4920
5036
|
status?: ('draft' | 'published' | 'archived') | null;
|
|
4921
|
-
|
|
5037
|
+
/**
|
|
5038
|
+
* Default IANA time zone for this calendar.
|
|
5039
|
+
*/
|
|
5040
|
+
timezone?: string | null;
|
|
4922
5041
|
color?: string | null;
|
|
4923
|
-
|
|
5042
|
+
/**
|
|
5043
|
+
* Visibility for the tenant-global calendar.
|
|
5044
|
+
*/
|
|
5045
|
+
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
4924
5046
|
publishedAt?: string | null;
|
|
4925
5047
|
metadata?: {
|
|
4926
5048
|
[k: string]: unknown;
|
|
@@ -4937,7 +5059,7 @@ interface Event {
|
|
|
4937
5059
|
id: string;
|
|
4938
5060
|
_order?: string | null;
|
|
4939
5061
|
tenant?: (string | null) | Tenant;
|
|
4940
|
-
title
|
|
5062
|
+
title?: string | null;
|
|
4941
5063
|
/**
|
|
4942
5064
|
* Secondary display line shown in cards, listings, and detail headers.
|
|
4943
5065
|
*/
|
|
@@ -4967,15 +5089,30 @@ interface Event {
|
|
|
4967
5089
|
* Products shown with this event. Available only when the Event commerce recipe is active for the tenant.
|
|
4968
5090
|
*/
|
|
4969
5091
|
products?: (string | Product)[] | null;
|
|
5092
|
+
/**
|
|
5093
|
+
* Organizer display details. Linked users must belong to the same workspace.
|
|
5094
|
+
*/
|
|
4970
5095
|
organizer?: {
|
|
4971
5096
|
name?: string | null;
|
|
4972
5097
|
url?: string | null;
|
|
4973
5098
|
user?: (string | null) | User;
|
|
4974
5099
|
};
|
|
5100
|
+
/**
|
|
5101
|
+
* Primary start time. For recurring events, this is the first occurrence anchor.
|
|
5102
|
+
*/
|
|
4975
5103
|
startsAt: string;
|
|
5104
|
+
/**
|
|
5105
|
+
* Primary end time. Must be after the start time.
|
|
5106
|
+
*/
|
|
4976
5107
|
endsAt: string;
|
|
4977
|
-
|
|
5108
|
+
/**
|
|
5109
|
+
* IANA time zone used to expand recurring occurrences.
|
|
5110
|
+
*/
|
|
5111
|
+
timezone?: string | null;
|
|
4978
5112
|
isAllDay?: boolean | null;
|
|
5113
|
+
/**
|
|
5114
|
+
* Optional. Leave empty for a one-time event.
|
|
5115
|
+
*/
|
|
4979
5116
|
recurrence?: {
|
|
4980
5117
|
/**
|
|
4981
5118
|
* RFC 5545 RRULE string
|
|
@@ -4989,8 +5126,14 @@ interface Event {
|
|
|
4989
5126
|
date?: string | null;
|
|
4990
5127
|
id?: string | null;
|
|
4991
5128
|
}[] | null;
|
|
5129
|
+
/**
|
|
5130
|
+
* Number of future months to materialize. Allowed range is 1-12.
|
|
5131
|
+
*/
|
|
4992
5132
|
materializationMonths?: number | null;
|
|
4993
5133
|
};
|
|
5134
|
+
/**
|
|
5135
|
+
* Location details shown to attendees. Private notes are hidden from public API reads.
|
|
5136
|
+
*/
|
|
4994
5137
|
location?: {
|
|
4995
5138
|
type?: ('physical' | 'online' | 'hybrid' | 'hidden') | null;
|
|
4996
5139
|
name?: string | null;
|
|
@@ -4999,9 +5142,34 @@ interface Event {
|
|
|
4999
5142
|
onlineNote?: string | null;
|
|
5000
5143
|
privateNote?: string | null;
|
|
5001
5144
|
};
|
|
5145
|
+
/**
|
|
5146
|
+
* Registration mode. RSVP goes straight to Going; Approval stays pending until an operator approves it.
|
|
5147
|
+
*/
|
|
5002
5148
|
registrationPolicy?: ('none' | 'rsvp' | 'approval' | 'external') | null;
|
|
5149
|
+
/**
|
|
5150
|
+
* Controls whether full RSVP events accept waitlisted registrations.
|
|
5151
|
+
*/
|
|
5003
5152
|
waitlistPolicy?: ('disabled' | 'auto_waitlist') | null;
|
|
5153
|
+
/**
|
|
5154
|
+
* URL used when registration is handled outside this workspace.
|
|
5155
|
+
*/
|
|
5004
5156
|
externalRegistrationUrl?: string | null;
|
|
5157
|
+
/**
|
|
5158
|
+
* Occurrences generated for this event. Review schedule, capacity, and registration counts here, then open an occurrence to adjust operational values.
|
|
5159
|
+
*/
|
|
5160
|
+
occurrences?: {
|
|
5161
|
+
docs?: (string | EventOccurrence)[];
|
|
5162
|
+
hasNextPage?: boolean;
|
|
5163
|
+
totalDocs?: number;
|
|
5164
|
+
};
|
|
5165
|
+
/**
|
|
5166
|
+
* Registrations for this event. Creation and lifecycle status changes are handled by the registration collection and lifecycle actions.
|
|
5167
|
+
*/
|
|
5168
|
+
registrations?: {
|
|
5169
|
+
docs?: (string | EventRegistration)[];
|
|
5170
|
+
hasNextPage?: boolean;
|
|
5171
|
+
totalDocs?: number;
|
|
5172
|
+
};
|
|
5005
5173
|
seo?: {
|
|
5006
5174
|
/**
|
|
5007
5175
|
* Search result title (falls back to document title)
|
|
@@ -5039,10 +5207,19 @@ interface Event {
|
|
|
5039
5207
|
*/
|
|
5040
5208
|
generateSlug?: boolean | null;
|
|
5041
5209
|
slug?: string | null;
|
|
5042
|
-
status
|
|
5210
|
+
status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
|
|
5043
5211
|
coverImage?: (string | null) | Image;
|
|
5044
|
-
|
|
5212
|
+
/**
|
|
5213
|
+
* Public API visibility. Unlisted events are hidden from listings but remain available by direct lookup.
|
|
5214
|
+
*/
|
|
5215
|
+
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
5216
|
+
/**
|
|
5217
|
+
* Marks whether this event is authored here or imported from an external source.
|
|
5218
|
+
*/
|
|
5045
5219
|
sourceType?: ('native' | 'external') | null;
|
|
5220
|
+
/**
|
|
5221
|
+
* External event identity. Public API reads expose only provider and URL.
|
|
5222
|
+
*/
|
|
5046
5223
|
externalSource?: {
|
|
5047
5224
|
provider?: string | null;
|
|
5048
5225
|
sourceId?: string | null;
|
|
@@ -5064,7 +5241,7 @@ interface EventCategory {
|
|
|
5064
5241
|
id: string;
|
|
5065
5242
|
_order?: string | null;
|
|
5066
5243
|
tenant?: (string | null) | Tenant;
|
|
5067
|
-
title
|
|
5244
|
+
title?: string | null;
|
|
5068
5245
|
/**
|
|
5069
5246
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
5070
5247
|
*/
|
|
@@ -5089,7 +5266,7 @@ interface EventTag {
|
|
|
5089
5266
|
id: string;
|
|
5090
5267
|
_order?: string | null;
|
|
5091
5268
|
tenant?: (string | null) | Tenant;
|
|
5092
|
-
title
|
|
5269
|
+
title?: string | null;
|
|
5093
5270
|
/**
|
|
5094
5271
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
5095
5272
|
*/
|
|
@@ -5113,16 +5290,20 @@ interface EventTag {
|
|
|
5113
5290
|
interface EventOccurrence {
|
|
5114
5291
|
id: string;
|
|
5115
5292
|
tenant?: (string | null) | Tenant;
|
|
5293
|
+
/**
|
|
5294
|
+
* Human-readable occurrence title shown in relationship fields and lists. Generated from the event title and start time.
|
|
5295
|
+
*/
|
|
5296
|
+
displayTitle?: string | null;
|
|
5116
5297
|
event: string | Event;
|
|
5117
5298
|
/**
|
|
5118
5299
|
* RECURRENCE-ID based on original DTSTART
|
|
5119
5300
|
*/
|
|
5120
|
-
instanceKey
|
|
5301
|
+
instanceKey?: string | null;
|
|
5121
5302
|
startsAt: string;
|
|
5122
5303
|
endsAt: string;
|
|
5123
|
-
timezone
|
|
5304
|
+
timezone?: string | null;
|
|
5124
5305
|
isAllDay?: boolean | null;
|
|
5125
|
-
status
|
|
5306
|
+
status?: ('scheduled' | 'canceled' | 'completed') | null;
|
|
5126
5307
|
/**
|
|
5127
5308
|
* Location override for this occurrence only. Leave empty to use the event default location.
|
|
5128
5309
|
*/
|
|
@@ -5134,7 +5315,7 @@ interface EventOccurrence {
|
|
|
5134
5315
|
privateNote?: string | null;
|
|
5135
5316
|
};
|
|
5136
5317
|
/**
|
|
5137
|
-
* Capacity for this occurrence. Leave empty
|
|
5318
|
+
* Capacity for this occurrence. Leave empty for unlimited registrations.
|
|
5138
5319
|
*/
|
|
5139
5320
|
capacity?: number | null;
|
|
5140
5321
|
registrationCount?: number | null;
|
|
@@ -5143,6 +5324,14 @@ interface EventOccurrence {
|
|
|
5143
5324
|
opensAt?: string | null;
|
|
5144
5325
|
closesAt?: string | null;
|
|
5145
5326
|
};
|
|
5327
|
+
/**
|
|
5328
|
+
* Registrations linked to this occurrence. Registration status and check-in are managed through the registration collection and lifecycle actions.
|
|
5329
|
+
*/
|
|
5330
|
+
registrations?: {
|
|
5331
|
+
docs?: (string | EventRegistration)[];
|
|
5332
|
+
hasNextPage?: boolean;
|
|
5333
|
+
totalDocs?: number;
|
|
5334
|
+
};
|
|
5146
5335
|
cancellation?: {
|
|
5147
5336
|
canceledAt?: string | null;
|
|
5148
5337
|
reason?: string | null;
|
|
@@ -5161,15 +5350,30 @@ interface EventOccurrence {
|
|
|
5161
5350
|
interface EventRegistration {
|
|
5162
5351
|
id: string;
|
|
5163
5352
|
tenant?: (string | null) | Tenant;
|
|
5353
|
+
/**
|
|
5354
|
+
* Event this registration belongs to.
|
|
5355
|
+
*/
|
|
5164
5356
|
event: string | Event;
|
|
5357
|
+
/**
|
|
5358
|
+
* Occurrence this registration belongs to. Must belong to the same workspace as the event.
|
|
5359
|
+
*/
|
|
5165
5360
|
occurrence: string | EventOccurrence;
|
|
5361
|
+
/**
|
|
5362
|
+
* Linked customer for authenticated registrations. Guest registrations may leave this empty.
|
|
5363
|
+
*/
|
|
5166
5364
|
customer?: (string | null) | Customer;
|
|
5167
|
-
|
|
5168
|
-
|
|
5365
|
+
/**
|
|
5366
|
+
* Registration lifecycle status used for capacity accounting. Managed separately from attendance status.
|
|
5367
|
+
*/
|
|
5368
|
+
registrationStatus?: ('pending' | 'going' | 'waitlisted' | 'declined' | 'canceled') | null;
|
|
5369
|
+
/**
|
|
5370
|
+
* On-site attendance state. It changes to checked-in or no-show only for going registrations.
|
|
5371
|
+
*/
|
|
5372
|
+
attendanceStatus?: ('not_checked_in' | 'checked_in' | 'no_show') | null;
|
|
5169
5373
|
/**
|
|
5170
5374
|
* Number of attendees for this registration. Used for ticketing and capacity calculations.
|
|
5171
5375
|
*/
|
|
5172
|
-
quantity
|
|
5376
|
+
quantity?: number | null;
|
|
5173
5377
|
/**
|
|
5174
5378
|
* PII snapshot captured at registration time. Hidden from publishable-key reads and subject to retention cleanup.
|
|
5175
5379
|
*/
|
|
@@ -5198,10 +5402,16 @@ interface EventRegistration {
|
|
|
5198
5402
|
approvedBy?: (string | null) | User;
|
|
5199
5403
|
note?: string | null;
|
|
5200
5404
|
};
|
|
5405
|
+
/**
|
|
5406
|
+
* Cancellation timestamp and internal reason. Hidden from public API reads.
|
|
5407
|
+
*/
|
|
5201
5408
|
cancellation?: {
|
|
5202
5409
|
canceledAt?: string | null;
|
|
5203
5410
|
reason?: string | null;
|
|
5204
5411
|
};
|
|
5412
|
+
/**
|
|
5413
|
+
* Check-in audit data written by operator actions.
|
|
5414
|
+
*/
|
|
5205
5415
|
checkIn?: {
|
|
5206
5416
|
checkedInAt?: string | null;
|
|
5207
5417
|
checkedInBy?: (string | null) | User;
|
|
@@ -6655,8 +6865,12 @@ interface OrderItemsSelect<T extends boolean = true> {
|
|
|
6655
6865
|
requiresShipping?: T;
|
|
6656
6866
|
totalPrice?: T;
|
|
6657
6867
|
productTitle?: T;
|
|
6868
|
+
optionSelection?: T;
|
|
6658
6869
|
taxRate?: T;
|
|
6659
6870
|
currency?: T;
|
|
6871
|
+
discountAllocation?: T;
|
|
6872
|
+
discountedUnitPrice?: T;
|
|
6873
|
+
discountedTotalPrice?: T;
|
|
6660
6874
|
updatedAt?: T;
|
|
6661
6875
|
createdAt?: T;
|
|
6662
6876
|
deletedAt?: T;
|
|
@@ -6678,6 +6892,12 @@ interface TransactionsSelect<T extends boolean = true> {
|
|
|
6678
6892
|
receiptUrl?: T;
|
|
6679
6893
|
pgPaymentId?: T;
|
|
6680
6894
|
pgOrderId?: T;
|
|
6895
|
+
providerEventId?: T;
|
|
6896
|
+
providerStatus?: T;
|
|
6897
|
+
confirmedAmount?: T;
|
|
6898
|
+
confirmedCurrency?: T;
|
|
6899
|
+
confirmedAt?: T;
|
|
6900
|
+
confirmationSource?: T;
|
|
6681
6901
|
cashReceipt?: T | {
|
|
6682
6902
|
issuanceType?: T;
|
|
6683
6903
|
registrationNumber?: T;
|
|
@@ -6717,6 +6937,22 @@ interface OrderStatusLogsSelect<T extends boolean = true> {
|
|
|
6717
6937
|
updatedAt?: T;
|
|
6718
6938
|
createdAt?: T;
|
|
6719
6939
|
}
|
|
6940
|
+
/**
|
|
6941
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
6942
|
+
* via the `definition` "inventory-reservations_select".
|
|
6943
|
+
*/
|
|
6944
|
+
interface InventoryReservationsSelect<T extends boolean = true> {
|
|
6945
|
+
tenant?: T;
|
|
6946
|
+
order?: T;
|
|
6947
|
+
orderItem?: T;
|
|
6948
|
+
variant?: T;
|
|
6949
|
+
quantity?: T;
|
|
6950
|
+
status?: T;
|
|
6951
|
+
statusChangedAt?: T;
|
|
6952
|
+
updatedAt?: T;
|
|
6953
|
+
createdAt?: T;
|
|
6954
|
+
deletedAt?: T;
|
|
6955
|
+
}
|
|
6720
6956
|
/**
|
|
6721
6957
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6722
6958
|
* via the `definition` "fulfillments_select".
|
|
@@ -6769,6 +7005,8 @@ interface ReturnsSelect<T extends boolean = true> {
|
|
|
6769
7005
|
completedAt?: T;
|
|
6770
7006
|
refundReceiptUrl?: T;
|
|
6771
7007
|
refundAmount?: T;
|
|
7008
|
+
returnShippingFee?: T;
|
|
7009
|
+
exchangeDifference?: T;
|
|
6772
7010
|
metadata?: T;
|
|
6773
7011
|
updatedAt?: T;
|
|
6774
7012
|
createdAt?: T;
|
|
@@ -6788,6 +7026,7 @@ interface ReturnItemsSelect<T extends boolean = true> {
|
|
|
6788
7026
|
variant?: T;
|
|
6789
7027
|
quantity?: T;
|
|
6790
7028
|
restockAction?: T;
|
|
7029
|
+
restockingFee?: T;
|
|
6791
7030
|
productTitle?: T;
|
|
6792
7031
|
updatedAt?: T;
|
|
6793
7032
|
createdAt?: T;
|
|
@@ -6816,6 +7055,26 @@ interface ShippingPoliciesSelect<T extends boolean = true> {
|
|
|
6816
7055
|
createdAt?: T;
|
|
6817
7056
|
deletedAt?: T;
|
|
6818
7057
|
}
|
|
7058
|
+
/**
|
|
7059
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
7060
|
+
* via the `definition` "shipping-zones_select".
|
|
7061
|
+
*/
|
|
7062
|
+
interface ShippingZonesSelect<T extends boolean = true> {
|
|
7063
|
+
_order?: T;
|
|
7064
|
+
tenant?: T;
|
|
7065
|
+
title?: T;
|
|
7066
|
+
kind?: T;
|
|
7067
|
+
postalCodePatterns?: T | {
|
|
7068
|
+
pattern?: T;
|
|
7069
|
+
id?: T;
|
|
7070
|
+
};
|
|
7071
|
+
extraAmount?: T;
|
|
7072
|
+
isActive?: T;
|
|
7073
|
+
metadata?: T;
|
|
7074
|
+
updatedAt?: T;
|
|
7075
|
+
createdAt?: T;
|
|
7076
|
+
deletedAt?: T;
|
|
7077
|
+
}
|
|
6819
7078
|
/**
|
|
6820
7079
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6821
7080
|
* via the `definition` "customers_select".
|
|
@@ -7041,6 +7300,9 @@ interface CartItemsSelect<T extends boolean = true> {
|
|
|
7041
7300
|
variant?: T;
|
|
7042
7301
|
quantity?: T;
|
|
7043
7302
|
unitPrice?: T;
|
|
7303
|
+
discountAllocation?: T;
|
|
7304
|
+
discountedUnitPrice?: T;
|
|
7305
|
+
discountedTotalPrice?: T;
|
|
7044
7306
|
metadata?: T;
|
|
7045
7307
|
updatedAt?: T;
|
|
7046
7308
|
createdAt?: T;
|
|
@@ -7091,22 +7353,6 @@ interface DiscountsSelect<T extends boolean = true> {
|
|
|
7091
7353
|
createdAt?: T;
|
|
7092
7354
|
deletedAt?: T;
|
|
7093
7355
|
}
|
|
7094
|
-
/**
|
|
7095
|
-
* This interface was referenced by `Config`'s JSON-Schema
|
|
7096
|
-
* via the `definition` "promotions_select".
|
|
7097
|
-
*/
|
|
7098
|
-
interface PromotionsSelect<T extends boolean = true> {
|
|
7099
|
-
tenant?: T;
|
|
7100
|
-
code?: T;
|
|
7101
|
-
discountType?: T;
|
|
7102
|
-
discountValue?: T;
|
|
7103
|
-
validFrom?: T;
|
|
7104
|
-
validUntil?: T;
|
|
7105
|
-
status?: T;
|
|
7106
|
-
updatedAt?: T;
|
|
7107
|
-
createdAt?: T;
|
|
7108
|
-
deletedAt?: T;
|
|
7109
|
-
}
|
|
7110
7356
|
/**
|
|
7111
7357
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7112
7358
|
* via the `definition` "articles_select".
|
|
@@ -7302,7 +7548,6 @@ interface PlaylistsSelect<T extends boolean = true> {
|
|
|
7302
7548
|
title?: T;
|
|
7303
7549
|
subtitle?: T;
|
|
7304
7550
|
description?: T;
|
|
7305
|
-
videos?: T;
|
|
7306
7551
|
categories?: T;
|
|
7307
7552
|
tags?: T;
|
|
7308
7553
|
tracks?: T;
|
|
@@ -7318,8 +7563,6 @@ interface PlaylistsSelect<T extends boolean = true> {
|
|
|
7318
7563
|
};
|
|
7319
7564
|
};
|
|
7320
7565
|
thumbnail?: T;
|
|
7321
|
-
coverArt?: T;
|
|
7322
|
-
isCollaborative?: T;
|
|
7323
7566
|
generateSlug?: T;
|
|
7324
7567
|
slug?: T;
|
|
7325
7568
|
status?: T;
|
|
@@ -7375,7 +7618,6 @@ interface TracksSelect<T extends boolean = true> {
|
|
|
7375
7618
|
tenant?: T;
|
|
7376
7619
|
title?: T;
|
|
7377
7620
|
description?: T;
|
|
7378
|
-
content?: T;
|
|
7379
7621
|
artist?: T;
|
|
7380
7622
|
album?: T;
|
|
7381
7623
|
releaseDate?: T;
|
|
@@ -7386,10 +7628,7 @@ interface TracksSelect<T extends boolean = true> {
|
|
|
7386
7628
|
slug?: T;
|
|
7387
7629
|
thumbnail?: T;
|
|
7388
7630
|
status?: T;
|
|
7389
|
-
isFeatured?: T;
|
|
7390
|
-
publishedAt?: T;
|
|
7391
7631
|
durationSeconds?: T;
|
|
7392
|
-
isEmbeddable?: T;
|
|
7393
7632
|
metadata?: T;
|
|
7394
7633
|
sourceUrl?: T;
|
|
7395
7634
|
sourceProvider?: T;
|
|
@@ -8169,6 +8408,8 @@ interface EventsSelect<T extends boolean = true> {
|
|
|
8169
8408
|
registrationPolicy?: T;
|
|
8170
8409
|
waitlistPolicy?: T;
|
|
8171
8410
|
externalRegistrationUrl?: T;
|
|
8411
|
+
occurrences?: T;
|
|
8412
|
+
registrations?: T;
|
|
8172
8413
|
seo?: T | {
|
|
8173
8414
|
title?: T;
|
|
8174
8415
|
description?: T;
|
|
@@ -8239,6 +8480,7 @@ interface EventTagsSelect<T extends boolean = true> {
|
|
|
8239
8480
|
*/
|
|
8240
8481
|
interface EventOccurrencesSelect<T extends boolean = true> {
|
|
8241
8482
|
tenant?: T;
|
|
8483
|
+
displayTitle?: T;
|
|
8242
8484
|
event?: T;
|
|
8243
8485
|
instanceKey?: T;
|
|
8244
8486
|
startsAt?: T;
|
|
@@ -8260,6 +8502,7 @@ interface EventOccurrencesSelect<T extends boolean = true> {
|
|
|
8260
8502
|
opensAt?: T;
|
|
8261
8503
|
closesAt?: T;
|
|
8262
8504
|
};
|
|
8505
|
+
registrations?: T;
|
|
8263
8506
|
cancellation?: T | {
|
|
8264
8507
|
canceledAt?: T;
|
|
8265
8508
|
reason?: T;
|