@compassdigital/sdk.typescript 4.67.0 → 4.68.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/lib/index.d.ts +58 -57
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +503 -501
- package/lib/index.js.map +1 -1
- package/lib/interface/ai.d.ts +1 -1
- package/lib/interface/ai.d.ts.map +1 -1
- package/lib/interface/announcement.d.ts +1 -1
- package/lib/interface/announcement.d.ts.map +1 -1
- package/lib/interface/auth.d.ts +3 -3
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/calendar.d.ts +2 -2
- package/lib/interface/calendar.d.ts.map +1 -1
- package/lib/interface/centricos.d.ts +11 -11
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/compassconnect.d.ts +1 -1
- package/lib/interface/compassconnect.d.ts.map +1 -1
- package/lib/interface/config.d.ts +1 -1
- package/lib/interface/config.d.ts.map +1 -1
- package/lib/interface/datalake.d.ts +1 -1
- package/lib/interface/datalake.d.ts.map +1 -1
- package/lib/interface/email.d.ts +1 -1
- package/lib/interface/email.d.ts.map +1 -1
- package/lib/interface/file.d.ts +2 -2
- package/lib/interface/file.d.ts.map +1 -1
- package/lib/interface/frictionless.d.ts +9 -9
- package/lib/interface/frictionless.d.ts.map +1 -1
- package/lib/interface/kds.d.ts +1 -1
- package/lib/interface/kds.d.ts.map +1 -1
- package/lib/interface/location.d.ts +5 -3
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/mealplan.d.ts +2 -1
- package/lib/interface/mealplan.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +149 -109
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/notification.d.ts +3 -3
- package/lib/interface/notification.d.ts.map +1 -1
- package/lib/interface/order.d.ts +7 -7
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/partner.d.ts +10 -10
- package/lib/interface/partner.d.ts.map +1 -1
- package/lib/interface/payment.d.ts +3 -3
- package/lib/interface/payment.d.ts.map +1 -1
- package/lib/interface/promo.d.ts +8 -8
- package/lib/interface/promo.d.ts.map +1 -1
- package/lib/interface/report.d.ts +10 -10
- package/lib/interface/report.d.ts.map +1 -1
- package/lib/interface/search.d.ts +8 -8
- package/lib/interface/search.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +7 -7
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/interface/task.d.ts +8 -8
- package/lib/interface/task.d.ts.map +1 -1
- package/lib/interface/tax.d.ts +2 -2
- package/lib/interface/tax.d.ts.map +1 -1
- package/lib/interface/user.d.ts +16 -16
- package/lib/interface/user.d.ts.map +1 -1
- package/lib/interface/vendor.d.ts +6 -6
- package/lib/interface/vendor.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +10395 -10394
- package/src/interface/ai.ts +22 -22
- package/src/interface/announcement.ts +60 -60
- package/src/interface/auth.ts +68 -68
- package/src/interface/calendar.ts +94 -94
- package/src/interface/centricos.ts +145 -145
- package/src/interface/compassconnect.ts +59 -59
- package/src/interface/config.ts +166 -166
- package/src/interface/datalake.ts +13 -13
- package/src/interface/email.ts +13 -13
- package/src/interface/file.ts +18 -18
- package/src/interface/frictionless.ts +177 -177
- package/src/interface/kds.ts +49 -49
- package/src/interface/location.ts +771 -769
- package/src/interface/mealplan.ts +155 -154
- package/src/interface/menu.ts +4079 -4018
- package/src/interface/notification.ts +51 -51
- package/src/interface/order.ts +464 -464
- package/src/interface/partner.ts +823 -823
- package/src/interface/payment.ts +278 -278
- package/src/interface/promo.ts +373 -373
- package/src/interface/report.ts +348 -348
- package/src/interface/search.ts +135 -135
- package/src/interface/shoppingcart.ts +429 -429
- package/src/interface/task.ts +212 -212
- package/src/interface/tax.ts +69 -69
- package/src/interface/user.ts +410 -410
- package/src/interface/vendor.ts +215 -215
package/lib/interface/menu.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RequestQuery, BaseRequest } from
|
|
1
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
2
2
|
export interface Menu {
|
|
3
3
|
id?: string;
|
|
4
4
|
date?: {
|
|
@@ -37,6 +37,10 @@ export interface Menu {
|
|
|
37
37
|
id?: string;
|
|
38
38
|
name?: string;
|
|
39
39
|
};
|
|
40
|
+
local_menu_group?: {
|
|
41
|
+
id?: string;
|
|
42
|
+
name?: string;
|
|
43
|
+
};
|
|
40
44
|
[index: string]: any;
|
|
41
45
|
};
|
|
42
46
|
}
|
|
@@ -306,7 +310,7 @@ export interface Error {
|
|
|
306
310
|
code?: number;
|
|
307
311
|
data?: Record<string, any>;
|
|
308
312
|
}
|
|
309
|
-
export type AmountOffExclusionTypes =
|
|
313
|
+
export type AmountOffExclusionTypes = 'loyalty' | 'discount' | 'promo';
|
|
310
314
|
export interface Menus {
|
|
311
315
|
menus?: Menu[];
|
|
312
316
|
}
|
|
@@ -341,7 +345,7 @@ export interface DraftBrandDTO {
|
|
|
341
345
|
name?: string;
|
|
342
346
|
description?: string;
|
|
343
347
|
is_active?: boolean;
|
|
344
|
-
type?:
|
|
348
|
+
type?: 'global' | 'local';
|
|
345
349
|
parent_id?: string;
|
|
346
350
|
local_menu_group_id?: string;
|
|
347
351
|
global_menu_group_id?: string;
|
|
@@ -357,7 +361,7 @@ export interface PublishedBrandDTO {
|
|
|
357
361
|
name?: string;
|
|
358
362
|
description?: string;
|
|
359
363
|
is_active?: boolean;
|
|
360
|
-
type?:
|
|
364
|
+
type?: 'global' | 'local';
|
|
361
365
|
parent_id?: string;
|
|
362
366
|
local_menu_group_id?: string;
|
|
363
367
|
global_menu_group_id?: string;
|
|
@@ -433,8 +437,8 @@ export interface PaginationOptionsDTO {
|
|
|
433
437
|
limit?: number;
|
|
434
438
|
page?: number;
|
|
435
439
|
sort_by?: string;
|
|
436
|
-
sort_order?:
|
|
437
|
-
soft_deleted?:
|
|
440
|
+
sort_order?: 'DESC' | 'ASC';
|
|
441
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
438
442
|
[index: string]: any;
|
|
439
443
|
}
|
|
440
444
|
export interface ListResponseMetadataDTO {
|
|
@@ -444,8 +448,8 @@ export interface ListResponseMetadataDTO {
|
|
|
444
448
|
limit?: number;
|
|
445
449
|
page?: number;
|
|
446
450
|
sort_by?: string;
|
|
447
|
-
sort_order?:
|
|
448
|
-
soft_deleted?:
|
|
451
|
+
sort_order?: 'DESC' | 'ASC';
|
|
452
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
449
453
|
[index: string]: any;
|
|
450
454
|
}
|
|
451
455
|
export interface LocalMenuGroupDTO {
|
|
@@ -596,7 +600,7 @@ export interface DraftModifierGroupDTO {
|
|
|
596
600
|
is_active?: boolean;
|
|
597
601
|
limit?: number;
|
|
598
602
|
brand_id?: string;
|
|
599
|
-
order_type?:
|
|
603
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
600
604
|
sizing?: string;
|
|
601
605
|
is_out_of_stock?: boolean;
|
|
602
606
|
is_incremental?: boolean;
|
|
@@ -677,7 +681,7 @@ export interface ReportingMetadataDTO {
|
|
|
677
681
|
[index: string]: any;
|
|
678
682
|
}
|
|
679
683
|
export interface ReportingCategoryMetadataDTO {
|
|
680
|
-
primary?:
|
|
684
|
+
primary?: 'Food' | 'Beverage' | 'Sundry' | 'Alcohol' | 'Snack';
|
|
681
685
|
secondary?: string;
|
|
682
686
|
[index: string]: any;
|
|
683
687
|
}
|
|
@@ -837,7 +841,7 @@ export interface GlobalDiffDependencyDTO {
|
|
|
837
841
|
[index: string]: any;
|
|
838
842
|
}
|
|
839
843
|
export interface GlobalDiffDTO {
|
|
840
|
-
action?:
|
|
844
|
+
action?: 'create' | 'update' | 'delete';
|
|
841
845
|
id?: string;
|
|
842
846
|
entity_type?: string;
|
|
843
847
|
local_id?: string;
|
|
@@ -854,7 +858,7 @@ export interface GlobalDiffDTO {
|
|
|
854
858
|
[index: string]: any;
|
|
855
859
|
}
|
|
856
860
|
export interface DiffDTO {
|
|
857
|
-
action:
|
|
861
|
+
action: 'create' | 'update' | 'delete';
|
|
858
862
|
id: string;
|
|
859
863
|
created_at?: string;
|
|
860
864
|
updated_at?: string;
|
|
@@ -957,7 +961,7 @@ export interface PublishedModifierGroupDTO {
|
|
|
957
961
|
is_active?: boolean;
|
|
958
962
|
limit?: number;
|
|
959
963
|
brand_id?: string;
|
|
960
|
-
order_type?:
|
|
964
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
961
965
|
sizing?: string;
|
|
962
966
|
is_out_of_stock?: boolean;
|
|
963
967
|
is_incremental?: boolean;
|
|
@@ -1001,6 +1005,19 @@ export interface PublishedModifierDTO {
|
|
|
1001
1005
|
permissions?: Record<string, any>;
|
|
1002
1006
|
[index: string]: any;
|
|
1003
1007
|
}
|
|
1008
|
+
export interface WarningDTO {
|
|
1009
|
+
barcode?: string;
|
|
1010
|
+
type?: string;
|
|
1011
|
+
items?: WarningItemDTO[];
|
|
1012
|
+
}
|
|
1013
|
+
export interface WarningItemDTO {
|
|
1014
|
+
id?: string;
|
|
1015
|
+
item_name?: string;
|
|
1016
|
+
barcode?: string;
|
|
1017
|
+
posid?: string;
|
|
1018
|
+
brand_id?: string;
|
|
1019
|
+
brand_name?: string;
|
|
1020
|
+
}
|
|
1004
1021
|
export interface GroupStockUpdate {
|
|
1005
1022
|
id: string;
|
|
1006
1023
|
items?: ItemStockUpdate[];
|
|
@@ -1733,8 +1750,8 @@ export interface GetMenuV3LocalMenuGroupsQuery {
|
|
|
1733
1750
|
limit?: number;
|
|
1734
1751
|
page?: number;
|
|
1735
1752
|
sort_by?: string;
|
|
1736
|
-
sort_order?:
|
|
1737
|
-
soft_deleted?:
|
|
1753
|
+
sort_order?: 'DESC' | 'ASC';
|
|
1754
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
1738
1755
|
_query?: string;
|
|
1739
1756
|
}
|
|
1740
1757
|
export interface GetMenuV3LocalMenuGroupsResponse {
|
|
@@ -1788,8 +1805,8 @@ export interface GetMenuV3DraftLocalMenuGroupBrandsQuery {
|
|
|
1788
1805
|
limit?: number;
|
|
1789
1806
|
page?: number;
|
|
1790
1807
|
sort_by?: string;
|
|
1791
|
-
sort_order?:
|
|
1792
|
-
soft_deleted?:
|
|
1808
|
+
sort_order?: 'DESC' | 'ASC';
|
|
1809
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
1793
1810
|
_query?: string;
|
|
1794
1811
|
}
|
|
1795
1812
|
export interface GetMenuV3DraftLocalMenuGroupBrandsResponse {
|
|
@@ -1809,8 +1826,8 @@ export interface GetMenuV3LocalMenuGroupBrandsQuery {
|
|
|
1809
1826
|
limit?: number;
|
|
1810
1827
|
page?: number;
|
|
1811
1828
|
sort_by?: string;
|
|
1812
|
-
sort_order?:
|
|
1813
|
-
soft_deleted?:
|
|
1829
|
+
sort_order?: 'DESC' | 'ASC';
|
|
1830
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
1814
1831
|
_query?: string;
|
|
1815
1832
|
}
|
|
1816
1833
|
export interface GetMenuV3LocalMenuGroupBrandsResponse {
|
|
@@ -1830,8 +1847,8 @@ export interface GetMenuV3LocalMenuGroupAllowedGlobalBrandsQuery {
|
|
|
1830
1847
|
limit?: number;
|
|
1831
1848
|
page?: number;
|
|
1832
1849
|
sort_by?: string;
|
|
1833
|
-
sort_order?:
|
|
1834
|
-
soft_deleted?:
|
|
1850
|
+
sort_order?: 'DESC' | 'ASC';
|
|
1851
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
1835
1852
|
_query?: string;
|
|
1836
1853
|
}
|
|
1837
1854
|
export interface GetMenuV3LocalMenuGroupAllowedGlobalBrandsResponse {
|
|
@@ -1848,12 +1865,12 @@ export interface PostMenuV3LocalMenuGroupImportBrandsQuery {
|
|
|
1848
1865
|
select?: string[];
|
|
1849
1866
|
relationships?: string[];
|
|
1850
1867
|
filter?: string;
|
|
1851
|
-
|
|
1868
|
+
'body.brand_ids'?: string[];
|
|
1852
1869
|
limit?: number;
|
|
1853
1870
|
page?: number;
|
|
1854
1871
|
sort_by?: string;
|
|
1855
|
-
sort_order?:
|
|
1856
|
-
soft_deleted?:
|
|
1872
|
+
sort_order?: 'DESC' | 'ASC';
|
|
1873
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
1857
1874
|
}
|
|
1858
1875
|
export interface PostMenuV3LocalMenuGroupImportBrandsResponse {
|
|
1859
1876
|
results: DraftBrandDTO[];
|
|
@@ -1912,6 +1929,20 @@ export interface GetMenuV3LocalMenuGroupExportSolutionsResponse {
|
|
|
1912
1929
|
}
|
|
1913
1930
|
export interface GetMenuV3LocalMenuGroupExportSolutionsRequest extends BaseRequest, RequestQuery<GetMenuV3LocalMenuGroupExportSolutionsQuery> {
|
|
1914
1931
|
}
|
|
1932
|
+
export interface GetMenuV3LocalMenuGroupExportSolutionPath {
|
|
1933
|
+
id: string;
|
|
1934
|
+
solution_id: string;
|
|
1935
|
+
}
|
|
1936
|
+
export interface GetMenuV3LocalMenuGroupExportSolutionQuery {
|
|
1937
|
+
format?: 'csv' | 'txt' | 'xlsx';
|
|
1938
|
+
_query?: string;
|
|
1939
|
+
}
|
|
1940
|
+
export interface GetMenuV3LocalMenuGroupExportSolutionResponse {
|
|
1941
|
+
s3_links: string[];
|
|
1942
|
+
[index: string]: any;
|
|
1943
|
+
}
|
|
1944
|
+
export interface GetMenuV3LocalMenuGroupExportSolutionRequest extends BaseRequest, RequestQuery<GetMenuV3LocalMenuGroupExportSolutionQuery>, GetMenuV3LocalMenuGroupExportSolutionPath {
|
|
1945
|
+
}
|
|
1915
1946
|
export interface PostMenuV3GlobalMenuGroupBody {
|
|
1916
1947
|
name: string;
|
|
1917
1948
|
is_active?: boolean;
|
|
@@ -1990,8 +2021,8 @@ export interface GetMenuV3GlobalMenuGroupsQuery {
|
|
|
1990
2021
|
limit?: number;
|
|
1991
2022
|
page?: number;
|
|
1992
2023
|
sort_by?: string;
|
|
1993
|
-
sort_order?:
|
|
1994
|
-
soft_deleted?:
|
|
2024
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2025
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
1995
2026
|
_query?: string;
|
|
1996
2027
|
}
|
|
1997
2028
|
export interface GetMenuV3GlobalMenuGroupsResponse {
|
|
@@ -2046,8 +2077,8 @@ export interface GetMenuV3DraftGlobalMenuGroupBrandsQuery {
|
|
|
2046
2077
|
limit?: number;
|
|
2047
2078
|
page?: number;
|
|
2048
2079
|
sort_by?: string;
|
|
2049
|
-
sort_order?:
|
|
2050
|
-
soft_deleted?:
|
|
2080
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2081
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2051
2082
|
_query?: string;
|
|
2052
2083
|
}
|
|
2053
2084
|
export interface GetMenuV3DraftGlobalMenuGroupBrandsResponse {
|
|
@@ -2067,8 +2098,8 @@ export interface GetMenuV3GlobalMenuGroupBrandsQuery {
|
|
|
2067
2098
|
limit?: number;
|
|
2068
2099
|
page?: number;
|
|
2069
2100
|
sort_by?: string;
|
|
2070
|
-
sort_order?:
|
|
2071
|
-
soft_deleted?:
|
|
2101
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2102
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2072
2103
|
_query?: string;
|
|
2073
2104
|
}
|
|
2074
2105
|
export interface GetMenuV3GlobalMenuGroupBrandsResponse {
|
|
@@ -2094,7 +2125,7 @@ export interface PostMenuV3DraftBrandBody {
|
|
|
2094
2125
|
name: string;
|
|
2095
2126
|
description?: string;
|
|
2096
2127
|
is_active?: boolean;
|
|
2097
|
-
type?:
|
|
2128
|
+
type?: 'global' | 'local';
|
|
2098
2129
|
parent_id?: string;
|
|
2099
2130
|
local_menu_group_id?: string;
|
|
2100
2131
|
global_menu_group_id?: string;
|
|
@@ -2145,7 +2176,7 @@ export interface PatchMenuV3DraftBrandBody {
|
|
|
2145
2176
|
name?: string;
|
|
2146
2177
|
description?: string;
|
|
2147
2178
|
is_active?: boolean;
|
|
2148
|
-
type?:
|
|
2179
|
+
type?: 'global' | 'local';
|
|
2149
2180
|
parent_id?: string;
|
|
2150
2181
|
local_menu_group_id?: string;
|
|
2151
2182
|
global_menu_group_id?: string;
|
|
@@ -2182,8 +2213,8 @@ export interface GetMenuV3DraftBrandsQuery {
|
|
|
2182
2213
|
limit?: number;
|
|
2183
2214
|
page?: number;
|
|
2184
2215
|
sort_by?: string;
|
|
2185
|
-
sort_order?:
|
|
2186
|
-
soft_deleted?:
|
|
2216
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2217
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2187
2218
|
_query?: string;
|
|
2188
2219
|
}
|
|
2189
2220
|
export interface GetMenuV3DraftBrandsResponse {
|
|
@@ -2209,7 +2240,7 @@ export type PostMenuV3DraftBrandsBody = {
|
|
|
2209
2240
|
name: string;
|
|
2210
2241
|
description?: string;
|
|
2211
2242
|
is_active?: boolean;
|
|
2212
|
-
type?:
|
|
2243
|
+
type?: 'global' | 'local';
|
|
2213
2244
|
parent_id?: string;
|
|
2214
2245
|
local_menu_group_id?: string;
|
|
2215
2246
|
global_menu_group_id?: string;
|
|
@@ -2259,8 +2290,8 @@ export interface GetMenuV3DraftBrandAuditsQuery {
|
|
|
2259
2290
|
limit?: number;
|
|
2260
2291
|
page?: number;
|
|
2261
2292
|
sort_by?: string;
|
|
2262
|
-
sort_order?:
|
|
2263
|
-
soft_deleted?:
|
|
2293
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2294
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2264
2295
|
_query?: string;
|
|
2265
2296
|
}
|
|
2266
2297
|
export interface GetMenuV3DraftBrandAuditsResponse {
|
|
@@ -2280,8 +2311,8 @@ export interface GetMenuV3DraftBrandMenusQuery {
|
|
|
2280
2311
|
limit?: number;
|
|
2281
2312
|
page?: number;
|
|
2282
2313
|
sort_by?: string;
|
|
2283
|
-
sort_order?:
|
|
2284
|
-
soft_deleted?:
|
|
2314
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2315
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2285
2316
|
_query?: string;
|
|
2286
2317
|
}
|
|
2287
2318
|
export interface GetMenuV3DraftBrandMenusResponse {
|
|
@@ -2301,8 +2332,8 @@ export interface GetMenuV3DraftBrandModifiersQuery {
|
|
|
2301
2332
|
limit?: number;
|
|
2302
2333
|
page?: number;
|
|
2303
2334
|
sort_by?: string;
|
|
2304
|
-
sort_order?:
|
|
2305
|
-
soft_deleted?:
|
|
2335
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2336
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2306
2337
|
_query?: string;
|
|
2307
2338
|
}
|
|
2308
2339
|
export interface GetMenuV3DraftBrandModifiersResponse {
|
|
@@ -2322,8 +2353,8 @@ export interface GetMenuV3DraftBrandModifierGroupsQuery {
|
|
|
2322
2353
|
limit?: number;
|
|
2323
2354
|
page?: number;
|
|
2324
2355
|
sort_by?: string;
|
|
2325
|
-
sort_order?:
|
|
2326
|
-
soft_deleted?:
|
|
2356
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2357
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2327
2358
|
_query?: string;
|
|
2328
2359
|
}
|
|
2329
2360
|
export interface GetMenuV3DraftBrandModifierGroupsResponse {
|
|
@@ -2343,8 +2374,8 @@ export interface GetMenuV3DraftBrandItemsQuery {
|
|
|
2343
2374
|
limit?: number;
|
|
2344
2375
|
page?: number;
|
|
2345
2376
|
sort_by?: string;
|
|
2346
|
-
sort_order?:
|
|
2347
|
-
soft_deleted?:
|
|
2377
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2378
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2348
2379
|
_query?: string;
|
|
2349
2380
|
}
|
|
2350
2381
|
export interface GetMenuV3DraftBrandItemsResponse {
|
|
@@ -2426,8 +2457,8 @@ export interface GetMenuV3DraftBrandDiffsQuery {
|
|
|
2426
2457
|
limit?: number;
|
|
2427
2458
|
page?: number;
|
|
2428
2459
|
sort_by?: string;
|
|
2429
|
-
sort_order?:
|
|
2430
|
-
soft_deleted?:
|
|
2460
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2461
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2431
2462
|
_query?: string;
|
|
2432
2463
|
}
|
|
2433
2464
|
export interface GetMenuV3DraftBrandDiffsResponse {
|
|
@@ -2449,10 +2480,10 @@ export interface PostMenuV3DraftBrandGlobalDiffsApplyRequest extends BaseRequest
|
|
|
2449
2480
|
}
|
|
2450
2481
|
export interface PostMenuV3DraftBrandAttachmentPath {
|
|
2451
2482
|
id: string;
|
|
2452
|
-
name:
|
|
2483
|
+
name: 'thumbnail';
|
|
2453
2484
|
}
|
|
2454
2485
|
export interface PostMenuV3DraftBrandAttachmentQuery {
|
|
2455
|
-
|
|
2486
|
+
'body.data'?: string;
|
|
2456
2487
|
}
|
|
2457
2488
|
export interface PostMenuV3DraftBrandAttachmentResponse {
|
|
2458
2489
|
status?: string;
|
|
@@ -2476,7 +2507,7 @@ export interface PostMenuV3BrandBody {
|
|
|
2476
2507
|
name: string;
|
|
2477
2508
|
description?: string;
|
|
2478
2509
|
is_active?: boolean;
|
|
2479
|
-
type?:
|
|
2510
|
+
type?: 'global' | 'local';
|
|
2480
2511
|
parent_id?: string;
|
|
2481
2512
|
local_menu_group_id?: string;
|
|
2482
2513
|
global_menu_group_id?: string;
|
|
@@ -2526,7 +2557,7 @@ export interface PatchMenuV3BrandBody {
|
|
|
2526
2557
|
name?: string;
|
|
2527
2558
|
description?: string;
|
|
2528
2559
|
is_active?: boolean;
|
|
2529
|
-
type?:
|
|
2560
|
+
type?: 'global' | 'local';
|
|
2530
2561
|
parent_id?: string;
|
|
2531
2562
|
local_menu_group_id?: string;
|
|
2532
2563
|
global_menu_group_id?: string;
|
|
@@ -2561,8 +2592,8 @@ export interface GetMenuV3BrandsQuery {
|
|
|
2561
2592
|
limit?: number;
|
|
2562
2593
|
page?: number;
|
|
2563
2594
|
sort_by?: string;
|
|
2564
|
-
sort_order?:
|
|
2565
|
-
soft_deleted?:
|
|
2595
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2596
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2566
2597
|
_query?: string;
|
|
2567
2598
|
nocache?: boolean;
|
|
2568
2599
|
}
|
|
@@ -2590,7 +2621,7 @@ export type PostMenuV3BrandsBody = {
|
|
|
2590
2621
|
name: string;
|
|
2591
2622
|
description?: string;
|
|
2592
2623
|
is_active?: boolean;
|
|
2593
|
-
type?:
|
|
2624
|
+
type?: 'global' | 'local';
|
|
2594
2625
|
parent_id?: string;
|
|
2595
2626
|
local_menu_group_id?: string;
|
|
2596
2627
|
global_menu_group_id?: string;
|
|
@@ -2641,8 +2672,8 @@ export interface GetMenuV3BrandMenusQuery {
|
|
|
2641
2672
|
limit?: number;
|
|
2642
2673
|
page?: number;
|
|
2643
2674
|
sort_by?: string;
|
|
2644
|
-
sort_order?:
|
|
2645
|
-
soft_deleted?:
|
|
2675
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2676
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2646
2677
|
_query?: string;
|
|
2647
2678
|
nocache?: boolean;
|
|
2648
2679
|
}
|
|
@@ -2663,8 +2694,8 @@ export interface GetMenuV3BrandModifiersQuery {
|
|
|
2663
2694
|
limit?: number;
|
|
2664
2695
|
page?: number;
|
|
2665
2696
|
sort_by?: string;
|
|
2666
|
-
sort_order?:
|
|
2667
|
-
soft_deleted?:
|
|
2697
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2698
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2668
2699
|
_query?: string;
|
|
2669
2700
|
nocache?: boolean;
|
|
2670
2701
|
}
|
|
@@ -2685,8 +2716,8 @@ export interface GetMenuV3BrandModifierGroupsQuery {
|
|
|
2685
2716
|
limit?: number;
|
|
2686
2717
|
page?: number;
|
|
2687
2718
|
sort_by?: string;
|
|
2688
|
-
sort_order?:
|
|
2689
|
-
soft_deleted?:
|
|
2719
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2720
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2690
2721
|
_query?: string;
|
|
2691
2722
|
nocache?: boolean;
|
|
2692
2723
|
}
|
|
@@ -2707,8 +2738,8 @@ export interface GetMenuV3BrandItemsQuery {
|
|
|
2707
2738
|
limit?: number;
|
|
2708
2739
|
page?: number;
|
|
2709
2740
|
sort_by?: string;
|
|
2710
|
-
sort_order?:
|
|
2711
|
-
soft_deleted?:
|
|
2741
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2742
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2712
2743
|
_query?: string;
|
|
2713
2744
|
nocache?: boolean;
|
|
2714
2745
|
}
|
|
@@ -2787,8 +2818,8 @@ export interface GetMenuV3DraftMenusQuery {
|
|
|
2787
2818
|
limit?: number;
|
|
2788
2819
|
page?: number;
|
|
2789
2820
|
sort_by?: string;
|
|
2790
|
-
sort_order?:
|
|
2791
|
-
soft_deleted?:
|
|
2821
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2822
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2792
2823
|
_query?: string;
|
|
2793
2824
|
}
|
|
2794
2825
|
export interface GetMenuV3DraftMenusResponse {
|
|
@@ -2846,8 +2877,8 @@ export interface GetMenuV3DraftMenuCategoriesQuery {
|
|
|
2846
2877
|
limit?: number;
|
|
2847
2878
|
page?: number;
|
|
2848
2879
|
sort_by?: string;
|
|
2849
|
-
sort_order?:
|
|
2850
|
-
soft_deleted?:
|
|
2880
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2881
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2851
2882
|
_query?: string;
|
|
2852
2883
|
}
|
|
2853
2884
|
export interface GetMenuV3DraftMenuCategoriesResponse {
|
|
@@ -2865,6 +2896,15 @@ export interface PostMenuV3DraftMenuPublishResponse {
|
|
|
2865
2896
|
}
|
|
2866
2897
|
export interface PostMenuV3DraftMenuPublishRequest extends BaseRequest, PostMenuV3DraftMenuPublishPath {
|
|
2867
2898
|
}
|
|
2899
|
+
export interface GetMenuV3DraftMenusVerifyPublishQuery {
|
|
2900
|
+
menu_ids?: string[];
|
|
2901
|
+
_query?: string;
|
|
2902
|
+
}
|
|
2903
|
+
export interface GetMenuV3DraftMenusVerifyPublishResponse {
|
|
2904
|
+
warnings?: WarningDTO[];
|
|
2905
|
+
}
|
|
2906
|
+
export interface GetMenuV3DraftMenusVerifyPublishRequest extends BaseRequest, RequestQuery<GetMenuV3DraftMenusVerifyPublishQuery> {
|
|
2907
|
+
}
|
|
2868
2908
|
export interface GetMenuV3MenuPath {
|
|
2869
2909
|
id: string;
|
|
2870
2910
|
}
|
|
@@ -2884,8 +2924,8 @@ export interface GetMenuV3MenusQuery {
|
|
|
2884
2924
|
limit?: number;
|
|
2885
2925
|
page?: number;
|
|
2886
2926
|
sort_by?: string;
|
|
2887
|
-
sort_order?:
|
|
2888
|
-
soft_deleted?:
|
|
2927
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2928
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2889
2929
|
_query?: string;
|
|
2890
2930
|
nocache?: boolean;
|
|
2891
2931
|
}
|
|
@@ -2926,8 +2966,8 @@ export interface GetMenuV3MenuCategoriesQuery {
|
|
|
2926
2966
|
limit?: number;
|
|
2927
2967
|
page?: number;
|
|
2928
2968
|
sort_by?: string;
|
|
2929
|
-
sort_order?:
|
|
2930
|
-
soft_deleted?:
|
|
2969
|
+
sort_order?: 'DESC' | 'ASC';
|
|
2970
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
2931
2971
|
_query?: string;
|
|
2932
2972
|
nocache?: boolean;
|
|
2933
2973
|
}
|
|
@@ -3081,10 +3121,10 @@ export interface PostMenuV3DraftCategoryRecoverRequest extends BaseRequest, Post
|
|
|
3081
3121
|
}
|
|
3082
3122
|
export interface PostMenuV3DraftCategoryAttachmentPath {
|
|
3083
3123
|
id: string;
|
|
3084
|
-
name:
|
|
3124
|
+
name: 'thumbnail';
|
|
3085
3125
|
}
|
|
3086
3126
|
export interface PostMenuV3DraftCategoryAttachmentQuery {
|
|
3087
|
-
|
|
3127
|
+
'body.data'?: string;
|
|
3088
3128
|
}
|
|
3089
3129
|
export interface PostMenuV3DraftCategoryAttachmentResponse {
|
|
3090
3130
|
status?: string;
|
|
@@ -3197,8 +3237,8 @@ export interface GetMenuV3DraftCategoryRelationshipsItemsQuery {
|
|
|
3197
3237
|
limit?: number;
|
|
3198
3238
|
page?: number;
|
|
3199
3239
|
sort_by?: string;
|
|
3200
|
-
sort_order?:
|
|
3201
|
-
soft_deleted?:
|
|
3240
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3241
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3202
3242
|
_query?: string;
|
|
3203
3243
|
}
|
|
3204
3244
|
export interface GetMenuV3DraftCategoryRelationshipsItemsResponse {
|
|
@@ -3268,8 +3308,8 @@ export interface GetMenuV3CategoryRelationshipsItemsQuery {
|
|
|
3268
3308
|
limit?: number;
|
|
3269
3309
|
page?: number;
|
|
3270
3310
|
sort_by?: string;
|
|
3271
|
-
sort_order?:
|
|
3272
|
-
soft_deleted?:
|
|
3311
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3312
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3273
3313
|
_query?: string;
|
|
3274
3314
|
nocache?: boolean;
|
|
3275
3315
|
}
|
|
@@ -3426,8 +3466,8 @@ export interface GetMenuV3DraftItemsQuery {
|
|
|
3426
3466
|
limit?: number;
|
|
3427
3467
|
page?: number;
|
|
3428
3468
|
sort_by?: string;
|
|
3429
|
-
sort_order?:
|
|
3430
|
-
soft_deleted?:
|
|
3469
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3470
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3431
3471
|
_query?: string;
|
|
3432
3472
|
}
|
|
3433
3473
|
export interface GetMenuV3DraftItemsResponse {
|
|
@@ -3557,10 +3597,10 @@ export interface PatchMenuV3DraftItemsBulkUpdateRequest extends BaseRequest {
|
|
|
3557
3597
|
}
|
|
3558
3598
|
export interface PostMenuV3DraftItemAttachmentPath {
|
|
3559
3599
|
id: string;
|
|
3560
|
-
name:
|
|
3600
|
+
name: 'thumbnail';
|
|
3561
3601
|
}
|
|
3562
3602
|
export interface PostMenuV3DraftItemAttachmentQuery {
|
|
3563
|
-
|
|
3603
|
+
'body.data'?: string;
|
|
3564
3604
|
}
|
|
3565
3605
|
export interface PostMenuV3DraftItemAttachmentResponse {
|
|
3566
3606
|
status?: string;
|
|
@@ -3622,8 +3662,8 @@ export interface GetMenuV3ItemsQuery {
|
|
|
3622
3662
|
limit?: number;
|
|
3623
3663
|
page?: number;
|
|
3624
3664
|
sort_by?: string;
|
|
3625
|
-
sort_order?:
|
|
3626
|
-
soft_deleted?:
|
|
3665
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3666
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3627
3667
|
_query?: string;
|
|
3628
3668
|
nocache?: boolean;
|
|
3629
3669
|
}
|
|
@@ -3728,8 +3768,8 @@ export interface GetMenuV3DraftItemRelationshipsModifierGroupsQuery {
|
|
|
3728
3768
|
limit?: number;
|
|
3729
3769
|
page?: number;
|
|
3730
3770
|
sort_by?: string;
|
|
3731
|
-
sort_order?:
|
|
3732
|
-
soft_deleted?:
|
|
3771
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3772
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3733
3773
|
_query?: string;
|
|
3734
3774
|
}
|
|
3735
3775
|
export interface GetMenuV3DraftItemRelationshipsModifierGroupsResponse {
|
|
@@ -3799,8 +3839,8 @@ export interface GetMenuV3ItemRelationshipsModifierGroupsQuery {
|
|
|
3799
3839
|
limit?: number;
|
|
3800
3840
|
page?: number;
|
|
3801
3841
|
sort_by?: string;
|
|
3802
|
-
sort_order?:
|
|
3803
|
-
soft_deleted?:
|
|
3842
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3843
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3804
3844
|
_query?: string;
|
|
3805
3845
|
nocache?: boolean;
|
|
3806
3846
|
}
|
|
@@ -3844,7 +3884,7 @@ export interface PostMenuV3DraftModifierGroupBody {
|
|
|
3844
3884
|
is_active?: boolean;
|
|
3845
3885
|
limit?: number;
|
|
3846
3886
|
brand_id: string;
|
|
3847
|
-
order_type?:
|
|
3887
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
3848
3888
|
sizing?: string;
|
|
3849
3889
|
is_out_of_stock?: boolean;
|
|
3850
3890
|
is_incremental?: boolean;
|
|
@@ -3887,7 +3927,7 @@ export interface PatchMenuV3DraftModifierGroupBody {
|
|
|
3887
3927
|
is_active?: boolean;
|
|
3888
3928
|
limit?: number;
|
|
3889
3929
|
brand_id?: string;
|
|
3890
|
-
order_type?:
|
|
3930
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
3891
3931
|
sizing?: string;
|
|
3892
3932
|
is_out_of_stock?: boolean;
|
|
3893
3933
|
is_incremental?: boolean;
|
|
@@ -3919,8 +3959,8 @@ export interface GetMenuV3DraftModifierGroupsQuery {
|
|
|
3919
3959
|
limit?: number;
|
|
3920
3960
|
page?: number;
|
|
3921
3961
|
sort_by?: string;
|
|
3922
|
-
sort_order?:
|
|
3923
|
-
soft_deleted?:
|
|
3962
|
+
sort_order?: 'DESC' | 'ASC';
|
|
3963
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
3924
3964
|
_query?: string;
|
|
3925
3965
|
}
|
|
3926
3966
|
export interface GetMenuV3DraftModifierGroupsResponse {
|
|
@@ -3943,7 +3983,7 @@ export type PostMenuV3DraftModifierGroupsBody = {
|
|
|
3943
3983
|
is_active?: boolean;
|
|
3944
3984
|
limit?: number;
|
|
3945
3985
|
brand_id: string;
|
|
3946
|
-
order_type?:
|
|
3986
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
3947
3987
|
sizing?: string;
|
|
3948
3988
|
is_out_of_stock?: boolean;
|
|
3949
3989
|
is_incremental?: boolean;
|
|
@@ -4001,7 +4041,7 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
|
|
|
4001
4041
|
is_active?: boolean;
|
|
4002
4042
|
limit?: number;
|
|
4003
4043
|
brand_id: string;
|
|
4004
|
-
order_type?:
|
|
4044
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
4005
4045
|
sizing?: string;
|
|
4006
4046
|
is_out_of_stock?: boolean;
|
|
4007
4047
|
is_incremental?: boolean;
|
|
@@ -4034,8 +4074,8 @@ export interface GetMenuV3ModifierGroupsQuery {
|
|
|
4034
4074
|
limit?: number;
|
|
4035
4075
|
page?: number;
|
|
4036
4076
|
sort_by?: string;
|
|
4037
|
-
sort_order?:
|
|
4038
|
-
soft_deleted?:
|
|
4077
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4078
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4039
4079
|
_query?: string;
|
|
4040
4080
|
nocache?: boolean;
|
|
4041
4081
|
}
|
|
@@ -4140,8 +4180,8 @@ export interface GetMenuV3DraftModifierGroupRelationshipsModifiersQuery {
|
|
|
4140
4180
|
limit?: number;
|
|
4141
4181
|
page?: number;
|
|
4142
4182
|
sort_by?: string;
|
|
4143
|
-
sort_order?:
|
|
4144
|
-
soft_deleted?:
|
|
4183
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4184
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4145
4185
|
_query?: string;
|
|
4146
4186
|
}
|
|
4147
4187
|
export interface GetMenuV3DraftModifierGroupRelationshipsModifiersResponse {
|
|
@@ -4211,8 +4251,8 @@ export interface GetMenuV3ModifierGroupRelationshipsModifiersQuery {
|
|
|
4211
4251
|
limit?: number;
|
|
4212
4252
|
page?: number;
|
|
4213
4253
|
sort_by?: string;
|
|
4214
|
-
sort_order?:
|
|
4215
|
-
soft_deleted?:
|
|
4254
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4255
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4216
4256
|
_query?: string;
|
|
4217
4257
|
nocache?: boolean;
|
|
4218
4258
|
}
|
|
@@ -4369,8 +4409,8 @@ export interface GetMenuV3DraftModifiersQuery {
|
|
|
4369
4409
|
limit?: number;
|
|
4370
4410
|
page?: number;
|
|
4371
4411
|
sort_by?: string;
|
|
4372
|
-
sort_order?:
|
|
4373
|
-
soft_deleted?:
|
|
4412
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4413
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4374
4414
|
_query?: string;
|
|
4375
4415
|
}
|
|
4376
4416
|
export interface GetMenuV3DraftModifiersResponse {
|
|
@@ -4500,10 +4540,10 @@ export interface PatchMenuV3DraftModifiersBulkUpdateRequest extends BaseRequest
|
|
|
4500
4540
|
}
|
|
4501
4541
|
export interface PostMenuV3DraftModifiersAttachmentPath {
|
|
4502
4542
|
id: string;
|
|
4503
|
-
name:
|
|
4543
|
+
name: 'thumbnail';
|
|
4504
4544
|
}
|
|
4505
4545
|
export interface PostMenuV3DraftModifiersAttachmentQuery {
|
|
4506
|
-
|
|
4546
|
+
'body.data'?: string;
|
|
4507
4547
|
}
|
|
4508
4548
|
export interface PostMenuV3DraftModifiersAttachmentResponse {
|
|
4509
4549
|
status?: string;
|
|
@@ -4529,8 +4569,8 @@ export interface GetMenuV3ModifiersQuery {
|
|
|
4529
4569
|
limit?: number;
|
|
4530
4570
|
page?: number;
|
|
4531
4571
|
sort_by?: string;
|
|
4532
|
-
sort_order?:
|
|
4533
|
-
soft_deleted?:
|
|
4572
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4573
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4534
4574
|
_query?: string;
|
|
4535
4575
|
nocache?: boolean;
|
|
4536
4576
|
}
|
|
@@ -4562,7 +4602,7 @@ export type PostMenuV3ModifierRecoverResponse = PublishedModifierDTO;
|
|
|
4562
4602
|
export interface PostMenuV3ModifierRecoverRequest extends BaseRequest, RequestQuery<PostMenuV3ModifierRecoverQuery>, PostMenuV3ModifierRecoverPath {
|
|
4563
4603
|
}
|
|
4564
4604
|
export interface PostMenuV3IntegrationsTransltrImportQuery {
|
|
4565
|
-
|
|
4605
|
+
'body.data'?: string;
|
|
4566
4606
|
}
|
|
4567
4607
|
export interface PostMenuV3IntegrationsTransltrImportResponse {
|
|
4568
4608
|
errors?: Record<string, any>;
|
|
@@ -4588,8 +4628,8 @@ export interface GetMenuV3GlobalDiffsQuery {
|
|
|
4588
4628
|
limit?: number;
|
|
4589
4629
|
page?: number;
|
|
4590
4630
|
sort_by?: string;
|
|
4591
|
-
sort_order?:
|
|
4592
|
-
soft_deleted?:
|
|
4631
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4632
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4593
4633
|
_query?: string;
|
|
4594
4634
|
}
|
|
4595
4635
|
export interface GetMenuV3GlobalDiffsResponse {
|
|
@@ -4639,8 +4679,8 @@ export interface GetMenuV3UniversalItemsQuery {
|
|
|
4639
4679
|
limit?: number;
|
|
4640
4680
|
page?: number;
|
|
4641
4681
|
sort_by?: string;
|
|
4642
|
-
sort_order?:
|
|
4643
|
-
soft_deleted?:
|
|
4682
|
+
sort_order?: 'DESC' | 'ASC';
|
|
4683
|
+
soft_deleted?: 'include' | 'exclude' | 'only';
|
|
4644
4684
|
_query?: string;
|
|
4645
4685
|
}
|
|
4646
4686
|
export interface GetMenuV3UniversalItemsResponse {
|