@01.software/sdk 0.37.0 → 0.38.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 +75 -53
- package/dist/client.cjs +67 -104
- package/dist/client.cjs.map +1 -1
- package/dist/client.d.cts +6 -6
- package/dist/client.d.ts +6 -6
- package/dist/client.js +67 -104
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-zOmnxwdA.d.cts → collection-client-B0J9wMNE.d.cts} +5 -5
- package/dist/{collection-client-DyELGUcL.d.ts → collection-client-BroIWHY1.d.ts} +5 -5
- package/dist/const-6XHz_jej.d.ts +32 -0
- package/dist/const-B5KT72c7.d.cts +32 -0
- package/dist/{index-DRJs7QIh.d.cts → index-BOLQxveo.d.cts} +3 -3
- package/dist/{index-DTqoUZk_.d.ts → index-CSwR2HSg.d.ts} +3 -3
- package/dist/index.cjs +95 -123
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +9 -9
- package/dist/index.d.ts +9 -9
- package/dist/index.js +95 -123
- package/dist/index.js.map +1 -1
- package/dist/{payload-types-CREOjFNT.d.cts → payload-types-m3jjhxk9.d.cts} +418 -106
- package/dist/{payload-types-CREOjFNT.d.ts → payload-types-m3jjhxk9.d.ts} +418 -106
- package/dist/query.cjs +3 -1035
- package/dist/query.cjs.map +1 -1
- package/dist/query.d.cts +13 -13
- package/dist/query.d.ts +13 -13
- package/dist/query.js +3 -1035
- package/dist/query.js.map +1 -1
- package/dist/realtime.d.cts +2 -2
- package/dist/realtime.d.ts +2 -2
- package/dist/server.cjs +42 -21
- package/dist/server.cjs.map +1 -1
- package/dist/server.d.cts +7 -7
- package/dist/server.d.ts +7 -7
- package/dist/server.js +42 -21
- package/dist/server.js.map +1 -1
- package/dist/{types-DMvVHdb1.d.ts → types-CIGscmus.d.cts} +1455 -1208
- package/dist/{types-CxzWHspI.d.ts → types-Cmrd1ezc.d.ts} +1 -15
- package/dist/{types-BkZNhuBh.d.cts → types-D0ubzQw0.d.cts} +1 -15
- package/dist/{types-BWMUr3Zw.d.cts → types-D2xYdz4P.d.ts} +1455 -1208
- package/dist/ui/form.d.cts +1 -1
- package/dist/ui/form.d.ts +1 -1
- package/dist/ui/video.d.cts +1 -1
- package/dist/ui/video.d.ts +1 -1
- package/dist/webhook.d.cts +4 -4
- package/dist/webhook.d.ts +4 -4
- package/package.json +3 -3
- package/dist/const-CK_FPaIn.d.cts +0 -32
- package/dist/const-Dqz05oaG.d.ts +0 -32
|
@@ -37,6 +37,7 @@ interface Config {
|
|
|
37
37
|
'api-usage': ApiUsage;
|
|
38
38
|
products: Product;
|
|
39
39
|
'product-variants': ProductVariant;
|
|
40
|
+
'inventory-adjustments': InventoryAdjustment;
|
|
40
41
|
'product-options': ProductOption;
|
|
41
42
|
'product-option-values': ProductOptionValue;
|
|
42
43
|
'product-categories': ProductCategory;
|
|
@@ -56,6 +57,7 @@ interface Config {
|
|
|
56
57
|
'fulfillment-items': FulfillmentItem;
|
|
57
58
|
returns: Return;
|
|
58
59
|
'return-items': ReturnItem;
|
|
60
|
+
'order-export-profiles': OrderExportProfile;
|
|
59
61
|
'shipping-policies': ShippingPolicy;
|
|
60
62
|
'shipping-zones': ShippingZone;
|
|
61
63
|
customers: Customer;
|
|
@@ -131,6 +133,9 @@ interface Config {
|
|
|
131
133
|
options: 'product-options';
|
|
132
134
|
collectionItems: 'product-collection-items';
|
|
133
135
|
};
|
|
136
|
+
'product-variants': {
|
|
137
|
+
adjustments: 'inventory-adjustments';
|
|
138
|
+
};
|
|
134
139
|
'product-options': {
|
|
135
140
|
values: 'product-option-values';
|
|
136
141
|
};
|
|
@@ -180,6 +185,9 @@ interface Config {
|
|
|
180
185
|
'event-occurrences': {
|
|
181
186
|
registrations: 'event-registrations';
|
|
182
187
|
};
|
|
188
|
+
forms: {
|
|
189
|
+
submissions: 'form-submissions';
|
|
190
|
+
};
|
|
183
191
|
'payload-folders': {
|
|
184
192
|
documentsAndFolders: 'payload-folders' | 'images' | 'system-media';
|
|
185
193
|
};
|
|
@@ -212,6 +220,7 @@ interface Config {
|
|
|
212
220
|
'api-usage': ApiUsageSelect<false> | ApiUsageSelect<true>;
|
|
213
221
|
products: ProductsSelect<false> | ProductsSelect<true>;
|
|
214
222
|
'product-variants': ProductVariantsSelect<false> | ProductVariantsSelect<true>;
|
|
223
|
+
'inventory-adjustments': InventoryAdjustmentsSelect<false> | InventoryAdjustmentsSelect<true>;
|
|
215
224
|
'product-options': ProductOptionsSelect<false> | ProductOptionsSelect<true>;
|
|
216
225
|
'product-option-values': ProductOptionValuesSelect<false> | ProductOptionValuesSelect<true>;
|
|
217
226
|
'product-categories': ProductCategoriesSelect<false> | ProductCategoriesSelect<true>;
|
|
@@ -231,6 +240,7 @@ interface Config {
|
|
|
231
240
|
'fulfillment-items': FulfillmentItemsSelect<false> | FulfillmentItemsSelect<true>;
|
|
232
241
|
returns: ReturnsSelect<false> | ReturnsSelect<true>;
|
|
233
242
|
'return-items': ReturnItemsSelect<false> | ReturnItemsSelect<true>;
|
|
243
|
+
'order-export-profiles': OrderExportProfilesSelect<false> | OrderExportProfilesSelect<true>;
|
|
234
244
|
'shipping-policies': ShippingPoliciesSelect<false> | ShippingPoliciesSelect<true>;
|
|
235
245
|
'shipping-zones': ShippingZonesSelect<false> | ShippingZonesSelect<true>;
|
|
236
246
|
customers: CustomersSelect<false> | CustomersSelect<true>;
|
|
@@ -412,6 +422,8 @@ interface CarouselBlock {
|
|
|
412
422
|
blockType: 'Carousel';
|
|
413
423
|
}
|
|
414
424
|
/**
|
|
425
|
+
* Manage image assets used by content and products.
|
|
426
|
+
*
|
|
415
427
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
416
428
|
* via the `definition` "images".
|
|
417
429
|
*/
|
|
@@ -495,6 +507,8 @@ interface Image {
|
|
|
495
507
|
};
|
|
496
508
|
}
|
|
497
509
|
/**
|
|
510
|
+
* Manage workspace identity and ownership.
|
|
511
|
+
*
|
|
498
512
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
499
513
|
* via the `definition` "tenants".
|
|
500
514
|
*/
|
|
@@ -593,6 +607,8 @@ interface Tenant {
|
|
|
593
607
|
deletedAt?: string | null;
|
|
594
608
|
}
|
|
595
609
|
/**
|
|
610
|
+
* Manage Admin Panel users and permission details.
|
|
611
|
+
*
|
|
596
612
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
597
613
|
* via the `definition` "users".
|
|
598
614
|
*/
|
|
@@ -685,6 +701,8 @@ interface FolderInterface {
|
|
|
685
701
|
createdAt: string;
|
|
686
702
|
}
|
|
687
703
|
/**
|
|
704
|
+
* Manage system media shared across the platform.
|
|
705
|
+
*
|
|
688
706
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
689
707
|
* via the `definition` "system-media".
|
|
690
708
|
*/
|
|
@@ -734,6 +752,8 @@ interface FieldConfig {
|
|
|
734
752
|
deletedAt?: string | null;
|
|
735
753
|
}
|
|
736
754
|
/**
|
|
755
|
+
* Manage audiences for newsletters and announcements.
|
|
756
|
+
*
|
|
737
757
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
738
758
|
* via the `definition` "audiences".
|
|
739
759
|
*/
|
|
@@ -756,6 +776,8 @@ interface Audience {
|
|
|
756
776
|
deletedAt?: string | null;
|
|
757
777
|
}
|
|
758
778
|
/**
|
|
779
|
+
* Review transactional email delivery records.
|
|
780
|
+
*
|
|
759
781
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
760
782
|
* via the `definition` "email-logs".
|
|
761
783
|
*/
|
|
@@ -848,6 +870,8 @@ interface CommerceNotificationIntent {
|
|
|
848
870
|
createdAt: string;
|
|
849
871
|
}
|
|
850
872
|
/**
|
|
873
|
+
* Review and process payment, fulfillment, and confirmation status.
|
|
874
|
+
*
|
|
851
875
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
852
876
|
* via the `definition` "orders".
|
|
853
877
|
*/
|
|
@@ -855,14 +879,26 @@ interface Order {
|
|
|
855
879
|
id: string;
|
|
856
880
|
tenant?: (string | null) | Tenant;
|
|
857
881
|
orderNumber: string;
|
|
882
|
+
/**
|
|
883
|
+
* Payment status used for order lists and filters.
|
|
884
|
+
*/
|
|
885
|
+
displayFinancialStatus: 'pending' | 'paid' | 'partially_refunded' | 'refunded' | 'voided';
|
|
886
|
+
/**
|
|
887
|
+
* Fulfillment status used for order lists and filters.
|
|
888
|
+
*/
|
|
889
|
+
displayFulfillmentStatus: 'unfulfilled' | 'in_progress' | 'on_hold' | 'shipped' | 'fulfilled' | 'canceled';
|
|
890
|
+
/**
|
|
891
|
+
* Return status used for order lists and filters. Orders without active returns read as no_return.
|
|
892
|
+
*/
|
|
893
|
+
returnStatus: 'no_return' | 'return_requested' | 'in_progress' | 'returned';
|
|
858
894
|
/**
|
|
859
895
|
* Display status derived from payment, fulfillment order, shipment, and return state.
|
|
860
896
|
*/
|
|
861
|
-
displayStatus?: ('pending' | 'paid' | '
|
|
897
|
+
displayStatus?: ('pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned') | null;
|
|
862
898
|
/**
|
|
863
899
|
* Primary order lifecycle display status excluding the return axis.
|
|
864
900
|
*/
|
|
865
|
-
primaryDisplayStatus?: ('pending' | 'paid' | '
|
|
901
|
+
primaryDisplayStatus?: ('pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed') | null;
|
|
866
902
|
/**
|
|
867
903
|
* Return display status derived only when a return is active.
|
|
868
904
|
*/
|
|
@@ -870,7 +906,7 @@ interface Order {
|
|
|
870
906
|
/**
|
|
871
907
|
* Deprecated: compatibility alias for displayStatus.
|
|
872
908
|
*/
|
|
873
|
-
status: 'pending' | 'paid' | '
|
|
909
|
+
status: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
874
910
|
customer?: (string | null) | Customer;
|
|
875
911
|
/**
|
|
876
912
|
* Customer info at the time of order
|
|
@@ -917,7 +953,7 @@ interface Order {
|
|
|
917
953
|
hasNextPage?: boolean;
|
|
918
954
|
totalDocs?: number;
|
|
919
955
|
};
|
|
920
|
-
financialStatus: 'pending' | 'paid' | '
|
|
956
|
+
financialStatus: 'pending' | 'paid' | 'canceled' | 'partially_refunded' | 'refunded';
|
|
921
957
|
/**
|
|
922
958
|
* Item subtotal (excl. shipping & discount)
|
|
923
959
|
*/
|
|
@@ -970,6 +1006,8 @@ interface Order {
|
|
|
970
1006
|
deletedAt?: string | null;
|
|
971
1007
|
}
|
|
972
1008
|
/**
|
|
1009
|
+
* Review customer accounts, purchases, and activity.
|
|
1010
|
+
*
|
|
973
1011
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
974
1012
|
* via the `definition` "customers".
|
|
975
1013
|
*/
|
|
@@ -1118,6 +1156,8 @@ interface Customer {
|
|
|
1118
1156
|
collection: 'customers';
|
|
1119
1157
|
}
|
|
1120
1158
|
/**
|
|
1159
|
+
* Manage customer groups for coupons, targeting, and badges.
|
|
1160
|
+
*
|
|
1121
1161
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1122
1162
|
* via the `definition` "customer-groups".
|
|
1123
1163
|
*/
|
|
@@ -1325,6 +1365,8 @@ interface OrderItem {
|
|
|
1325
1365
|
deletedAt?: string | null;
|
|
1326
1366
|
}
|
|
1327
1367
|
/**
|
|
1368
|
+
* Manage sellable item information and publishing status.
|
|
1369
|
+
*
|
|
1328
1370
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1329
1371
|
* via the `definition` "products".
|
|
1330
1372
|
*/
|
|
@@ -1521,6 +1563,8 @@ interface Product {
|
|
|
1521
1563
|
deletedAt?: string | null;
|
|
1522
1564
|
}
|
|
1523
1565
|
/**
|
|
1566
|
+
* Manage video content, processing, and publishing status.
|
|
1567
|
+
*
|
|
1524
1568
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1525
1569
|
* via the `definition` "videos".
|
|
1526
1570
|
*/
|
|
@@ -1628,6 +1672,8 @@ interface Video {
|
|
|
1628
1672
|
deletedAt?: string | null;
|
|
1629
1673
|
}
|
|
1630
1674
|
/**
|
|
1675
|
+
* Manage live stream schedules and stream status.
|
|
1676
|
+
*
|
|
1631
1677
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1632
1678
|
* via the `definition` "live-streams".
|
|
1633
1679
|
*/
|
|
@@ -1821,10 +1867,26 @@ interface ProductVariant {
|
|
|
1821
1867
|
* Available quantity is stock minus reserved stock.
|
|
1822
1868
|
*/
|
|
1823
1869
|
stock?: number | null;
|
|
1870
|
+
/**
|
|
1871
|
+
* Required when manually changing tracked stock. Recorded in the inventory adjustment history.
|
|
1872
|
+
*/
|
|
1873
|
+
stockAdjustmentReason?: ('received' | 'correction' | 'damage' | 'loss' | 'cycle_count' | 'other') | null;
|
|
1874
|
+
/**
|
|
1875
|
+
* Optional note stored with the inventory adjustment history row.
|
|
1876
|
+
*/
|
|
1877
|
+
stockAdjustmentNote?: string | null;
|
|
1824
1878
|
/**
|
|
1825
1879
|
* Reserved stock increased automatically during order processing.
|
|
1826
1880
|
*/
|
|
1827
1881
|
reservedStock?: number | null;
|
|
1882
|
+
/**
|
|
1883
|
+
* Inventory adjustment history for this variant, covering manual corrections and order/return server flows.
|
|
1884
|
+
*/
|
|
1885
|
+
adjustments?: {
|
|
1886
|
+
docs?: (string | InventoryAdjustment)[];
|
|
1887
|
+
hasNextPage?: boolean;
|
|
1888
|
+
totalDocs?: number;
|
|
1889
|
+
};
|
|
1828
1890
|
/**
|
|
1829
1891
|
* Minimum quantity before low-stock alerts.
|
|
1830
1892
|
*/
|
|
@@ -1865,6 +1927,144 @@ interface ProductVariant {
|
|
|
1865
1927
|
createdAt: string;
|
|
1866
1928
|
deletedAt?: string | null;
|
|
1867
1929
|
}
|
|
1930
|
+
/**
|
|
1931
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1932
|
+
* via the `definition` "inventory-adjustments".
|
|
1933
|
+
*/
|
|
1934
|
+
interface InventoryAdjustment {
|
|
1935
|
+
id: string;
|
|
1936
|
+
tenant?: (string | null) | Tenant;
|
|
1937
|
+
variant?: (string | null) | ProductVariant;
|
|
1938
|
+
product?: (string | null) | Product;
|
|
1939
|
+
/**
|
|
1940
|
+
* SKU snapshot at adjustment time.
|
|
1941
|
+
*/
|
|
1942
|
+
sku?: string | null;
|
|
1943
|
+
/**
|
|
1944
|
+
* Variant title snapshot at adjustment time.
|
|
1945
|
+
*/
|
|
1946
|
+
variantTitle?: string | null;
|
|
1947
|
+
/**
|
|
1948
|
+
* Path that produced the adjustment. Distinguishes manual corrections from order/return server flows.
|
|
1949
|
+
*/
|
|
1950
|
+
source: 'manual' | 'composer' | 'import' | 'order' | 'return' | 'reconcile' | 'system';
|
|
1951
|
+
/**
|
|
1952
|
+
* Adjustment reason. Manual rows carry the operator-selected reason; server flows stamp a system reason.
|
|
1953
|
+
*/
|
|
1954
|
+
reason: 'received' | 'correction' | 'damage' | 'loss' | 'cycle_count' | 'other' | 'order_reserve' | 'order_release' | 'order_delivered' | 'return_restock' | 'drift_repair' | 'import';
|
|
1955
|
+
stockDelta: number;
|
|
1956
|
+
reservedStockDelta: number;
|
|
1957
|
+
stockBefore: number;
|
|
1958
|
+
stockAfter: number;
|
|
1959
|
+
reservedStockBefore: number;
|
|
1960
|
+
reservedStockAfter: number;
|
|
1961
|
+
availableBefore: number;
|
|
1962
|
+
availableAfter: number;
|
|
1963
|
+
/**
|
|
1964
|
+
* 'user:{id}' | 'customer:{id}' | 'system'
|
|
1965
|
+
*/
|
|
1966
|
+
actor: string;
|
|
1967
|
+
note?: string | null;
|
|
1968
|
+
order?: (string | null) | Order;
|
|
1969
|
+
return?: (string | null) | Return;
|
|
1970
|
+
metadata?: {
|
|
1971
|
+
[k: string]: unknown;
|
|
1972
|
+
} | unknown[] | string | number | boolean | null;
|
|
1973
|
+
updatedAt: string;
|
|
1974
|
+
createdAt: string;
|
|
1975
|
+
}
|
|
1976
|
+
/**
|
|
1977
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
1978
|
+
* via the `definition` "returns".
|
|
1979
|
+
*/
|
|
1980
|
+
interface Return {
|
|
1981
|
+
id: string;
|
|
1982
|
+
tenant?: (string | null) | Tenant;
|
|
1983
|
+
returnNumber?: string | null;
|
|
1984
|
+
order: string | Order;
|
|
1985
|
+
type: 'refund' | 'exchange';
|
|
1986
|
+
/**
|
|
1987
|
+
* New order created for exchange
|
|
1988
|
+
*/
|
|
1989
|
+
exchangeOrder?: (string | null) | Order;
|
|
1990
|
+
status: 'requested' | 'processing' | 'approved' | 'rejected' | 'completed';
|
|
1991
|
+
/**
|
|
1992
|
+
* Reason category for the return or refund request. Used for reporting and operations.
|
|
1993
|
+
*/
|
|
1994
|
+
reason?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other') | null;
|
|
1995
|
+
/**
|
|
1996
|
+
* Detailed return reason
|
|
1997
|
+
*/
|
|
1998
|
+
reasonDetail?: string | null;
|
|
1999
|
+
items?: {
|
|
2000
|
+
docs?: (string | ReturnItem)[];
|
|
2001
|
+
hasNextPage?: boolean;
|
|
2002
|
+
totalDocs?: number;
|
|
2003
|
+
};
|
|
2004
|
+
/**
|
|
2005
|
+
* Internal return-processing note. Not shown directly to customers.
|
|
2006
|
+
*/
|
|
2007
|
+
adminNotes?: string | null;
|
|
2008
|
+
completedAt?: string | null;
|
|
2009
|
+
/**
|
|
2010
|
+
* Refund receipt URL
|
|
2011
|
+
*/
|
|
2012
|
+
refundReceiptUrl?: string | null;
|
|
2013
|
+
refundAmount: number;
|
|
2014
|
+
/**
|
|
2015
|
+
* Return shipping fee deducted from refundAmount
|
|
2016
|
+
*/
|
|
2017
|
+
returnShippingFee?: number | null;
|
|
2018
|
+
/**
|
|
2019
|
+
* Initial order shipping amount refunded
|
|
2020
|
+
*/
|
|
2021
|
+
initialShippingRefundAmount?: number | null;
|
|
2022
|
+
initialShippingRefundSuggestedAmount?: number | null;
|
|
2023
|
+
/**
|
|
2024
|
+
* Audit note for overriding the initial shipping refund suggestion
|
|
2025
|
+
*/
|
|
2026
|
+
initialShippingRefundOverrideNote?: string | null;
|
|
2027
|
+
initialShippingRefundPolicySnapshot?: {
|
|
2028
|
+
[k: string]: unknown;
|
|
2029
|
+
} | unknown[] | string | number | boolean | null;
|
|
2030
|
+
/**
|
|
2031
|
+
* Exchange balance (positive: extra charge, negative: extra refund)
|
|
2032
|
+
*/
|
|
2033
|
+
exchangeDifference?: number | null;
|
|
2034
|
+
metadata?: {
|
|
2035
|
+
[k: string]: unknown;
|
|
2036
|
+
} | unknown[] | string | number | boolean | null;
|
|
2037
|
+
updatedAt: string;
|
|
2038
|
+
createdAt: string;
|
|
2039
|
+
deletedAt?: string | null;
|
|
2040
|
+
}
|
|
2041
|
+
/**
|
|
2042
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
2043
|
+
* via the `definition` "return-items".
|
|
2044
|
+
*/
|
|
2045
|
+
interface ReturnItem {
|
|
2046
|
+
id: string;
|
|
2047
|
+
tenant?: (string | null) | Tenant;
|
|
2048
|
+
return: string | Return;
|
|
2049
|
+
order: string | Order;
|
|
2050
|
+
status: 'requested' | 'processing' | 'approved' | 'rejected' | 'completed';
|
|
2051
|
+
orderItem: string | OrderItem;
|
|
2052
|
+
product: string | Product;
|
|
2053
|
+
variant?: (string | null) | ProductVariant;
|
|
2054
|
+
/**
|
|
2055
|
+
* Quantity fixed when the return item is created. It cannot be edited after create to protect refund/restock calculations.
|
|
2056
|
+
*/
|
|
2057
|
+
quantity: number;
|
|
2058
|
+
restockAction: 'return_to_stock' | 'discard';
|
|
2059
|
+
/**
|
|
2060
|
+
* Restocking fee for this line (deducted from line refund)
|
|
2061
|
+
*/
|
|
2062
|
+
restockingFee?: number | null;
|
|
2063
|
+
productTitle?: string | null;
|
|
2064
|
+
updatedAt: string;
|
|
2065
|
+
createdAt: string;
|
|
2066
|
+
deletedAt?: string | null;
|
|
2067
|
+
}
|
|
1868
2068
|
/**
|
|
1869
2069
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1870
2070
|
* via the `definition` "product-option-values".
|
|
@@ -2018,6 +2218,8 @@ interface ProductTag {
|
|
|
2018
2218
|
deletedAt?: string | null;
|
|
2019
2219
|
}
|
|
2020
2220
|
/**
|
|
2221
|
+
* Manage brand details and logos linked to products.
|
|
2222
|
+
*
|
|
2021
2223
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2022
2224
|
* via the `definition` "brands".
|
|
2023
2225
|
*/
|
|
@@ -2204,6 +2406,8 @@ interface BrandLogo {
|
|
|
2204
2406
|
};
|
|
2205
2407
|
}
|
|
2206
2408
|
/**
|
|
2409
|
+
* Manage shipping fee rules and default shipping policies.
|
|
2410
|
+
*
|
|
2207
2411
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2208
2412
|
* via the `definition` "shipping-policies".
|
|
2209
2413
|
*/
|
|
@@ -2275,7 +2479,7 @@ interface ProductCollectionItem {
|
|
|
2275
2479
|
createdAt: string;
|
|
2276
2480
|
}
|
|
2277
2481
|
/**
|
|
2278
|
-
*
|
|
2482
|
+
* Manage curated groupings for campaigns, recommendations, and merchandising.
|
|
2279
2483
|
*
|
|
2280
2484
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2281
2485
|
* via the `definition` "product-collections".
|
|
@@ -2531,98 +2735,6 @@ interface Transaction {
|
|
|
2531
2735
|
createdAt: string;
|
|
2532
2736
|
deletedAt?: string | null;
|
|
2533
2737
|
}
|
|
2534
|
-
/**
|
|
2535
|
-
* This interface was referenced by `Config`'s JSON-Schema
|
|
2536
|
-
* via the `definition` "returns".
|
|
2537
|
-
*/
|
|
2538
|
-
interface Return {
|
|
2539
|
-
id: string;
|
|
2540
|
-
tenant?: (string | null) | Tenant;
|
|
2541
|
-
returnNumber?: string | null;
|
|
2542
|
-
order: string | Order;
|
|
2543
|
-
type: 'refund' | 'exchange';
|
|
2544
|
-
/**
|
|
2545
|
-
* New order created for exchange
|
|
2546
|
-
*/
|
|
2547
|
-
exchangeOrder?: (string | null) | Order;
|
|
2548
|
-
status: 'requested' | 'processing' | 'approved' | 'rejected' | 'completed';
|
|
2549
|
-
/**
|
|
2550
|
-
* Reason category for the return or refund request. Used for reporting and operations.
|
|
2551
|
-
*/
|
|
2552
|
-
reason?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other') | null;
|
|
2553
|
-
/**
|
|
2554
|
-
* Detailed return reason
|
|
2555
|
-
*/
|
|
2556
|
-
reasonDetail?: string | null;
|
|
2557
|
-
items?: {
|
|
2558
|
-
docs?: (string | ReturnItem)[];
|
|
2559
|
-
hasNextPage?: boolean;
|
|
2560
|
-
totalDocs?: number;
|
|
2561
|
-
};
|
|
2562
|
-
/**
|
|
2563
|
-
* Internal return-processing note. Not shown directly to customers.
|
|
2564
|
-
*/
|
|
2565
|
-
adminNotes?: string | null;
|
|
2566
|
-
completedAt?: string | null;
|
|
2567
|
-
/**
|
|
2568
|
-
* Refund receipt URL
|
|
2569
|
-
*/
|
|
2570
|
-
refundReceiptUrl?: string | null;
|
|
2571
|
-
refundAmount: number;
|
|
2572
|
-
/**
|
|
2573
|
-
* Return shipping fee deducted from refundAmount
|
|
2574
|
-
*/
|
|
2575
|
-
returnShippingFee?: number | null;
|
|
2576
|
-
/**
|
|
2577
|
-
* Initial order shipping amount refunded
|
|
2578
|
-
*/
|
|
2579
|
-
initialShippingRefundAmount?: number | null;
|
|
2580
|
-
initialShippingRefundSuggestedAmount?: number | null;
|
|
2581
|
-
/**
|
|
2582
|
-
* Audit note for overriding the initial shipping refund suggestion
|
|
2583
|
-
*/
|
|
2584
|
-
initialShippingRefundOverrideNote?: string | null;
|
|
2585
|
-
initialShippingRefundPolicySnapshot?: {
|
|
2586
|
-
[k: string]: unknown;
|
|
2587
|
-
} | unknown[] | string | number | boolean | null;
|
|
2588
|
-
/**
|
|
2589
|
-
* Exchange balance (positive: extra charge, negative: extra refund)
|
|
2590
|
-
*/
|
|
2591
|
-
exchangeDifference?: number | null;
|
|
2592
|
-
metadata?: {
|
|
2593
|
-
[k: string]: unknown;
|
|
2594
|
-
} | unknown[] | string | number | boolean | null;
|
|
2595
|
-
updatedAt: string;
|
|
2596
|
-
createdAt: string;
|
|
2597
|
-
deletedAt?: string | null;
|
|
2598
|
-
}
|
|
2599
|
-
/**
|
|
2600
|
-
* This interface was referenced by `Config`'s JSON-Schema
|
|
2601
|
-
* via the `definition` "return-items".
|
|
2602
|
-
*/
|
|
2603
|
-
interface ReturnItem {
|
|
2604
|
-
id: string;
|
|
2605
|
-
tenant?: (string | null) | Tenant;
|
|
2606
|
-
return: string | Return;
|
|
2607
|
-
order: string | Order;
|
|
2608
|
-
status: 'requested' | 'processing' | 'approved' | 'rejected' | 'completed';
|
|
2609
|
-
orderItem: string | OrderItem;
|
|
2610
|
-
product: string | Product;
|
|
2611
|
-
variant?: (string | null) | ProductVariant;
|
|
2612
|
-
/**
|
|
2613
|
-
* Quantity fixed when the return item is created. It cannot be edited after create to protect refund/restock calculations.
|
|
2614
|
-
*/
|
|
2615
|
-
quantity: number;
|
|
2616
|
-
restockAction: 'return_to_stock' | 'discard';
|
|
2617
|
-
/**
|
|
2618
|
-
* Restocking fee for this line (deducted from line refund)
|
|
2619
|
-
*/
|
|
2620
|
-
restockingFee?: number | null;
|
|
2621
|
-
productTitle?: string | null;
|
|
2622
|
-
updatedAt: string;
|
|
2623
|
-
createdAt: string;
|
|
2624
|
-
deletedAt?: string | null;
|
|
2625
|
-
}
|
|
2626
2738
|
/**
|
|
2627
2739
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2628
2740
|
* via the `definition` "api-keys".
|
|
@@ -2837,6 +2949,8 @@ interface WebhookDelivery {
|
|
|
2837
2949
|
createdAt: string;
|
|
2838
2950
|
}
|
|
2839
2951
|
/**
|
|
2952
|
+
* Configure event subscriptions and endpoints for external systems.
|
|
2953
|
+
*
|
|
2840
2954
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2841
2955
|
* via the `definition` "webhooks".
|
|
2842
2956
|
*/
|
|
@@ -3217,6 +3331,8 @@ interface TenantEntitlement {
|
|
|
3217
3331
|
deletedAt?: string | null;
|
|
3218
3332
|
}
|
|
3219
3333
|
/**
|
|
3334
|
+
* Review workspace subscription status and applied plans.
|
|
3335
|
+
*
|
|
3220
3336
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3221
3337
|
* via the `definition` "subscriptions".
|
|
3222
3338
|
*/
|
|
@@ -3294,6 +3410,8 @@ interface TenantPurgeJob {
|
|
|
3294
3410
|
createdAt: string;
|
|
3295
3411
|
}
|
|
3296
3412
|
/**
|
|
3413
|
+
* Review billing charges and receipt records.
|
|
3414
|
+
*
|
|
3297
3415
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3298
3416
|
* via the `definition` "billing-history".
|
|
3299
3417
|
*/
|
|
@@ -3301,7 +3419,7 @@ interface BillingHistory {
|
|
|
3301
3419
|
id: string;
|
|
3302
3420
|
tenant: string | Tenant;
|
|
3303
3421
|
subscription?: (string | null) | Subscription;
|
|
3304
|
-
type: 'payment' | 'refund' | 'plan_change';
|
|
3422
|
+
type: 'payment' | 'refund' | 'plan_change' | 'billing_key_update';
|
|
3305
3423
|
status: 'success' | 'failed' | 'refunded' | 'partial_refund';
|
|
3306
3424
|
/**
|
|
3307
3425
|
* Amount (KRW)
|
|
@@ -3369,6 +3487,8 @@ interface Plan {
|
|
|
3369
3487
|
deletedAt?: string | null;
|
|
3370
3488
|
}
|
|
3371
3489
|
/**
|
|
3490
|
+
* Manage web analytics collection settings and allowed domains.
|
|
3491
|
+
*
|
|
3372
3492
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3373
3493
|
* via the `definition` "tenant-web-analytics-config".
|
|
3374
3494
|
*/
|
|
@@ -3511,6 +3631,8 @@ interface TenantAnalyticsDaily {
|
|
|
3511
3631
|
createdAt: string;
|
|
3512
3632
|
}
|
|
3513
3633
|
/**
|
|
3634
|
+
* Manage custom events and property schemas for analytics.
|
|
3635
|
+
*
|
|
3514
3636
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3515
3637
|
* via the `definition` "analytics-event-schemas".
|
|
3516
3638
|
*/
|
|
@@ -3539,6 +3661,8 @@ interface AnalyticsEventSchema {
|
|
|
3539
3661
|
deletedAt?: string | null;
|
|
3540
3662
|
}
|
|
3541
3663
|
/**
|
|
3664
|
+
* Review API, document, and media usage by workspace.
|
|
3665
|
+
*
|
|
3542
3666
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3543
3667
|
* via the `definition` "api-usage".
|
|
3544
3668
|
*/
|
|
@@ -3601,11 +3725,11 @@ interface OrderStatusLog {
|
|
|
3601
3725
|
/**
|
|
3602
3726
|
* Previous deprecated orders.status/displayStatus alias value.
|
|
3603
3727
|
*/
|
|
3604
|
-
fromStatus: 'pending' | 'paid' | '
|
|
3728
|
+
fromStatus: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3605
3729
|
/**
|
|
3606
3730
|
* Next deprecated orders.status/displayStatus alias value.
|
|
3607
3731
|
*/
|
|
3608
|
-
toStatus: 'pending' | 'paid' | '
|
|
3732
|
+
toStatus: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3609
3733
|
/**
|
|
3610
3734
|
* 'user:{id}' | 'api:updateOrder' | 'system:transaction:{paymentId}' | 'system:fulfillment:{id}' | 'system:return:{id}'
|
|
3611
3735
|
*/
|
|
@@ -3631,16 +3755,66 @@ interface InventoryReservation {
|
|
|
3631
3755
|
/**
|
|
3632
3756
|
* Reservation lifecycle status. Payment, cancellation, and delivery server paths transition it through held, released, and consumed.
|
|
3633
3757
|
*/
|
|
3634
|
-
status: 'held' | 'released' | 'consumed';
|
|
3758
|
+
status: 'pending' | 'held' | 'released' | 'consumed';
|
|
3635
3759
|
/**
|
|
3636
3760
|
* Timestamp of the latest reservation status change made by a server path.
|
|
3637
3761
|
*/
|
|
3638
3762
|
statusChangedAt?: string | null;
|
|
3763
|
+
/**
|
|
3764
|
+
* When a pending pre-payment hold expires and is auto-released. Empty for held/released/consumed rows.
|
|
3765
|
+
*/
|
|
3766
|
+
expiresAt?: string | null;
|
|
3767
|
+
updatedAt: string;
|
|
3768
|
+
createdAt: string;
|
|
3769
|
+
deletedAt?: string | null;
|
|
3770
|
+
}
|
|
3771
|
+
/**
|
|
3772
|
+
* Configure order export formats for shipping carriers.
|
|
3773
|
+
*
|
|
3774
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
3775
|
+
* via the `definition` "order-export-profiles".
|
|
3776
|
+
*/
|
|
3777
|
+
interface OrderExportProfile {
|
|
3778
|
+
id: string;
|
|
3779
|
+
tenant?: (string | null) | Tenant;
|
|
3780
|
+
/**
|
|
3781
|
+
* e.g. Hanjin standard, Internal WMS
|
|
3782
|
+
*/
|
|
3783
|
+
title?: string | null;
|
|
3784
|
+
/**
|
|
3785
|
+
* Output file format
|
|
3786
|
+
*/
|
|
3787
|
+
fileType: 'csv' | 'xlsx';
|
|
3788
|
+
/**
|
|
3789
|
+
* Insert a blank row before the header (some carrier templates)
|
|
3790
|
+
*/
|
|
3791
|
+
leadingBlankRow?: boolean | null;
|
|
3792
|
+
/**
|
|
3793
|
+
* Export column layout (header, source field, transforms)
|
|
3794
|
+
*/
|
|
3795
|
+
columns: {
|
|
3796
|
+
[k: string]: unknown;
|
|
3797
|
+
} | unknown[] | string | number | boolean | null;
|
|
3798
|
+
/**
|
|
3799
|
+
* Short summary for listing/cards
|
|
3800
|
+
*/
|
|
3801
|
+
description?: string | null;
|
|
3802
|
+
/**
|
|
3803
|
+
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
3804
|
+
*/
|
|
3805
|
+
generateSlug?: boolean | null;
|
|
3806
|
+
slug?: string | null;
|
|
3807
|
+
isActive?: boolean | null;
|
|
3808
|
+
metadata?: {
|
|
3809
|
+
[k: string]: unknown;
|
|
3810
|
+
} | unknown[] | string | number | boolean | null;
|
|
3639
3811
|
updatedAt: string;
|
|
3640
3812
|
createdAt: string;
|
|
3641
3813
|
deletedAt?: string | null;
|
|
3642
3814
|
}
|
|
3643
3815
|
/**
|
|
3816
|
+
* Manage shippable regions and regional constraints.
|
|
3817
|
+
*
|
|
3644
3818
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3645
3819
|
* via the `definition` "shipping-zones".
|
|
3646
3820
|
*/
|
|
@@ -3676,6 +3850,8 @@ interface ShippingZone {
|
|
|
3676
3850
|
deletedAt?: string | null;
|
|
3677
3851
|
}
|
|
3678
3852
|
/**
|
|
3853
|
+
* Curate featured community profiles and public profile lists.
|
|
3854
|
+
*
|
|
3679
3855
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3680
3856
|
* via the `definition` "customer-profile-lists".
|
|
3681
3857
|
*/
|
|
@@ -3805,6 +3981,8 @@ interface CartItem {
|
|
|
3805
3981
|
createdAt: string;
|
|
3806
3982
|
}
|
|
3807
3983
|
/**
|
|
3984
|
+
* Manage discount codes, eligibility rules, and usage limits.
|
|
3985
|
+
*
|
|
3808
3986
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3809
3987
|
* via the `definition` "discounts".
|
|
3810
3988
|
*/
|
|
@@ -3899,6 +4077,8 @@ interface Discount {
|
|
|
3899
4077
|
deletedAt?: string | null;
|
|
3900
4078
|
}
|
|
3901
4079
|
/**
|
|
4080
|
+
* Manage publishable articles, authors, and classification.
|
|
4081
|
+
*
|
|
3902
4082
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3903
4083
|
* via the `definition` "articles".
|
|
3904
4084
|
*/
|
|
@@ -4005,6 +4185,8 @@ interface Article {
|
|
|
4005
4185
|
deletedAt?: string | null;
|
|
4006
4186
|
}
|
|
4007
4187
|
/**
|
|
4188
|
+
* Manage article author profiles and display details.
|
|
4189
|
+
*
|
|
4008
4190
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4009
4191
|
* via the `definition` "article-authors".
|
|
4010
4192
|
*/
|
|
@@ -4102,6 +4284,8 @@ interface ArticleTag {
|
|
|
4102
4284
|
deletedAt?: string | null;
|
|
4103
4285
|
}
|
|
4104
4286
|
/**
|
|
4287
|
+
* Manage document-based content and publishing status.
|
|
4288
|
+
*
|
|
4105
4289
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4106
4290
|
* via the `definition` "documents".
|
|
4107
4291
|
*/
|
|
@@ -4259,6 +4443,8 @@ interface DocumentCategory {
|
|
|
4259
4443
|
deletedAt?: string | null;
|
|
4260
4444
|
}
|
|
4261
4445
|
/**
|
|
4446
|
+
* Manage document types used for classification.
|
|
4447
|
+
*
|
|
4262
4448
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4263
4449
|
* via the `definition` "document-types".
|
|
4264
4450
|
*/
|
|
@@ -4289,6 +4475,8 @@ interface DocumentType {
|
|
|
4289
4475
|
deletedAt?: string | null;
|
|
4290
4476
|
}
|
|
4291
4477
|
/**
|
|
4478
|
+
* Manage audio track groupings and publishing status.
|
|
4479
|
+
*
|
|
4292
4480
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4293
4481
|
* via the `definition` "playlists".
|
|
4294
4482
|
*/
|
|
@@ -4424,6 +4612,8 @@ interface PlaylistTag {
|
|
|
4424
4612
|
deletedAt?: string | null;
|
|
4425
4613
|
}
|
|
4426
4614
|
/**
|
|
4615
|
+
* Manage audio tracks and metadata used in playlists.
|
|
4616
|
+
*
|
|
4427
4617
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4428
4618
|
* via the `definition` "tracks".
|
|
4429
4619
|
*/
|
|
@@ -4562,6 +4752,8 @@ interface TrackAsset {
|
|
|
4562
4752
|
focalY?: number | null;
|
|
4563
4753
|
}
|
|
4564
4754
|
/**
|
|
4755
|
+
* Manage image galleries and display order.
|
|
4756
|
+
*
|
|
4565
4757
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4566
4758
|
* via the `definition` "galleries".
|
|
4567
4759
|
*/
|
|
@@ -4742,6 +4934,8 @@ interface GalleryItem {
|
|
|
4742
4934
|
deletedAt?: string | null;
|
|
4743
4935
|
}
|
|
4744
4936
|
/**
|
|
4937
|
+
* Manage external links and related metadata.
|
|
4938
|
+
*
|
|
4745
4939
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4746
4940
|
* via the `definition` "links".
|
|
4747
4941
|
*/
|
|
@@ -4859,6 +5053,8 @@ interface LinkTag {
|
|
|
4859
5053
|
deletedAt?: string | null;
|
|
4860
5054
|
}
|
|
4861
5055
|
/**
|
|
5056
|
+
* Manage visual canvases and publishing status.
|
|
5057
|
+
*
|
|
4862
5058
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4863
5059
|
* via the `definition` "canvases".
|
|
4864
5060
|
*/
|
|
@@ -4996,6 +5192,8 @@ interface CanvasTag {
|
|
|
4996
5192
|
deletedAt?: string | null;
|
|
4997
5193
|
}
|
|
4998
5194
|
/**
|
|
5195
|
+
* Configure node types available in canvases.
|
|
5196
|
+
*
|
|
4999
5197
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5000
5198
|
* via the `definition` "canvas-node-types".
|
|
5001
5199
|
*/
|
|
@@ -5065,6 +5263,8 @@ interface CanvasNodeType {
|
|
|
5065
5263
|
deletedAt?: string | null;
|
|
5066
5264
|
}
|
|
5067
5265
|
/**
|
|
5266
|
+
* Configure edge types available in canvases.
|
|
5267
|
+
*
|
|
5068
5268
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5069
5269
|
* via the `definition` "canvas-edge-types".
|
|
5070
5270
|
*/
|
|
@@ -5174,6 +5374,8 @@ interface CanvasEdge {
|
|
|
5174
5374
|
deletedAt?: string | null;
|
|
5175
5375
|
}
|
|
5176
5376
|
/**
|
|
5377
|
+
* Manage community posts, visibility, and review status.
|
|
5378
|
+
*
|
|
5177
5379
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5178
5380
|
* via the `definition` "posts".
|
|
5179
5381
|
*/
|
|
@@ -5401,6 +5603,8 @@ interface Reaction {
|
|
|
5401
5603
|
createdAt: string;
|
|
5402
5604
|
}
|
|
5403
5605
|
/**
|
|
5606
|
+
* Configure reaction types available in community interactions.
|
|
5607
|
+
*
|
|
5404
5608
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5405
5609
|
* via the `definition` "reaction-types".
|
|
5406
5610
|
*/
|
|
@@ -5495,6 +5699,8 @@ interface CommunityBan {
|
|
|
5495
5699
|
createdAt: string;
|
|
5496
5700
|
}
|
|
5497
5701
|
/**
|
|
5702
|
+
* Manage event calendar display settings and defaults.
|
|
5703
|
+
*
|
|
5498
5704
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5499
5705
|
* via the `definition` "event-calendars".
|
|
5500
5706
|
*/
|
|
@@ -5598,6 +5804,8 @@ interface EventCalendar {
|
|
|
5598
5804
|
deletedAt?: string | null;
|
|
5599
5805
|
}
|
|
5600
5806
|
/**
|
|
5807
|
+
* Manage events with schedules, locations, and recurrence rules.
|
|
5808
|
+
*
|
|
5601
5809
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5602
5810
|
* via the `definition` "events".
|
|
5603
5811
|
*/
|
|
@@ -5644,11 +5852,11 @@ interface Event {
|
|
|
5644
5852
|
user?: (string | null) | User;
|
|
5645
5853
|
};
|
|
5646
5854
|
/**
|
|
5647
|
-
* Primary start time. For recurring events, this is the first occurrence anchor.
|
|
5855
|
+
* Primary start time. For recurring events, this is the first occurrence anchor. The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
5648
5856
|
*/
|
|
5649
5857
|
startsAt: string;
|
|
5650
5858
|
/**
|
|
5651
|
-
* Primary end time. Must be after the start time.
|
|
5859
|
+
* Primary end time. Must be after the start time. The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
5652
5860
|
*/
|
|
5653
5861
|
endsAt: string;
|
|
5654
5862
|
/**
|
|
@@ -5661,7 +5869,22 @@ interface Event {
|
|
|
5661
5869
|
*/
|
|
5662
5870
|
recurrence?: {
|
|
5663
5871
|
/**
|
|
5664
|
-
*
|
|
5872
|
+
* Operator-friendly recurrence setup that generates RRULE text.
|
|
5873
|
+
*/
|
|
5874
|
+
frequency?: ('none' | 'daily' | 'weekly' | 'monthly' | 'manual') | null;
|
|
5875
|
+
/**
|
|
5876
|
+
* Use 1 for every period, 2 for every other day/week/month, and so on.
|
|
5877
|
+
*/
|
|
5878
|
+
interval?: number | null;
|
|
5879
|
+
/**
|
|
5880
|
+
* For example, choose Monday for a weekly Monday event. Leave empty to use the weekday of the start date.
|
|
5881
|
+
*/
|
|
5882
|
+
weekdays?: ('MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA' | 'SU')[] | null;
|
|
5883
|
+
endMode?: ('never' | 'count' | 'until') | null;
|
|
5884
|
+
count?: number | null;
|
|
5885
|
+
until?: string | null;
|
|
5886
|
+
/**
|
|
5887
|
+
* RFC 5545 RRULE string for advanced users. Use the repeat fields above for common schedules.
|
|
5665
5888
|
*/
|
|
5666
5889
|
rrule?: string | null;
|
|
5667
5890
|
rdates?: {
|
|
@@ -5756,7 +5979,7 @@ interface Event {
|
|
|
5756
5979
|
status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
|
|
5757
5980
|
coverImage?: (string | null) | Image;
|
|
5758
5981
|
/**
|
|
5759
|
-
* Public API visibility. Unlisted events
|
|
5982
|
+
* Public API visibility. Unlisted events remain available to public API reads, but are not intended for promoted listings.
|
|
5760
5983
|
*/
|
|
5761
5984
|
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
5762
5985
|
/**
|
|
@@ -5844,6 +6067,8 @@ interface EventTag {
|
|
|
5844
6067
|
deletedAt?: string | null;
|
|
5845
6068
|
}
|
|
5846
6069
|
/**
|
|
6070
|
+
* Review and adjust individual occurrences from recurring events.
|
|
6071
|
+
*
|
|
5847
6072
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5848
6073
|
* via the `definition` "event-occurrences".
|
|
5849
6074
|
*/
|
|
@@ -5859,7 +6084,13 @@ interface EventOccurrence {
|
|
|
5859
6084
|
* RECURRENCE-ID based on original DTSTART
|
|
5860
6085
|
*/
|
|
5861
6086
|
instanceKey?: string | null;
|
|
6087
|
+
/**
|
|
6088
|
+
* The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
6089
|
+
*/
|
|
5862
6090
|
startsAt: string;
|
|
6091
|
+
/**
|
|
6092
|
+
* The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
6093
|
+
*/
|
|
5863
6094
|
endsAt: string;
|
|
5864
6095
|
timezone?: string | null;
|
|
5865
6096
|
isAllDay?: boolean | null;
|
|
@@ -5881,7 +6112,13 @@ interface EventOccurrence {
|
|
|
5881
6112
|
registrationCount?: number | null;
|
|
5882
6113
|
waitlistCount?: number | null;
|
|
5883
6114
|
checkInWindow?: {
|
|
6115
|
+
/**
|
|
6116
|
+
* The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
6117
|
+
*/
|
|
5884
6118
|
opensAt?: string | null;
|
|
6119
|
+
/**
|
|
6120
|
+
* The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
6121
|
+
*/
|
|
5885
6122
|
closesAt?: string | null;
|
|
5886
6123
|
};
|
|
5887
6124
|
/**
|
|
@@ -5904,6 +6141,8 @@ interface EventOccurrence {
|
|
|
5904
6141
|
deletedAt?: string | null;
|
|
5905
6142
|
}
|
|
5906
6143
|
/**
|
|
6144
|
+
* Manage event registrants and attendance status.
|
|
6145
|
+
*
|
|
5907
6146
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5908
6147
|
* via the `definition` "event-registrations".
|
|
5909
6148
|
*/
|
|
@@ -6027,6 +6266,8 @@ interface DirectUploadSession {
|
|
|
6027
6266
|
createdAt: string;
|
|
6028
6267
|
}
|
|
6029
6268
|
/**
|
|
6269
|
+
* Manage form structure and publishing status.
|
|
6270
|
+
*
|
|
6030
6271
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6031
6272
|
* via the `definition` "forms".
|
|
6032
6273
|
*/
|
|
@@ -6045,6 +6286,14 @@ interface Form {
|
|
|
6045
6286
|
*/
|
|
6046
6287
|
generateSlug?: boolean | null;
|
|
6047
6288
|
slug?: string | null;
|
|
6289
|
+
/**
|
|
6290
|
+
* Submissions received through this form. Submissions cannot be created from the form document; public posts and the plugin record them.
|
|
6291
|
+
*/
|
|
6292
|
+
submissions?: {
|
|
6293
|
+
docs?: (string | FormSubmission)[];
|
|
6294
|
+
hasNextPage?: boolean;
|
|
6295
|
+
totalDocs?: number;
|
|
6296
|
+
};
|
|
6048
6297
|
fields?: ({
|
|
6049
6298
|
name: string;
|
|
6050
6299
|
label?: string | null;
|
|
@@ -6199,6 +6448,8 @@ interface Form {
|
|
|
6199
6448
|
deletedAt?: string | null;
|
|
6200
6449
|
}
|
|
6201
6450
|
/**
|
|
6451
|
+
* Review submitted form responses and processing status.
|
|
6452
|
+
*
|
|
6202
6453
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6203
6454
|
* via the `definition` "form-submissions".
|
|
6204
6455
|
*/
|
|
@@ -7178,7 +7429,10 @@ interface ProductVariantsSelect<T extends boolean = true> {
|
|
|
7178
7429
|
compareAtPrice?: T;
|
|
7179
7430
|
isUnlimited?: T;
|
|
7180
7431
|
stock?: T;
|
|
7432
|
+
stockAdjustmentReason?: T;
|
|
7433
|
+
stockAdjustmentNote?: T;
|
|
7181
7434
|
reservedStock?: T;
|
|
7435
|
+
adjustments?: T;
|
|
7182
7436
|
safetyStockThreshold?: T;
|
|
7183
7437
|
inventoryAlertState?: T;
|
|
7184
7438
|
barcode?: T;
|
|
@@ -7193,6 +7447,34 @@ interface ProductVariantsSelect<T extends boolean = true> {
|
|
|
7193
7447
|
createdAt?: T;
|
|
7194
7448
|
deletedAt?: T;
|
|
7195
7449
|
}
|
|
7450
|
+
/**
|
|
7451
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
7452
|
+
* via the `definition` "inventory-adjustments_select".
|
|
7453
|
+
*/
|
|
7454
|
+
interface InventoryAdjustmentsSelect<T extends boolean = true> {
|
|
7455
|
+
tenant?: T;
|
|
7456
|
+
variant?: T;
|
|
7457
|
+
product?: T;
|
|
7458
|
+
sku?: T;
|
|
7459
|
+
variantTitle?: T;
|
|
7460
|
+
source?: T;
|
|
7461
|
+
reason?: T;
|
|
7462
|
+
stockDelta?: T;
|
|
7463
|
+
reservedStockDelta?: T;
|
|
7464
|
+
stockBefore?: T;
|
|
7465
|
+
stockAfter?: T;
|
|
7466
|
+
reservedStockBefore?: T;
|
|
7467
|
+
reservedStockAfter?: T;
|
|
7468
|
+
availableBefore?: T;
|
|
7469
|
+
availableAfter?: T;
|
|
7470
|
+
actor?: T;
|
|
7471
|
+
note?: T;
|
|
7472
|
+
order?: T;
|
|
7473
|
+
return?: T;
|
|
7474
|
+
metadata?: T;
|
|
7475
|
+
updatedAt?: T;
|
|
7476
|
+
createdAt?: T;
|
|
7477
|
+
}
|
|
7196
7478
|
/**
|
|
7197
7479
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7198
7480
|
* via the `definition` "product-options_select".
|
|
@@ -7446,6 +7728,9 @@ interface BrandLogosSelect<T extends boolean = true> {
|
|
|
7446
7728
|
interface OrdersSelect<T extends boolean = true> {
|
|
7447
7729
|
tenant?: T;
|
|
7448
7730
|
orderNumber?: T;
|
|
7731
|
+
displayFinancialStatus?: T;
|
|
7732
|
+
displayFulfillmentStatus?: T;
|
|
7733
|
+
returnStatus?: T;
|
|
7449
7734
|
displayStatus?: T;
|
|
7450
7735
|
primaryDisplayStatus?: T;
|
|
7451
7736
|
returnDisplayStatus?: T;
|
|
@@ -7605,6 +7890,7 @@ interface InventoryReservationsSelect<T extends boolean = true> {
|
|
|
7605
7890
|
quantity?: T;
|
|
7606
7891
|
status?: T;
|
|
7607
7892
|
statusChangedAt?: T;
|
|
7893
|
+
expiresAt?: T;
|
|
7608
7894
|
updatedAt?: T;
|
|
7609
7895
|
createdAt?: T;
|
|
7610
7896
|
deletedAt?: T;
|
|
@@ -7726,6 +8012,25 @@ interface ReturnItemsSelect<T extends boolean = true> {
|
|
|
7726
8012
|
createdAt?: T;
|
|
7727
8013
|
deletedAt?: T;
|
|
7728
8014
|
}
|
|
8015
|
+
/**
|
|
8016
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
8017
|
+
* via the `definition` "order-export-profiles_select".
|
|
8018
|
+
*/
|
|
8019
|
+
interface OrderExportProfilesSelect<T extends boolean = true> {
|
|
8020
|
+
tenant?: T;
|
|
8021
|
+
title?: T;
|
|
8022
|
+
fileType?: T;
|
|
8023
|
+
leadingBlankRow?: T;
|
|
8024
|
+
columns?: T;
|
|
8025
|
+
description?: T;
|
|
8026
|
+
generateSlug?: T;
|
|
8027
|
+
slug?: T;
|
|
8028
|
+
isActive?: T;
|
|
8029
|
+
metadata?: T;
|
|
8030
|
+
updatedAt?: T;
|
|
8031
|
+
createdAt?: T;
|
|
8032
|
+
deletedAt?: T;
|
|
8033
|
+
}
|
|
7729
8034
|
/**
|
|
7730
8035
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7731
8036
|
* via the `definition` "shipping-policies_select".
|
|
@@ -9095,6 +9400,12 @@ interface EventsSelect<T extends boolean = true> {
|
|
|
9095
9400
|
timezone?: T;
|
|
9096
9401
|
isAllDay?: T;
|
|
9097
9402
|
recurrence?: T | {
|
|
9403
|
+
frequency?: T;
|
|
9404
|
+
interval?: T;
|
|
9405
|
+
weekdays?: T;
|
|
9406
|
+
endMode?: T;
|
|
9407
|
+
count?: T;
|
|
9408
|
+
until?: T;
|
|
9098
9409
|
rrule?: T;
|
|
9099
9410
|
rdates?: T | {
|
|
9100
9411
|
date?: T;
|
|
@@ -9303,6 +9614,7 @@ interface FormsSelect<T extends boolean = true> {
|
|
|
9303
9614
|
isActive?: T;
|
|
9304
9615
|
generateSlug?: T;
|
|
9305
9616
|
slug?: T;
|
|
9617
|
+
submissions?: T;
|
|
9306
9618
|
fields?: T | {
|
|
9307
9619
|
checkbox?: T | {
|
|
9308
9620
|
name?: T;
|
|
@@ -9490,4 +9802,4 @@ declare module 'payload' {
|
|
|
9490
9802
|
}
|
|
9491
9803
|
}
|
|
9492
9804
|
|
|
9493
|
-
export type { Article as A, CustomerProfile as C, Document as D, Form as F, Image as I, Order as O, Product as P,
|
|
9805
|
+
export type { Article as A, CustomerProfile as C, Document as D, Form as F, Image as I, Order as O, Product as P, Return as R, Tenant as T, Video as V, Webhook as W, CustomerProfileList as a, ProductCollection as b, Config as c, ArticleAuthor as d, ArticleCategory as e, ArticleTag as f, Cart as g, CartItem as h, Post as i, PostCategory as j, ProductVariant as k, Transaction as l, Fulfillment as m };
|