@01.software/sdk 0.36.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 +142 -55
- package/dist/analytics/react.cjs +33 -9
- package/dist/analytics/react.cjs.map +1 -1
- package/dist/analytics/react.d.cts +1 -1
- package/dist/analytics/react.d.ts +1 -1
- package/dist/analytics/react.js +33 -9
- package/dist/analytics/react.js.map +1 -1
- package/dist/analytics.cjs +30 -8
- package/dist/analytics.cjs.map +1 -1
- package/dist/analytics.d.cts +6 -0
- package/dist/analytics.d.ts +6 -0
- package/dist/analytics.js +30 -8
- package/dist/analytics.js.map +1 -1
- package/dist/client.cjs +150 -207
- 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 +150 -207
- package/dist/client.js.map +1 -1
- package/dist/{collection-client-Cv0D2w1Q.d.cts → collection-client-B0J9wMNE.d.cts} +5 -5
- package/dist/{collection-client-Bq5Zd7p7.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/{image-BDz2-AaO.d.cts → image-BDjHp03R.d.cts} +13 -9
- package/dist/{image-BDz2-AaO.d.ts → image-BDjHp03R.d.ts} +13 -9
- package/dist/{index-DTSXUYkr.d.ts → index-BOLQxveo.d.cts} +9 -6
- package/dist/{index-BHDKJ6B3.d.cts → index-CSwR2HSg.d.ts} +9 -6
- package/dist/index.cjs +256 -244
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +12 -11
- package/dist/index.d.ts +12 -11
- package/dist/index.js +256 -244
- package/dist/index.js.map +1 -1
- package/dist/metadata.cjs +5 -3
- package/dist/metadata.cjs.map +1 -1
- package/dist/metadata.js +5 -3
- package/dist/metadata.js.map +1 -1
- package/dist/{payload-types-BCui2Oml.d.cts → payload-types-m3jjhxk9.d.cts} +669 -184
- package/dist/{payload-types-BCui2Oml.d.ts → payload-types-m3jjhxk9.d.ts} +669 -184
- package/dist/query.cjs +3 -1033
- 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 -1033
- 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 +121 -85
- 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 +121 -85
- package/dist/server.js.map +1 -1
- package/dist/{types-Dib-zdK6.d.cts → types-CIGscmus.d.cts} +1471 -1100
- package/dist/{types-3qV6sY7T.d.ts → types-Cmrd1ezc.d.ts} +1 -15
- package/dist/{types-CEzLf3PX.d.cts → types-D0ubzQw0.d.cts} +1 -15
- package/dist/{types-DK9EnLwJ.d.ts → types-D2xYdz4P.d.ts} +1471 -1100
- package/dist/ui/canvas.cjs +15 -5
- package/dist/ui/canvas.cjs.map +1 -1
- package/dist/ui/canvas.d.cts +1 -1
- package/dist/ui/canvas.d.ts +1 -1
- package/dist/ui/canvas.js +15 -5
- 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.cjs +15 -5
- package/dist/ui/image.cjs.map +1 -1
- package/dist/ui/image.d.cts +1 -1
- package/dist/ui/image.d.ts +1 -1
- package/dist/ui/image.js +15 -5
- package/dist/ui/image.js.map +1 -1
- package/dist/ui/video.d.cts +1 -1
- package/dist/ui/video.d.ts +1 -1
- package/dist/webhook.cjs +5 -1
- package/dist/webhook.cjs.map +1 -1
- package/dist/webhook.d.cts +4 -4
- package/dist/webhook.d.ts +4 -4
- package/dist/webhook.js +5 -1
- package/dist/webhook.js.map +1 -1
- package/package.json +3 -3
- package/dist/const-BDUKFP9w.d.ts +0 -32
- package/dist/const-DVcM7Ac_.d.cts +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;
|
|
@@ -50,10 +51,13 @@ interface Config {
|
|
|
50
51
|
transactions: Transaction;
|
|
51
52
|
'order-status-logs': OrderStatusLog;
|
|
52
53
|
'inventory-reservations': InventoryReservation;
|
|
54
|
+
'fulfillment-orders': FulfillmentOrder;
|
|
55
|
+
'fulfillment-order-items': FulfillmentOrderItem;
|
|
53
56
|
fulfillments: Fulfillment;
|
|
54
57
|
'fulfillment-items': FulfillmentItem;
|
|
55
58
|
returns: Return;
|
|
56
59
|
'return-items': ReturnItem;
|
|
60
|
+
'order-export-profiles': OrderExportProfile;
|
|
57
61
|
'shipping-policies': ShippingPolicy;
|
|
58
62
|
'shipping-zones': ShippingZone;
|
|
59
63
|
customers: Customer;
|
|
@@ -129,6 +133,9 @@ interface Config {
|
|
|
129
133
|
options: 'product-options';
|
|
130
134
|
collectionItems: 'product-collection-items';
|
|
131
135
|
};
|
|
136
|
+
'product-variants': {
|
|
137
|
+
adjustments: 'inventory-adjustments';
|
|
138
|
+
};
|
|
132
139
|
'product-options': {
|
|
133
140
|
values: 'product-option-values';
|
|
134
141
|
};
|
|
@@ -137,10 +144,14 @@ interface Config {
|
|
|
137
144
|
};
|
|
138
145
|
orders: {
|
|
139
146
|
items: 'order-items';
|
|
140
|
-
|
|
147
|
+
fulfillmentOrders: 'fulfillment-orders';
|
|
141
148
|
fulfillments: 'fulfillments';
|
|
149
|
+
transactions: 'transactions';
|
|
142
150
|
returns: 'returns';
|
|
143
151
|
};
|
|
152
|
+
'fulfillment-orders': {
|
|
153
|
+
items: 'fulfillment-order-items';
|
|
154
|
+
};
|
|
144
155
|
fulfillments: {
|
|
145
156
|
items: 'fulfillment-items';
|
|
146
157
|
};
|
|
@@ -174,6 +185,9 @@ interface Config {
|
|
|
174
185
|
'event-occurrences': {
|
|
175
186
|
registrations: 'event-registrations';
|
|
176
187
|
};
|
|
188
|
+
forms: {
|
|
189
|
+
submissions: 'form-submissions';
|
|
190
|
+
};
|
|
177
191
|
'payload-folders': {
|
|
178
192
|
documentsAndFolders: 'payload-folders' | 'images' | 'system-media';
|
|
179
193
|
};
|
|
@@ -206,6 +220,7 @@ interface Config {
|
|
|
206
220
|
'api-usage': ApiUsageSelect<false> | ApiUsageSelect<true>;
|
|
207
221
|
products: ProductsSelect<false> | ProductsSelect<true>;
|
|
208
222
|
'product-variants': ProductVariantsSelect<false> | ProductVariantsSelect<true>;
|
|
223
|
+
'inventory-adjustments': InventoryAdjustmentsSelect<false> | InventoryAdjustmentsSelect<true>;
|
|
209
224
|
'product-options': ProductOptionsSelect<false> | ProductOptionsSelect<true>;
|
|
210
225
|
'product-option-values': ProductOptionValuesSelect<false> | ProductOptionValuesSelect<true>;
|
|
211
226
|
'product-categories': ProductCategoriesSelect<false> | ProductCategoriesSelect<true>;
|
|
@@ -219,10 +234,13 @@ interface Config {
|
|
|
219
234
|
transactions: TransactionsSelect<false> | TransactionsSelect<true>;
|
|
220
235
|
'order-status-logs': OrderStatusLogsSelect<false> | OrderStatusLogsSelect<true>;
|
|
221
236
|
'inventory-reservations': InventoryReservationsSelect<false> | InventoryReservationsSelect<true>;
|
|
237
|
+
'fulfillment-orders': FulfillmentOrdersSelect<false> | FulfillmentOrdersSelect<true>;
|
|
238
|
+
'fulfillment-order-items': FulfillmentOrderItemsSelect<false> | FulfillmentOrderItemsSelect<true>;
|
|
222
239
|
fulfillments: FulfillmentsSelect<false> | FulfillmentsSelect<true>;
|
|
223
240
|
'fulfillment-items': FulfillmentItemsSelect<false> | FulfillmentItemsSelect<true>;
|
|
224
241
|
returns: ReturnsSelect<false> | ReturnsSelect<true>;
|
|
225
242
|
'return-items': ReturnItemsSelect<false> | ReturnItemsSelect<true>;
|
|
243
|
+
'order-export-profiles': OrderExportProfilesSelect<false> | OrderExportProfilesSelect<true>;
|
|
226
244
|
'shipping-policies': ShippingPoliciesSelect<false> | ShippingPoliciesSelect<true>;
|
|
227
245
|
'shipping-zones': ShippingZonesSelect<false> | ShippingZonesSelect<true>;
|
|
228
246
|
customers: CustomersSelect<false> | CustomersSelect<true>;
|
|
@@ -404,6 +422,8 @@ interface CarouselBlock {
|
|
|
404
422
|
blockType: 'Carousel';
|
|
405
423
|
}
|
|
406
424
|
/**
|
|
425
|
+
* Manage image assets used by content and products.
|
|
426
|
+
*
|
|
407
427
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
408
428
|
* via the `definition` "images".
|
|
409
429
|
*/
|
|
@@ -487,6 +507,8 @@ interface Image {
|
|
|
487
507
|
};
|
|
488
508
|
}
|
|
489
509
|
/**
|
|
510
|
+
* Manage workspace identity and ownership.
|
|
511
|
+
*
|
|
490
512
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
491
513
|
* via the `definition` "tenants".
|
|
492
514
|
*/
|
|
@@ -585,6 +607,8 @@ interface Tenant {
|
|
|
585
607
|
deletedAt?: string | null;
|
|
586
608
|
}
|
|
587
609
|
/**
|
|
610
|
+
* Manage Admin Panel users and permission details.
|
|
611
|
+
*
|
|
588
612
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
589
613
|
* via the `definition` "users".
|
|
590
614
|
*/
|
|
@@ -677,6 +701,8 @@ interface FolderInterface {
|
|
|
677
701
|
createdAt: string;
|
|
678
702
|
}
|
|
679
703
|
/**
|
|
704
|
+
* Manage system media shared across the platform.
|
|
705
|
+
*
|
|
680
706
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
681
707
|
* via the `definition` "system-media".
|
|
682
708
|
*/
|
|
@@ -726,6 +752,8 @@ interface FieldConfig {
|
|
|
726
752
|
deletedAt?: string | null;
|
|
727
753
|
}
|
|
728
754
|
/**
|
|
755
|
+
* Manage audiences for newsletters and announcements.
|
|
756
|
+
*
|
|
729
757
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
730
758
|
* via the `definition` "audiences".
|
|
731
759
|
*/
|
|
@@ -748,6 +776,8 @@ interface Audience {
|
|
|
748
776
|
deletedAt?: string | null;
|
|
749
777
|
}
|
|
750
778
|
/**
|
|
779
|
+
* Review transactional email delivery records.
|
|
780
|
+
*
|
|
751
781
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
752
782
|
* via the `definition` "email-logs".
|
|
753
783
|
*/
|
|
@@ -840,6 +870,8 @@ interface CommerceNotificationIntent {
|
|
|
840
870
|
createdAt: string;
|
|
841
871
|
}
|
|
842
872
|
/**
|
|
873
|
+
* Review and process payment, fulfillment, and confirmation status.
|
|
874
|
+
*
|
|
843
875
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
844
876
|
* via the `definition` "orders".
|
|
845
877
|
*/
|
|
@@ -847,37 +879,34 @@ interface Order {
|
|
|
847
879
|
id: string;
|
|
848
880
|
tenant?: (string | null) | Tenant;
|
|
849
881
|
orderNumber: string;
|
|
850
|
-
cartToken?: string | null;
|
|
851
|
-
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
852
|
-
totalAmount?: number | null;
|
|
853
|
-
discountCode?: string | null;
|
|
854
|
-
discountAmount?: number | null;
|
|
855
882
|
/**
|
|
856
|
-
*
|
|
883
|
+
* Payment status used for order lists and filters.
|
|
857
884
|
*/
|
|
858
|
-
|
|
885
|
+
displayFinancialStatus: 'pending' | 'paid' | 'partially_refunded' | 'refunded' | 'voided';
|
|
859
886
|
/**
|
|
860
|
-
*
|
|
887
|
+
* Fulfillment status used for order lists and filters.
|
|
861
888
|
*/
|
|
862
|
-
|
|
889
|
+
displayFulfillmentStatus: 'unfulfilled' | 'in_progress' | 'on_hold' | 'shipped' | 'fulfilled' | 'canceled';
|
|
863
890
|
/**
|
|
864
|
-
*
|
|
891
|
+
* Return status used for order lists and filters. Orders without active returns read as no_return.
|
|
865
892
|
*/
|
|
866
|
-
|
|
867
|
-
taxAmount?: number | null;
|
|
868
|
-
source?: ('web' | 'app' | 'manual') | null;
|
|
869
|
-
currency?: string | null;
|
|
893
|
+
returnStatus: 'no_return' | 'return_requested' | 'in_progress' | 'returned';
|
|
870
894
|
/**
|
|
871
|
-
*
|
|
895
|
+
* Display status derived from payment, fulfillment order, shipment, and return state.
|
|
872
896
|
*/
|
|
873
|
-
|
|
874
|
-
cancelReason?: string | null;
|
|
875
|
-
canceledAt?: string | null;
|
|
876
|
-
completedAt?: string | null;
|
|
897
|
+
displayStatus?: ('pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned') | null;
|
|
877
898
|
/**
|
|
878
|
-
*
|
|
899
|
+
* Primary order lifecycle display status excluding the return axis.
|
|
879
900
|
*/
|
|
880
|
-
|
|
901
|
+
primaryDisplayStatus?: ('pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed') | null;
|
|
902
|
+
/**
|
|
903
|
+
* Return display status derived only when a return is active.
|
|
904
|
+
*/
|
|
905
|
+
returnDisplayStatus?: ('return_requested' | 'return_processing' | 'returned') | null;
|
|
906
|
+
/**
|
|
907
|
+
* Deprecated: compatibility alias for displayStatus.
|
|
908
|
+
*/
|
|
909
|
+
status: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
881
910
|
customer?: (string | null) | Customer;
|
|
882
911
|
/**
|
|
883
912
|
* Customer info at the time of order
|
|
@@ -887,6 +916,11 @@ interface Order {
|
|
|
887
916
|
email?: string | null;
|
|
888
917
|
phone?: string | null;
|
|
889
918
|
};
|
|
919
|
+
items?: {
|
|
920
|
+
docs?: (string | OrderItem)[];
|
|
921
|
+
hasNextPage?: boolean;
|
|
922
|
+
totalDocs?: number;
|
|
923
|
+
};
|
|
890
924
|
shippingAddress?: {
|
|
891
925
|
recipientName?: string | null;
|
|
892
926
|
phone?: string | null;
|
|
@@ -895,33 +929,72 @@ interface Order {
|
|
|
895
929
|
detailAddress?: string | null;
|
|
896
930
|
deliveryMessage?: string | null;
|
|
897
931
|
};
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
businessRegistrationNumber?: string | null;
|
|
901
|
-
email?: string | null;
|
|
902
|
-
phone?: string | null;
|
|
903
|
-
address?: string | null;
|
|
904
|
-
};
|
|
905
|
-
items?: {
|
|
906
|
-
docs?: (string | OrderItem)[];
|
|
932
|
+
fulfillmentOrders?: {
|
|
933
|
+
docs?: (string | FulfillmentOrder)[];
|
|
907
934
|
hasNextPage?: boolean;
|
|
908
935
|
totalDocs?: number;
|
|
909
936
|
};
|
|
910
|
-
|
|
911
|
-
docs?: (string |
|
|
937
|
+
fulfillments?: {
|
|
938
|
+
docs?: (string | Fulfillment)[];
|
|
912
939
|
hasNextPage?: boolean;
|
|
913
940
|
totalDocs?: number;
|
|
914
941
|
};
|
|
915
|
-
|
|
916
|
-
|
|
942
|
+
totalAmount?: number | null;
|
|
943
|
+
/**
|
|
944
|
+
* Shipping amount at time of order
|
|
945
|
+
*/
|
|
946
|
+
shippingAmount?: number | null;
|
|
947
|
+
/**
|
|
948
|
+
* Note left by customer at checkout
|
|
949
|
+
*/
|
|
950
|
+
customerNote?: string | null;
|
|
951
|
+
transactions?: {
|
|
952
|
+
docs?: (string | Transaction)[];
|
|
917
953
|
hasNextPage?: boolean;
|
|
918
954
|
totalDocs?: number;
|
|
919
955
|
};
|
|
956
|
+
financialStatus: 'pending' | 'paid' | 'canceled' | 'partially_refunded' | 'refunded';
|
|
957
|
+
/**
|
|
958
|
+
* Item subtotal (excl. shipping & discount)
|
|
959
|
+
*/
|
|
960
|
+
subtotalAmount?: number | null;
|
|
961
|
+
discountCode?: string | null;
|
|
962
|
+
discountAmount?: number | null;
|
|
963
|
+
/**
|
|
964
|
+
* Cumulative refunded amount
|
|
965
|
+
*/
|
|
966
|
+
refundedAmount?: number | null;
|
|
967
|
+
taxAmount?: number | null;
|
|
968
|
+
/**
|
|
969
|
+
* Initial shipping refund policy snapshot at order time
|
|
970
|
+
*/
|
|
971
|
+
returnShippingRefundPolicySnapshot?: {
|
|
972
|
+
[k: string]: unknown;
|
|
973
|
+
} | unknown[] | string | number | boolean | null;
|
|
920
974
|
returns?: {
|
|
921
975
|
docs?: (string | Return)[];
|
|
922
976
|
hasNextPage?: boolean;
|
|
923
977
|
totalDocs?: number;
|
|
924
978
|
};
|
|
979
|
+
confirmationStatus: 'unconfirmed' | 'confirmed';
|
|
980
|
+
confirmedAt?: string | null;
|
|
981
|
+
cancelReason?: string | null;
|
|
982
|
+
canceledAt?: string | null;
|
|
983
|
+
completedAt?: string | null;
|
|
984
|
+
billingAddress?: {
|
|
985
|
+
recipientName?: string | null;
|
|
986
|
+
businessRegistrationNumber?: string | null;
|
|
987
|
+
email?: string | null;
|
|
988
|
+
phone?: string | null;
|
|
989
|
+
address?: string | null;
|
|
990
|
+
};
|
|
991
|
+
/**
|
|
992
|
+
* Internal admin notes (not visible to customers)
|
|
993
|
+
*/
|
|
994
|
+
adminNotes?: string | null;
|
|
995
|
+
source?: ('web' | 'app' | 'manual') | null;
|
|
996
|
+
currency?: string | null;
|
|
997
|
+
cartToken?: string | null;
|
|
925
998
|
metadata?: {
|
|
926
999
|
[k: string]: unknown;
|
|
927
1000
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -933,6 +1006,8 @@ interface Order {
|
|
|
933
1006
|
deletedAt?: string | null;
|
|
934
1007
|
}
|
|
935
1008
|
/**
|
|
1009
|
+
* Review customer accounts, purchases, and activity.
|
|
1010
|
+
*
|
|
936
1011
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
937
1012
|
* via the `definition` "customers".
|
|
938
1013
|
*/
|
|
@@ -1081,6 +1156,8 @@ interface Customer {
|
|
|
1081
1156
|
collection: 'customers';
|
|
1082
1157
|
}
|
|
1083
1158
|
/**
|
|
1159
|
+
* Manage customer groups for coupons, targeting, and badges.
|
|
1160
|
+
*
|
|
1084
1161
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1085
1162
|
* via the `definition` "customer-groups".
|
|
1086
1163
|
*/
|
|
@@ -1288,6 +1365,8 @@ interface OrderItem {
|
|
|
1288
1365
|
deletedAt?: string | null;
|
|
1289
1366
|
}
|
|
1290
1367
|
/**
|
|
1368
|
+
* Manage sellable item information and publishing status.
|
|
1369
|
+
*
|
|
1291
1370
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1292
1371
|
* via the `definition` "products".
|
|
1293
1372
|
*/
|
|
@@ -1484,6 +1563,8 @@ interface Product {
|
|
|
1484
1563
|
deletedAt?: string | null;
|
|
1485
1564
|
}
|
|
1486
1565
|
/**
|
|
1566
|
+
* Manage video content, processing, and publishing status.
|
|
1567
|
+
*
|
|
1487
1568
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1488
1569
|
* via the `definition` "videos".
|
|
1489
1570
|
*/
|
|
@@ -1591,6 +1672,8 @@ interface Video {
|
|
|
1591
1672
|
deletedAt?: string | null;
|
|
1592
1673
|
}
|
|
1593
1674
|
/**
|
|
1675
|
+
* Manage live stream schedules and stream status.
|
|
1676
|
+
*
|
|
1594
1677
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1595
1678
|
* via the `definition` "live-streams".
|
|
1596
1679
|
*/
|
|
@@ -1784,10 +1867,26 @@ interface ProductVariant {
|
|
|
1784
1867
|
* Available quantity is stock minus reserved stock.
|
|
1785
1868
|
*/
|
|
1786
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;
|
|
1787
1878
|
/**
|
|
1788
1879
|
* Reserved stock increased automatically during order processing.
|
|
1789
1880
|
*/
|
|
1790
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
|
+
};
|
|
1791
1890
|
/**
|
|
1792
1891
|
* Minimum quantity before low-stock alerts.
|
|
1793
1892
|
*/
|
|
@@ -1828,6 +1927,144 @@ interface ProductVariant {
|
|
|
1828
1927
|
createdAt: string;
|
|
1829
1928
|
deletedAt?: string | null;
|
|
1830
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
|
+
}
|
|
1831
2068
|
/**
|
|
1832
2069
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1833
2070
|
* via the `definition` "product-option-values".
|
|
@@ -1972,11 +2209,17 @@ interface ProductTag {
|
|
|
1972
2209
|
* Single representative taxonomy image. Add domain-specific fields for multiple images such as thumbnail and hero variants.
|
|
1973
2210
|
*/
|
|
1974
2211
|
image?: (string | null) | Image;
|
|
2212
|
+
/**
|
|
2213
|
+
* Optional #RRGGBB hex color for taxonomy badges or filter UI. This does not replace the representative image.
|
|
2214
|
+
*/
|
|
2215
|
+
color?: string | null;
|
|
1975
2216
|
updatedAt: string;
|
|
1976
2217
|
createdAt: string;
|
|
1977
2218
|
deletedAt?: string | null;
|
|
1978
2219
|
}
|
|
1979
2220
|
/**
|
|
2221
|
+
* Manage brand details and logos linked to products.
|
|
2222
|
+
*
|
|
1980
2223
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
1981
2224
|
* via the `definition` "brands".
|
|
1982
2225
|
*/
|
|
@@ -2163,6 +2406,8 @@ interface BrandLogo {
|
|
|
2163
2406
|
};
|
|
2164
2407
|
}
|
|
2165
2408
|
/**
|
|
2409
|
+
* Manage shipping fee rules and default shipping policies.
|
|
2410
|
+
*
|
|
2166
2411
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2167
2412
|
* via the `definition` "shipping-policies".
|
|
2168
2413
|
*/
|
|
@@ -2234,7 +2479,7 @@ interface ProductCollectionItem {
|
|
|
2234
2479
|
createdAt: string;
|
|
2235
2480
|
}
|
|
2236
2481
|
/**
|
|
2237
|
-
*
|
|
2482
|
+
* Manage curated groupings for campaigns, recommendations, and merchandising.
|
|
2238
2483
|
*
|
|
2239
2484
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2240
2485
|
* via the `definition` "product-collections".
|
|
@@ -2326,62 +2571,43 @@ interface ProductCollection {
|
|
|
2326
2571
|
}
|
|
2327
2572
|
/**
|
|
2328
2573
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2329
|
-
* via the `definition` "
|
|
2574
|
+
* via the `definition` "fulfillment-orders".
|
|
2330
2575
|
*/
|
|
2331
|
-
interface
|
|
2576
|
+
interface FulfillmentOrder {
|
|
2332
2577
|
id: string;
|
|
2333
2578
|
tenant?: (string | null) | Tenant;
|
|
2334
|
-
_title?: string | null;
|
|
2335
|
-
type: 'payment' | 'refund';
|
|
2336
|
-
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded';
|
|
2337
2579
|
order: string | Order;
|
|
2338
|
-
|
|
2580
|
+
status: 'open' | 'in_progress' | 'on_hold' | 'canceled' | 'closed';
|
|
2581
|
+
holdReason?: string | null;
|
|
2339
2582
|
/**
|
|
2340
|
-
*
|
|
2583
|
+
* Warehouse, store, or external location identifier assigned to this fulfillment order.
|
|
2341
2584
|
*/
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2346
|
-
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
pgPaymentId?: string | null;
|
|
2350
|
-
pgOrderId?: string | null;
|
|
2351
|
-
providerEventId?: string | null;
|
|
2352
|
-
providerStatus?: string | null;
|
|
2353
|
-
confirmedAmount?: number | null;
|
|
2354
|
-
confirmedCurrency?: string | null;
|
|
2355
|
-
confirmedAt?: string | null;
|
|
2356
|
-
confirmationSource?: ('provider_webhook' | 'provider_lookup' | 'provider_api_confirm' | 'manual_server') | null;
|
|
2357
|
-
cashReceipt?: {
|
|
2358
|
-
issuanceType?: ('none' | 'personal' | 'business') | null;
|
|
2359
|
-
/**
|
|
2360
|
-
* Personal: phone or cash receipt card number / Business: business registration number
|
|
2361
|
-
*/
|
|
2362
|
-
registrationNumber?: string | null;
|
|
2363
|
-
issueNumber?: string | null;
|
|
2364
|
-
issuedAt?: string | null;
|
|
2365
|
-
};
|
|
2366
|
-
cardInfo?: {
|
|
2367
|
-
brand?: string | null;
|
|
2368
|
-
last4?: string | null;
|
|
2369
|
-
expMonth?: number | null;
|
|
2370
|
-
expYear?: number | null;
|
|
2371
|
-
issuerCode?: string | null;
|
|
2372
|
-
type?: ('credit' | 'debit' | 'gift') | null;
|
|
2373
|
-
owner?: string | null;
|
|
2585
|
+
assignedLocation?: string | null;
|
|
2586
|
+
preparedAt?: string | null;
|
|
2587
|
+
closedAt?: string | null;
|
|
2588
|
+
items?: {
|
|
2589
|
+
docs?: (string | FulfillmentOrderItem)[];
|
|
2590
|
+
hasNextPage?: boolean;
|
|
2591
|
+
totalDocs?: number;
|
|
2374
2592
|
};
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2593
|
+
adminNotes?: string | null;
|
|
2594
|
+
metadata?: {
|
|
2595
|
+
[k: string]: unknown;
|
|
2596
|
+
} | unknown[] | string | number | boolean | null;
|
|
2597
|
+
updatedAt: string;
|
|
2598
|
+
createdAt: string;
|
|
2599
|
+
deletedAt?: string | null;
|
|
2600
|
+
}
|
|
2601
|
+
/**
|
|
2602
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
2603
|
+
* via the `definition` "fulfillment-order-items".
|
|
2604
|
+
*/
|
|
2605
|
+
interface FulfillmentOrderItem {
|
|
2606
|
+
id: string;
|
|
2607
|
+
tenant?: (string | null) | Tenant;
|
|
2608
|
+
fulfillmentOrder: string | FulfillmentOrder;
|
|
2609
|
+
orderItem: string | OrderItem;
|
|
2610
|
+
quantity: number;
|
|
2385
2611
|
metadata?: {
|
|
2386
2612
|
[k: string]: unknown;
|
|
2387
2613
|
} | unknown[] | string | number | boolean | null;
|
|
@@ -2397,7 +2623,8 @@ interface Fulfillment {
|
|
|
2397
2623
|
id: string;
|
|
2398
2624
|
tenant?: (string | null) | Tenant;
|
|
2399
2625
|
order: string | Order;
|
|
2400
|
-
status: 'pending' | 'packed' | 'shipped' | 'delivered' | 'failed';
|
|
2626
|
+
status: 'pending' | 'packed' | 'shipped' | 'delivered' | 'canceled' | 'failed';
|
|
2627
|
+
fulfillmentOrder: string | FulfillmentOrder;
|
|
2401
2628
|
/**
|
|
2402
2629
|
* Carrier name (e.g. CJ Logistics, FedEx)
|
|
2403
2630
|
*/
|
|
@@ -2437,88 +2664,73 @@ interface FulfillmentItem {
|
|
|
2437
2664
|
id: string;
|
|
2438
2665
|
tenant?: (string | null) | Tenant;
|
|
2439
2666
|
fulfillment: string | Fulfillment;
|
|
2440
|
-
orderItem: string | OrderItem;
|
|
2441
|
-
quantity: number;
|
|
2442
|
-
updatedAt: string;
|
|
2443
|
-
createdAt: string;
|
|
2444
|
-
deletedAt?: string | null;
|
|
2445
|
-
}
|
|
2446
|
-
/**
|
|
2447
|
-
* This interface was referenced by `Config`'s JSON-Schema
|
|
2448
|
-
* via the `definition` "returns".
|
|
2449
|
-
*/
|
|
2450
|
-
interface Return {
|
|
2451
|
-
id: string;
|
|
2452
|
-
tenant?: (string | null) | Tenant;
|
|
2453
|
-
returnNumber?: string | null;
|
|
2454
|
-
order: string | Order;
|
|
2455
|
-
type: 'refund' | 'exchange';
|
|
2456
|
-
/**
|
|
2457
|
-
* New order created for exchange
|
|
2458
|
-
*/
|
|
2459
|
-
exchangeOrder?: (string | null) | Order;
|
|
2460
|
-
status: 'requested' | 'processing' | 'approved' | 'rejected' | 'completed';
|
|
2461
|
-
/**
|
|
2462
|
-
* Reason category for the return or refund request. Used for reporting and operations.
|
|
2463
|
-
*/
|
|
2464
|
-
reason?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other') | null;
|
|
2465
|
-
/**
|
|
2466
|
-
* Detailed return reason
|
|
2467
|
-
*/
|
|
2468
|
-
reasonDetail?: string | null;
|
|
2469
|
-
items?: {
|
|
2470
|
-
docs?: (string | ReturnItem)[];
|
|
2471
|
-
hasNextPage?: boolean;
|
|
2472
|
-
totalDocs?: number;
|
|
2473
|
-
};
|
|
2474
|
-
/**
|
|
2475
|
-
* Internal return-processing note. Not shown directly to customers.
|
|
2476
|
-
*/
|
|
2477
|
-
adminNotes?: string | null;
|
|
2478
|
-
completedAt?: string | null;
|
|
2479
|
-
/**
|
|
2480
|
-
* Refund receipt URL
|
|
2481
|
-
*/
|
|
2482
|
-
refundReceiptUrl?: string | null;
|
|
2483
|
-
refundAmount: number;
|
|
2484
|
-
/**
|
|
2485
|
-
* Return shipping fee deducted from refundAmount
|
|
2486
|
-
*/
|
|
2487
|
-
returnShippingFee?: number | null;
|
|
2488
|
-
/**
|
|
2489
|
-
* Exchange balance (positive: extra charge, negative: extra refund)
|
|
2490
|
-
*/
|
|
2491
|
-
exchangeDifference?: number | null;
|
|
2492
|
-
metadata?: {
|
|
2493
|
-
[k: string]: unknown;
|
|
2494
|
-
} | unknown[] | string | number | boolean | null;
|
|
2667
|
+
orderItem: string | OrderItem;
|
|
2668
|
+
quantity: number;
|
|
2495
2669
|
updatedAt: string;
|
|
2496
2670
|
createdAt: string;
|
|
2497
2671
|
deletedAt?: string | null;
|
|
2498
2672
|
}
|
|
2499
2673
|
/**
|
|
2500
2674
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2501
|
-
* via the `definition` "
|
|
2675
|
+
* via the `definition` "transactions".
|
|
2502
2676
|
*/
|
|
2503
|
-
interface
|
|
2677
|
+
interface Transaction {
|
|
2504
2678
|
id: string;
|
|
2505
2679
|
tenant?: (string | null) | Tenant;
|
|
2506
|
-
|
|
2680
|
+
_title?: string | null;
|
|
2681
|
+
type: 'payment' | 'refund';
|
|
2682
|
+
status: 'pending' | 'paid' | 'failed' | 'canceled' | 'refunded';
|
|
2507
2683
|
order: string | Order;
|
|
2508
|
-
|
|
2509
|
-
orderItem: string | OrderItem;
|
|
2510
|
-
product: string | Product;
|
|
2511
|
-
variant?: (string | null) | ProductVariant;
|
|
2684
|
+
amount?: number | null;
|
|
2512
2685
|
/**
|
|
2513
|
-
*
|
|
2686
|
+
* Payment method snapshot returned by the provider. Not edited directly.
|
|
2514
2687
|
*/
|
|
2515
|
-
|
|
2516
|
-
restockAction: 'return_to_stock' | 'discard';
|
|
2688
|
+
paymentMethod?: string | null;
|
|
2517
2689
|
/**
|
|
2518
|
-
*
|
|
2690
|
+
* Installment months (0 = lump sum)
|
|
2519
2691
|
*/
|
|
2520
|
-
|
|
2521
|
-
|
|
2692
|
+
installmentMonths?: number | null;
|
|
2693
|
+
approvedAt?: string | null;
|
|
2694
|
+
receiptUrl?: string | null;
|
|
2695
|
+
pgPaymentId?: string | null;
|
|
2696
|
+
pgOrderId?: string | null;
|
|
2697
|
+
providerEventId?: string | null;
|
|
2698
|
+
providerStatus?: string | null;
|
|
2699
|
+
confirmedAmount?: number | null;
|
|
2700
|
+
confirmedCurrency?: string | null;
|
|
2701
|
+
confirmedAt?: string | null;
|
|
2702
|
+
confirmationSource?: ('provider_webhook' | 'provider_lookup' | 'provider_api_confirm' | 'manual_server') | null;
|
|
2703
|
+
cashReceipt?: {
|
|
2704
|
+
issuanceType?: ('none' | 'personal' | 'business') | null;
|
|
2705
|
+
/**
|
|
2706
|
+
* Personal: phone or cash receipt card number / Business: business registration number
|
|
2707
|
+
*/
|
|
2708
|
+
registrationNumber?: string | null;
|
|
2709
|
+
issueNumber?: string | null;
|
|
2710
|
+
issuedAt?: string | null;
|
|
2711
|
+
};
|
|
2712
|
+
cardInfo?: {
|
|
2713
|
+
brand?: string | null;
|
|
2714
|
+
last4?: string | null;
|
|
2715
|
+
expMonth?: number | null;
|
|
2716
|
+
expYear?: number | null;
|
|
2717
|
+
issuerCode?: string | null;
|
|
2718
|
+
type?: ('credit' | 'debit' | 'gift') | null;
|
|
2719
|
+
owner?: string | null;
|
|
2720
|
+
};
|
|
2721
|
+
failureCode?: string | null;
|
|
2722
|
+
failureMessage?: string | null;
|
|
2723
|
+
/**
|
|
2724
|
+
* Payment gateway (e.g. toss, stripe)
|
|
2725
|
+
*/
|
|
2726
|
+
pgProvider?: string | null;
|
|
2727
|
+
/**
|
|
2728
|
+
* Legal retention deadline (5 years, Electronic Financial Transactions Act)
|
|
2729
|
+
*/
|
|
2730
|
+
retainUntil?: string | null;
|
|
2731
|
+
metadata?: {
|
|
2732
|
+
[k: string]: unknown;
|
|
2733
|
+
} | unknown[] | string | number | boolean | null;
|
|
2522
2734
|
updatedAt: string;
|
|
2523
2735
|
createdAt: string;
|
|
2524
2736
|
deletedAt?: string | null;
|
|
@@ -2737,6 +2949,8 @@ interface WebhookDelivery {
|
|
|
2737
2949
|
createdAt: string;
|
|
2738
2950
|
}
|
|
2739
2951
|
/**
|
|
2952
|
+
* Configure event subscriptions and endpoints for external systems.
|
|
2953
|
+
*
|
|
2740
2954
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
2741
2955
|
* via the `definition` "webhooks".
|
|
2742
2956
|
*/
|
|
@@ -2754,7 +2968,7 @@ interface Webhook {
|
|
|
2754
2968
|
/**
|
|
2755
2969
|
* HMAC signing secret (encrypted at rest, never returned on read). Reveal or rotate in Admin.
|
|
2756
2970
|
*/
|
|
2757
|
-
secret
|
|
2971
|
+
secret?: string | null;
|
|
2758
2972
|
/**
|
|
2759
2973
|
* When the signing secret was first revealed to a tenant-admin (one time).
|
|
2760
2974
|
*/
|
|
@@ -2774,7 +2988,7 @@ interface Webhook {
|
|
|
2774
2988
|
/**
|
|
2775
2989
|
* Receives create/update events for this collection.
|
|
2776
2990
|
*/
|
|
2777
|
-
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';
|
|
2991
|
+
collection: 'tenant-metadata' | 'tenant-logos' | 'images' | 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-categories' | 'product-tags' | 'product-collections' | 'brands' | 'brand-logos' | 'orders' | 'order-items' | 'transactions' | 'fulfillment-orders' | 'fulfillment-order-items' | 'fulfillments' | 'fulfillment-items' | 'returns' | 'return-items' | 'carts' | 'cart-items' | 'discounts' | 'shipping-policies' | 'shipping-zones' | 'customers' | 'customer-profiles' | 'customer-addresses' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-items' | 'gallery-categories' | 'gallery-tags' | 'links' | 'link-categories' | 'link-tags' | 'forms' | 'form-submissions' | 'articles' | 'article-authors' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'canvases' | 'canvas-node-types' | 'canvas-edge-types' | 'canvas-categories' | 'canvas-tags' | 'canvas-nodes' | 'canvas-edges' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'post-tags' | 'customer-profile-lists' | 'event-calendars' | 'events' | 'event-categories' | 'event-occurrences' | 'event-tags';
|
|
2778
2992
|
id?: string | null;
|
|
2779
2993
|
}[] | null;
|
|
2780
2994
|
isActive?: boolean | null;
|
|
@@ -2933,6 +3147,15 @@ interface TenantMetadatum {
|
|
|
2933
3147
|
*/
|
|
2934
3148
|
twitterImage?: (string | null) | Image;
|
|
2935
3149
|
};
|
|
3150
|
+
ecommerceReturnPolicy?: {
|
|
3151
|
+
initialShippingRefundMode?: ('full_order_only' | 'never') | null;
|
|
3152
|
+
eligibleInitialShippingRefundReasons?: ('change_of_mind' | 'defective' | 'wrong_delivery' | 'damaged' | 'other')[] | null;
|
|
3153
|
+
returnShippingFeeDefaultMode?: 'manual_only' | null;
|
|
3154
|
+
manualOverrideAllowed?: boolean | null;
|
|
3155
|
+
overrideNoteRequired?: boolean | null;
|
|
3156
|
+
multiReturnInitialShippingRefund?: 'once_only' | null;
|
|
3157
|
+
legacyOrderPolicyMode?: 'shipping_amount_manual_cap' | null;
|
|
3158
|
+
};
|
|
2936
3159
|
/**
|
|
2937
3160
|
* Reusable option name and value lists for the Product Editor. Up to 20 presets.
|
|
2938
3161
|
*/
|
|
@@ -3108,6 +3331,8 @@ interface TenantEntitlement {
|
|
|
3108
3331
|
deletedAt?: string | null;
|
|
3109
3332
|
}
|
|
3110
3333
|
/**
|
|
3334
|
+
* Review workspace subscription status and applied plans.
|
|
3335
|
+
*
|
|
3111
3336
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3112
3337
|
* via the `definition` "subscriptions".
|
|
3113
3338
|
*/
|
|
@@ -3185,6 +3410,8 @@ interface TenantPurgeJob {
|
|
|
3185
3410
|
createdAt: string;
|
|
3186
3411
|
}
|
|
3187
3412
|
/**
|
|
3413
|
+
* Review billing charges and receipt records.
|
|
3414
|
+
*
|
|
3188
3415
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3189
3416
|
* via the `definition` "billing-history".
|
|
3190
3417
|
*/
|
|
@@ -3192,7 +3419,7 @@ interface BillingHistory {
|
|
|
3192
3419
|
id: string;
|
|
3193
3420
|
tenant: string | Tenant;
|
|
3194
3421
|
subscription?: (string | null) | Subscription;
|
|
3195
|
-
type: 'payment' | 'refund' | 'plan_change';
|
|
3422
|
+
type: 'payment' | 'refund' | 'plan_change' | 'billing_key_update';
|
|
3196
3423
|
status: 'success' | 'failed' | 'refunded' | 'partial_refund';
|
|
3197
3424
|
/**
|
|
3198
3425
|
* Amount (KRW)
|
|
@@ -3260,6 +3487,8 @@ interface Plan {
|
|
|
3260
3487
|
deletedAt?: string | null;
|
|
3261
3488
|
}
|
|
3262
3489
|
/**
|
|
3490
|
+
* Manage web analytics collection settings and allowed domains.
|
|
3491
|
+
*
|
|
3263
3492
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3264
3493
|
* via the `definition` "tenant-web-analytics-config".
|
|
3265
3494
|
*/
|
|
@@ -3402,6 +3631,8 @@ interface TenantAnalyticsDaily {
|
|
|
3402
3631
|
createdAt: string;
|
|
3403
3632
|
}
|
|
3404
3633
|
/**
|
|
3634
|
+
* Manage custom events and property schemas for analytics.
|
|
3635
|
+
*
|
|
3405
3636
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3406
3637
|
* via the `definition` "analytics-event-schemas".
|
|
3407
3638
|
*/
|
|
@@ -3430,6 +3661,8 @@ interface AnalyticsEventSchema {
|
|
|
3430
3661
|
deletedAt?: string | null;
|
|
3431
3662
|
}
|
|
3432
3663
|
/**
|
|
3664
|
+
* Review API, document, and media usage by workspace.
|
|
3665
|
+
*
|
|
3433
3666
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3434
3667
|
* via the `definition` "api-usage".
|
|
3435
3668
|
*/
|
|
@@ -3489,8 +3722,14 @@ interface OrderStatusLog {
|
|
|
3489
3722
|
id: string;
|
|
3490
3723
|
tenant?: (string | null) | Tenant;
|
|
3491
3724
|
order: string | Order;
|
|
3492
|
-
|
|
3493
|
-
|
|
3725
|
+
/**
|
|
3726
|
+
* Previous deprecated orders.status/displayStatus alias value.
|
|
3727
|
+
*/
|
|
3728
|
+
fromStatus: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3729
|
+
/**
|
|
3730
|
+
* Next deprecated orders.status/displayStatus alias value.
|
|
3731
|
+
*/
|
|
3732
|
+
toStatus: 'pending' | 'paid' | 'canceled' | 'refunded' | 'preparing' | 'shipped' | 'delivered' | 'confirmed' | 'return_requested' | 'return_processing' | 'returned';
|
|
3494
3733
|
/**
|
|
3495
3734
|
* 'user:{id}' | 'api:updateOrder' | 'system:transaction:{paymentId}' | 'system:fulfillment:{id}' | 'system:return:{id}'
|
|
3496
3735
|
*/
|
|
@@ -3516,16 +3755,66 @@ interface InventoryReservation {
|
|
|
3516
3755
|
/**
|
|
3517
3756
|
* Reservation lifecycle status. Payment, cancellation, and delivery server paths transition it through held, released, and consumed.
|
|
3518
3757
|
*/
|
|
3519
|
-
status: 'held' | 'released' | 'consumed';
|
|
3758
|
+
status: 'pending' | 'held' | 'released' | 'consumed';
|
|
3520
3759
|
/**
|
|
3521
3760
|
* Timestamp of the latest reservation status change made by a server path.
|
|
3522
3761
|
*/
|
|
3523
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;
|
|
3524
3811
|
updatedAt: string;
|
|
3525
3812
|
createdAt: string;
|
|
3526
3813
|
deletedAt?: string | null;
|
|
3527
3814
|
}
|
|
3528
3815
|
/**
|
|
3816
|
+
* Manage shippable regions and regional constraints.
|
|
3817
|
+
*
|
|
3529
3818
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3530
3819
|
* via the `definition` "shipping-zones".
|
|
3531
3820
|
*/
|
|
@@ -3561,6 +3850,8 @@ interface ShippingZone {
|
|
|
3561
3850
|
deletedAt?: string | null;
|
|
3562
3851
|
}
|
|
3563
3852
|
/**
|
|
3853
|
+
* Curate featured community profiles and public profile lists.
|
|
3854
|
+
*
|
|
3564
3855
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3565
3856
|
* via the `definition` "customer-profile-lists".
|
|
3566
3857
|
*/
|
|
@@ -3690,6 +3981,8 @@ interface CartItem {
|
|
|
3690
3981
|
createdAt: string;
|
|
3691
3982
|
}
|
|
3692
3983
|
/**
|
|
3984
|
+
* Manage discount codes, eligibility rules, and usage limits.
|
|
3985
|
+
*
|
|
3693
3986
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3694
3987
|
* via the `definition` "discounts".
|
|
3695
3988
|
*/
|
|
@@ -3784,6 +4077,8 @@ interface Discount {
|
|
|
3784
4077
|
deletedAt?: string | null;
|
|
3785
4078
|
}
|
|
3786
4079
|
/**
|
|
4080
|
+
* Manage publishable articles, authors, and classification.
|
|
4081
|
+
*
|
|
3787
4082
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3788
4083
|
* via the `definition` "articles".
|
|
3789
4084
|
*/
|
|
@@ -3890,6 +4185,8 @@ interface Article {
|
|
|
3890
4185
|
deletedAt?: string | null;
|
|
3891
4186
|
}
|
|
3892
4187
|
/**
|
|
4188
|
+
* Manage article author profiles and display details.
|
|
4189
|
+
*
|
|
3893
4190
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3894
4191
|
* via the `definition` "article-authors".
|
|
3895
4192
|
*/
|
|
@@ -3987,6 +4284,8 @@ interface ArticleTag {
|
|
|
3987
4284
|
deletedAt?: string | null;
|
|
3988
4285
|
}
|
|
3989
4286
|
/**
|
|
4287
|
+
* Manage document-based content and publishing status.
|
|
4288
|
+
*
|
|
3990
4289
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
3991
4290
|
* via the `definition` "documents".
|
|
3992
4291
|
*/
|
|
@@ -4144,6 +4443,8 @@ interface DocumentCategory {
|
|
|
4144
4443
|
deletedAt?: string | null;
|
|
4145
4444
|
}
|
|
4146
4445
|
/**
|
|
4446
|
+
* Manage document types used for classification.
|
|
4447
|
+
*
|
|
4147
4448
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4148
4449
|
* via the `definition` "document-types".
|
|
4149
4450
|
*/
|
|
@@ -4174,6 +4475,8 @@ interface DocumentType {
|
|
|
4174
4475
|
deletedAt?: string | null;
|
|
4175
4476
|
}
|
|
4176
4477
|
/**
|
|
4478
|
+
* Manage audio track groupings and publishing status.
|
|
4479
|
+
*
|
|
4177
4480
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4178
4481
|
* via the `definition` "playlists".
|
|
4179
4482
|
*/
|
|
@@ -4309,6 +4612,8 @@ interface PlaylistTag {
|
|
|
4309
4612
|
deletedAt?: string | null;
|
|
4310
4613
|
}
|
|
4311
4614
|
/**
|
|
4615
|
+
* Manage audio tracks and metadata used in playlists.
|
|
4616
|
+
*
|
|
4312
4617
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4313
4618
|
* via the `definition` "tracks".
|
|
4314
4619
|
*/
|
|
@@ -4447,6 +4752,8 @@ interface TrackAsset {
|
|
|
4447
4752
|
focalY?: number | null;
|
|
4448
4753
|
}
|
|
4449
4754
|
/**
|
|
4755
|
+
* Manage image galleries and display order.
|
|
4756
|
+
*
|
|
4450
4757
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4451
4758
|
* via the `definition` "galleries".
|
|
4452
4759
|
*/
|
|
@@ -4627,6 +4934,8 @@ interface GalleryItem {
|
|
|
4627
4934
|
deletedAt?: string | null;
|
|
4628
4935
|
}
|
|
4629
4936
|
/**
|
|
4937
|
+
* Manage external links and related metadata.
|
|
4938
|
+
*
|
|
4630
4939
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4631
4940
|
* via the `definition` "links".
|
|
4632
4941
|
*/
|
|
@@ -4744,6 +5053,8 @@ interface LinkTag {
|
|
|
4744
5053
|
deletedAt?: string | null;
|
|
4745
5054
|
}
|
|
4746
5055
|
/**
|
|
5056
|
+
* Manage visual canvases and publishing status.
|
|
5057
|
+
*
|
|
4747
5058
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4748
5059
|
* via the `definition` "canvases".
|
|
4749
5060
|
*/
|
|
@@ -4881,6 +5192,8 @@ interface CanvasTag {
|
|
|
4881
5192
|
deletedAt?: string | null;
|
|
4882
5193
|
}
|
|
4883
5194
|
/**
|
|
5195
|
+
* Configure node types available in canvases.
|
|
5196
|
+
*
|
|
4884
5197
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4885
5198
|
* via the `definition` "canvas-node-types".
|
|
4886
5199
|
*/
|
|
@@ -4950,6 +5263,8 @@ interface CanvasNodeType {
|
|
|
4950
5263
|
deletedAt?: string | null;
|
|
4951
5264
|
}
|
|
4952
5265
|
/**
|
|
5266
|
+
* Configure edge types available in canvases.
|
|
5267
|
+
*
|
|
4953
5268
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
4954
5269
|
* via the `definition` "canvas-edge-types".
|
|
4955
5270
|
*/
|
|
@@ -5059,6 +5374,8 @@ interface CanvasEdge {
|
|
|
5059
5374
|
deletedAt?: string | null;
|
|
5060
5375
|
}
|
|
5061
5376
|
/**
|
|
5377
|
+
* Manage community posts, visibility, and review status.
|
|
5378
|
+
*
|
|
5062
5379
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5063
5380
|
* via the `definition` "posts".
|
|
5064
5381
|
*/
|
|
@@ -5196,6 +5513,7 @@ interface PostCategory {
|
|
|
5196
5513
|
interface PostTag {
|
|
5197
5514
|
id: string;
|
|
5198
5515
|
_order?: string | null;
|
|
5516
|
+
tenant?: (string | null) | Tenant;
|
|
5199
5517
|
title?: string | null;
|
|
5200
5518
|
/**
|
|
5201
5519
|
* When enabled, the slug will auto-generate from the title field on save and autosave.
|
|
@@ -5285,6 +5603,8 @@ interface Reaction {
|
|
|
5285
5603
|
createdAt: string;
|
|
5286
5604
|
}
|
|
5287
5605
|
/**
|
|
5606
|
+
* Configure reaction types available in community interactions.
|
|
5607
|
+
*
|
|
5288
5608
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5289
5609
|
* via the `definition` "reaction-types".
|
|
5290
5610
|
*/
|
|
@@ -5379,6 +5699,8 @@ interface CommunityBan {
|
|
|
5379
5699
|
createdAt: string;
|
|
5380
5700
|
}
|
|
5381
5701
|
/**
|
|
5702
|
+
* Manage event calendar display settings and defaults.
|
|
5703
|
+
*
|
|
5382
5704
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5383
5705
|
* via the `definition` "event-calendars".
|
|
5384
5706
|
*/
|
|
@@ -5482,6 +5804,8 @@ interface EventCalendar {
|
|
|
5482
5804
|
deletedAt?: string | null;
|
|
5483
5805
|
}
|
|
5484
5806
|
/**
|
|
5807
|
+
* Manage events with schedules, locations, and recurrence rules.
|
|
5808
|
+
*
|
|
5485
5809
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5486
5810
|
* via the `definition` "events".
|
|
5487
5811
|
*/
|
|
@@ -5528,11 +5852,11 @@ interface Event {
|
|
|
5528
5852
|
user?: (string | null) | User;
|
|
5529
5853
|
};
|
|
5530
5854
|
/**
|
|
5531
|
-
* 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.
|
|
5532
5856
|
*/
|
|
5533
5857
|
startsAt: string;
|
|
5534
5858
|
/**
|
|
5535
|
-
* 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.
|
|
5536
5860
|
*/
|
|
5537
5861
|
endsAt: string;
|
|
5538
5862
|
/**
|
|
@@ -5545,7 +5869,22 @@ interface Event {
|
|
|
5545
5869
|
*/
|
|
5546
5870
|
recurrence?: {
|
|
5547
5871
|
/**
|
|
5548
|
-
*
|
|
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.
|
|
5549
5888
|
*/
|
|
5550
5889
|
rrule?: string | null;
|
|
5551
5890
|
rdates?: {
|
|
@@ -5640,7 +5979,7 @@ interface Event {
|
|
|
5640
5979
|
status?: ('draft' | 'published' | 'archived' | 'canceled') | null;
|
|
5641
5980
|
coverImage?: (string | null) | Image;
|
|
5642
5981
|
/**
|
|
5643
|
-
* Public API visibility. Unlisted events
|
|
5982
|
+
* Public API visibility. Unlisted events remain available to public API reads, but are not intended for promoted listings.
|
|
5644
5983
|
*/
|
|
5645
5984
|
visibility?: ('public' | 'unlisted' | 'private') | null;
|
|
5646
5985
|
/**
|
|
@@ -5728,6 +6067,8 @@ interface EventTag {
|
|
|
5728
6067
|
deletedAt?: string | null;
|
|
5729
6068
|
}
|
|
5730
6069
|
/**
|
|
6070
|
+
* Review and adjust individual occurrences from recurring events.
|
|
6071
|
+
*
|
|
5731
6072
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5732
6073
|
* via the `definition` "event-occurrences".
|
|
5733
6074
|
*/
|
|
@@ -5743,7 +6084,13 @@ interface EventOccurrence {
|
|
|
5743
6084
|
* RECURRENCE-ID based on original DTSTART
|
|
5744
6085
|
*/
|
|
5745
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
|
+
*/
|
|
5746
6090
|
startsAt: string;
|
|
6091
|
+
/**
|
|
6092
|
+
* The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
6093
|
+
*/
|
|
5747
6094
|
endsAt: string;
|
|
5748
6095
|
timezone?: string | null;
|
|
5749
6096
|
isAllDay?: boolean | null;
|
|
@@ -5765,7 +6112,13 @@ interface EventOccurrence {
|
|
|
5765
6112
|
registrationCount?: number | null;
|
|
5766
6113
|
waitlistCount?: number | null;
|
|
5767
6114
|
checkInWindow?: {
|
|
6115
|
+
/**
|
|
6116
|
+
* The picker list uses 30-minute steps. For minute-level precision, edit the time directly in the input.
|
|
6117
|
+
*/
|
|
5768
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
|
+
*/
|
|
5769
6122
|
closesAt?: string | null;
|
|
5770
6123
|
};
|
|
5771
6124
|
/**
|
|
@@ -5788,6 +6141,8 @@ interface EventOccurrence {
|
|
|
5788
6141
|
deletedAt?: string | null;
|
|
5789
6142
|
}
|
|
5790
6143
|
/**
|
|
6144
|
+
* Manage event registrants and attendance status.
|
|
6145
|
+
*
|
|
5791
6146
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5792
6147
|
* via the `definition` "event-registrations".
|
|
5793
6148
|
*/
|
|
@@ -5911,6 +6266,8 @@ interface DirectUploadSession {
|
|
|
5911
6266
|
createdAt: string;
|
|
5912
6267
|
}
|
|
5913
6268
|
/**
|
|
6269
|
+
* Manage form structure and publishing status.
|
|
6270
|
+
*
|
|
5914
6271
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
5915
6272
|
* via the `definition` "forms".
|
|
5916
6273
|
*/
|
|
@@ -5929,6 +6286,14 @@ interface Form {
|
|
|
5929
6286
|
*/
|
|
5930
6287
|
generateSlug?: boolean | null;
|
|
5931
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
|
+
};
|
|
5932
6297
|
fields?: ({
|
|
5933
6298
|
name: string;
|
|
5934
6299
|
label?: string | null;
|
|
@@ -6083,6 +6448,8 @@ interface Form {
|
|
|
6083
6448
|
deletedAt?: string | null;
|
|
6084
6449
|
}
|
|
6085
6450
|
/**
|
|
6451
|
+
* Review submitted form responses and processing status.
|
|
6452
|
+
*
|
|
6086
6453
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
6087
6454
|
* via the `definition` "form-submissions".
|
|
6088
6455
|
*/
|
|
@@ -6580,6 +6947,15 @@ interface TenantMetadataSelect<T extends boolean = true> {
|
|
|
6580
6947
|
twitterDescription?: T;
|
|
6581
6948
|
twitterImage?: T;
|
|
6582
6949
|
};
|
|
6950
|
+
ecommerceReturnPolicy?: T | {
|
|
6951
|
+
initialShippingRefundMode?: T;
|
|
6952
|
+
eligibleInitialShippingRefundReasons?: T;
|
|
6953
|
+
returnShippingFeeDefaultMode?: T;
|
|
6954
|
+
manualOverrideAllowed?: T;
|
|
6955
|
+
overrideNoteRequired?: T;
|
|
6956
|
+
multiReturnInitialShippingRefund?: T;
|
|
6957
|
+
legacyOrderPolicyMode?: T;
|
|
6958
|
+
};
|
|
6583
6959
|
optionPresets?: T | {
|
|
6584
6960
|
name?: T;
|
|
6585
6961
|
options?: T | {
|
|
@@ -7053,7 +7429,10 @@ interface ProductVariantsSelect<T extends boolean = true> {
|
|
|
7053
7429
|
compareAtPrice?: T;
|
|
7054
7430
|
isUnlimited?: T;
|
|
7055
7431
|
stock?: T;
|
|
7432
|
+
stockAdjustmentReason?: T;
|
|
7433
|
+
stockAdjustmentNote?: T;
|
|
7056
7434
|
reservedStock?: T;
|
|
7435
|
+
adjustments?: T;
|
|
7057
7436
|
safetyStockThreshold?: T;
|
|
7058
7437
|
inventoryAlertState?: T;
|
|
7059
7438
|
barcode?: T;
|
|
@@ -7068,6 +7447,34 @@ interface ProductVariantsSelect<T extends boolean = true> {
|
|
|
7068
7447
|
createdAt?: T;
|
|
7069
7448
|
deletedAt?: T;
|
|
7070
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
|
+
}
|
|
7071
7478
|
/**
|
|
7072
7479
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7073
7480
|
* via the `definition` "product-options_select".
|
|
@@ -7138,6 +7545,7 @@ interface ProductTagsSelect<T extends boolean = true> {
|
|
|
7138
7545
|
slug?: T;
|
|
7139
7546
|
description?: T;
|
|
7140
7547
|
image?: T;
|
|
7548
|
+
color?: T;
|
|
7141
7549
|
updatedAt?: T;
|
|
7142
7550
|
createdAt?: T;
|
|
7143
7551
|
deletedAt?: T;
|
|
@@ -7320,28 +7728,20 @@ interface BrandLogosSelect<T extends boolean = true> {
|
|
|
7320
7728
|
interface OrdersSelect<T extends boolean = true> {
|
|
7321
7729
|
tenant?: T;
|
|
7322
7730
|
orderNumber?: T;
|
|
7323
|
-
|
|
7731
|
+
displayFinancialStatus?: T;
|
|
7732
|
+
displayFulfillmentStatus?: T;
|
|
7733
|
+
returnStatus?: T;
|
|
7734
|
+
displayStatus?: T;
|
|
7735
|
+
primaryDisplayStatus?: T;
|
|
7736
|
+
returnDisplayStatus?: T;
|
|
7324
7737
|
status?: T;
|
|
7325
|
-
totalAmount?: T;
|
|
7326
|
-
discountCode?: T;
|
|
7327
|
-
discountAmount?: T;
|
|
7328
|
-
refundedAmount?: T;
|
|
7329
|
-
shippingAmount?: T;
|
|
7330
|
-
subtotalAmount?: T;
|
|
7331
|
-
taxAmount?: T;
|
|
7332
|
-
source?: T;
|
|
7333
|
-
currency?: T;
|
|
7334
|
-
adminNotes?: T;
|
|
7335
|
-
cancelReason?: T;
|
|
7336
|
-
canceledAt?: T;
|
|
7337
|
-
completedAt?: T;
|
|
7338
|
-
customerNote?: T;
|
|
7339
7738
|
customer?: T;
|
|
7340
7739
|
customerSnapshot?: T | {
|
|
7341
7740
|
name?: T;
|
|
7342
7741
|
email?: T;
|
|
7343
7742
|
phone?: T;
|
|
7344
7743
|
};
|
|
7744
|
+
items?: T;
|
|
7345
7745
|
shippingAddress?: T | {
|
|
7346
7746
|
recipientName?: T;
|
|
7347
7747
|
phone?: T;
|
|
@@ -7350,6 +7750,25 @@ interface OrdersSelect<T extends boolean = true> {
|
|
|
7350
7750
|
detailAddress?: T;
|
|
7351
7751
|
deliveryMessage?: T;
|
|
7352
7752
|
};
|
|
7753
|
+
fulfillmentOrders?: T;
|
|
7754
|
+
fulfillments?: T;
|
|
7755
|
+
totalAmount?: T;
|
|
7756
|
+
shippingAmount?: T;
|
|
7757
|
+
customerNote?: T;
|
|
7758
|
+
transactions?: T;
|
|
7759
|
+
financialStatus?: T;
|
|
7760
|
+
subtotalAmount?: T;
|
|
7761
|
+
discountCode?: T;
|
|
7762
|
+
discountAmount?: T;
|
|
7763
|
+
refundedAmount?: T;
|
|
7764
|
+
taxAmount?: T;
|
|
7765
|
+
returnShippingRefundPolicySnapshot?: T;
|
|
7766
|
+
returns?: T;
|
|
7767
|
+
confirmationStatus?: T;
|
|
7768
|
+
confirmedAt?: T;
|
|
7769
|
+
cancelReason?: T;
|
|
7770
|
+
canceledAt?: T;
|
|
7771
|
+
completedAt?: T;
|
|
7353
7772
|
billingAddress?: T | {
|
|
7354
7773
|
recipientName?: T;
|
|
7355
7774
|
businessRegistrationNumber?: T;
|
|
@@ -7357,10 +7776,10 @@ interface OrdersSelect<T extends boolean = true> {
|
|
|
7357
7776
|
phone?: T;
|
|
7358
7777
|
address?: T;
|
|
7359
7778
|
};
|
|
7360
|
-
|
|
7361
|
-
|
|
7362
|
-
|
|
7363
|
-
|
|
7779
|
+
adminNotes?: T;
|
|
7780
|
+
source?: T;
|
|
7781
|
+
currency?: T;
|
|
7782
|
+
cartToken?: T;
|
|
7364
7783
|
metadata?: T;
|
|
7365
7784
|
nextRefundSeq?: T;
|
|
7366
7785
|
nextCaptureSeq?: T;
|
|
@@ -7471,6 +7890,40 @@ interface InventoryReservationsSelect<T extends boolean = true> {
|
|
|
7471
7890
|
quantity?: T;
|
|
7472
7891
|
status?: T;
|
|
7473
7892
|
statusChangedAt?: T;
|
|
7893
|
+
expiresAt?: T;
|
|
7894
|
+
updatedAt?: T;
|
|
7895
|
+
createdAt?: T;
|
|
7896
|
+
deletedAt?: T;
|
|
7897
|
+
}
|
|
7898
|
+
/**
|
|
7899
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
7900
|
+
* via the `definition` "fulfillment-orders_select".
|
|
7901
|
+
*/
|
|
7902
|
+
interface FulfillmentOrdersSelect<T extends boolean = true> {
|
|
7903
|
+
tenant?: T;
|
|
7904
|
+
order?: T;
|
|
7905
|
+
status?: T;
|
|
7906
|
+
holdReason?: T;
|
|
7907
|
+
assignedLocation?: T;
|
|
7908
|
+
preparedAt?: T;
|
|
7909
|
+
closedAt?: T;
|
|
7910
|
+
items?: T;
|
|
7911
|
+
adminNotes?: T;
|
|
7912
|
+
metadata?: T;
|
|
7913
|
+
updatedAt?: T;
|
|
7914
|
+
createdAt?: T;
|
|
7915
|
+
deletedAt?: T;
|
|
7916
|
+
}
|
|
7917
|
+
/**
|
|
7918
|
+
* This interface was referenced by `Config`'s JSON-Schema
|
|
7919
|
+
* via the `definition` "fulfillment-order-items_select".
|
|
7920
|
+
*/
|
|
7921
|
+
interface FulfillmentOrderItemsSelect<T extends boolean = true> {
|
|
7922
|
+
tenant?: T;
|
|
7923
|
+
fulfillmentOrder?: T;
|
|
7924
|
+
orderItem?: T;
|
|
7925
|
+
quantity?: T;
|
|
7926
|
+
metadata?: T;
|
|
7474
7927
|
updatedAt?: T;
|
|
7475
7928
|
createdAt?: T;
|
|
7476
7929
|
deletedAt?: T;
|
|
@@ -7483,6 +7936,7 @@ interface FulfillmentsSelect<T extends boolean = true> {
|
|
|
7483
7936
|
tenant?: T;
|
|
7484
7937
|
order?: T;
|
|
7485
7938
|
status?: T;
|
|
7939
|
+
fulfillmentOrder?: T;
|
|
7486
7940
|
carrier?: T;
|
|
7487
7941
|
trackingNumber?: T;
|
|
7488
7942
|
trackingUrl?: T;
|
|
@@ -7528,6 +7982,10 @@ interface ReturnsSelect<T extends boolean = true> {
|
|
|
7528
7982
|
refundReceiptUrl?: T;
|
|
7529
7983
|
refundAmount?: T;
|
|
7530
7984
|
returnShippingFee?: T;
|
|
7985
|
+
initialShippingRefundAmount?: T;
|
|
7986
|
+
initialShippingRefundSuggestedAmount?: T;
|
|
7987
|
+
initialShippingRefundOverrideNote?: T;
|
|
7988
|
+
initialShippingRefundPolicySnapshot?: T;
|
|
7531
7989
|
exchangeDifference?: T;
|
|
7532
7990
|
metadata?: T;
|
|
7533
7991
|
updatedAt?: T;
|
|
@@ -7554,6 +8012,25 @@ interface ReturnItemsSelect<T extends boolean = true> {
|
|
|
7554
8012
|
createdAt?: T;
|
|
7555
8013
|
deletedAt?: T;
|
|
7556
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
|
+
}
|
|
7557
8034
|
/**
|
|
7558
8035
|
* This interface was referenced by `Config`'s JSON-Schema
|
|
7559
8036
|
* via the `definition` "shipping-policies_select".
|
|
@@ -8817,6 +9294,7 @@ interface PostCategoriesSelect<T extends boolean = true> {
|
|
|
8817
9294
|
*/
|
|
8818
9295
|
interface PostTagsSelect<T extends boolean = true> {
|
|
8819
9296
|
_order?: T;
|
|
9297
|
+
tenant?: T;
|
|
8820
9298
|
title?: T;
|
|
8821
9299
|
generateSlug?: T;
|
|
8822
9300
|
slug?: T;
|
|
@@ -8922,6 +9400,12 @@ interface EventsSelect<T extends boolean = true> {
|
|
|
8922
9400
|
timezone?: T;
|
|
8923
9401
|
isAllDay?: T;
|
|
8924
9402
|
recurrence?: T | {
|
|
9403
|
+
frequency?: T;
|
|
9404
|
+
interval?: T;
|
|
9405
|
+
weekdays?: T;
|
|
9406
|
+
endMode?: T;
|
|
9407
|
+
count?: T;
|
|
9408
|
+
until?: T;
|
|
8925
9409
|
rrule?: T;
|
|
8926
9410
|
rdates?: T | {
|
|
8927
9411
|
date?: T;
|
|
@@ -9130,6 +9614,7 @@ interface FormsSelect<T extends boolean = true> {
|
|
|
9130
9614
|
isActive?: T;
|
|
9131
9615
|
generateSlug?: T;
|
|
9132
9616
|
slug?: T;
|
|
9617
|
+
submissions?: T;
|
|
9133
9618
|
fields?: T | {
|
|
9134
9619
|
checkbox?: T | {
|
|
9135
9620
|
name?: T;
|
|
@@ -9317,4 +9802,4 @@ declare module 'payload' {
|
|
|
9317
9802
|
}
|
|
9318
9803
|
}
|
|
9319
9804
|
|
|
9320
|
-
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 };
|