@compassdigital/sdk.typescript 4.616.0 → 4.618.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 +24 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +27 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/consumer.d.ts +407 -59
- package/lib/interface/consumer.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +68 -0
- package/src/interface/consumer.ts +556 -119
|
@@ -1512,13 +1512,28 @@ export interface HomePageResponse {
|
|
|
1512
1512
|
}
|
|
1513
1513
|
|
|
1514
1514
|
export interface FrictionlessCheckinResponse {
|
|
1515
|
+
// Check-in session ID
|
|
1515
1516
|
id: string;
|
|
1516
|
-
|
|
1517
|
-
|
|
1517
|
+
// Frictionless provider
|
|
1518
|
+
provider: 'AWS' | 'SC';
|
|
1519
|
+
// Current status of the check-in session
|
|
1520
|
+
status:
|
|
1521
|
+
| 'CREATING'
|
|
1522
|
+
| 'ACTIVE'
|
|
1523
|
+
| 'ERROR'
|
|
1524
|
+
| 'CANCELED'
|
|
1525
|
+
| 'PROCESSING'
|
|
1526
|
+
| 'UPDATE_PAYMENT_REQUIRED'
|
|
1527
|
+
| 'COMPLETED';
|
|
1528
|
+
// Reason the session failed
|
|
1518
1529
|
reasonOfFail?: string;
|
|
1530
|
+
// Third-party correlated ID
|
|
1519
1531
|
thirdPartyCorrelatedID?: string;
|
|
1532
|
+
// Shopping cart ID associated with the session
|
|
1520
1533
|
shoppingCartID?: string;
|
|
1534
|
+
// Brand ID
|
|
1521
1535
|
brandID: string;
|
|
1536
|
+
// User ID
|
|
1522
1537
|
userID: string;
|
|
1523
1538
|
}
|
|
1524
1539
|
|
|
@@ -1535,14 +1550,44 @@ export interface FrictionlessQrCodeResponse {
|
|
|
1535
1550
|
id: string;
|
|
1536
1551
|
}
|
|
1537
1552
|
|
|
1538
|
-
export interface
|
|
1553
|
+
export interface FrictionlessMealplanPaymentDto {
|
|
1554
|
+
// Meal plan tender ID
|
|
1555
|
+
tenderID: string;
|
|
1556
|
+
// Meal plan name
|
|
1557
|
+
name: string;
|
|
1558
|
+
}
|
|
1559
|
+
|
|
1560
|
+
export interface FrictionlessCreditCardPaymentDto {
|
|
1561
|
+
// Credit card type
|
|
1562
|
+
cardType: string;
|
|
1563
|
+
// Last 4 digits of the credit card
|
|
1564
|
+
last4: string;
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
export interface FrictionlessPaymentMethodDto {
|
|
1568
|
+
// Meal plan payment details
|
|
1569
|
+
mealplan?: FrictionlessMealplanPaymentDto;
|
|
1570
|
+
// Credit card payment details
|
|
1571
|
+
creditCard?: FrictionlessCreditCardPaymentDto;
|
|
1572
|
+
// Payment token
|
|
1573
|
+
token?: string;
|
|
1574
|
+
}
|
|
1575
|
+
|
|
1576
|
+
export interface FrictionlessQrCodeV2Request {
|
|
1577
|
+
// brand id
|
|
1578
|
+
brandId: string;
|
|
1579
|
+
// payment method
|
|
1580
|
+
paymentMethod: FrictionlessPaymentMethodDto;
|
|
1581
|
+
}
|
|
1582
|
+
|
|
1583
|
+
export interface ForgotPasswordV1Request {
|
|
1539
1584
|
// email
|
|
1540
1585
|
email: string;
|
|
1541
1586
|
// captchaResponseKey
|
|
1542
1587
|
captchaResponseKey: string;
|
|
1543
|
-
// realm
|
|
1588
|
+
// The realm of the user
|
|
1544
1589
|
realm?: string;
|
|
1545
|
-
//
|
|
1590
|
+
// The language, e.g. en, fr
|
|
1546
1591
|
lang?: string;
|
|
1547
1592
|
}
|
|
1548
1593
|
|
|
@@ -1551,10 +1596,15 @@ export interface ForgotPasswordResponse {
|
|
|
1551
1596
|
success?: boolean;
|
|
1552
1597
|
}
|
|
1553
1598
|
|
|
1554
|
-
export interface
|
|
1555
|
-
|
|
1599
|
+
export interface ForgotPasswordRequest {
|
|
1600
|
+
// email
|
|
1601
|
+
email: string;
|
|
1602
|
+
// Type of password reset
|
|
1603
|
+
type?: 'forgot_password' | 'new_user';
|
|
1556
1604
|
}
|
|
1557
1605
|
|
|
1606
|
+
export type PostConsumerUserAddSecretBody = Record<string, any>;
|
|
1607
|
+
|
|
1558
1608
|
export interface PostUserAddSecret {
|
|
1559
1609
|
key?: string;
|
|
1560
1610
|
}
|
|
@@ -1752,7 +1802,14 @@ export interface ConsumerItem {
|
|
|
1752
1802
|
primary?: string;
|
|
1753
1803
|
secondary?: string;
|
|
1754
1804
|
};
|
|
1805
|
+
jde_category?: string;
|
|
1755
1806
|
};
|
|
1807
|
+
parent_id?: string;
|
|
1808
|
+
menu_labels?: {
|
|
1809
|
+
id?: string;
|
|
1810
|
+
text?: string;
|
|
1811
|
+
s3_link?: string;
|
|
1812
|
+
}[];
|
|
1756
1813
|
is_deleted?: boolean;
|
|
1757
1814
|
is?: {
|
|
1758
1815
|
disabled?: boolean;
|
|
@@ -1807,90 +1864,23 @@ export interface GetMenuItemNutritionConsumer {
|
|
|
1807
1864
|
calories?: GetMenuItemNutritionValueConsumer;
|
|
1808
1865
|
}
|
|
1809
1866
|
|
|
1810
|
-
export interface Certified {
|
|
1811
|
-
// Certified vegan
|
|
1812
|
-
vegan?: boolean;
|
|
1813
|
-
// Certified vegetarian
|
|
1814
|
-
vegetarian?: boolean;
|
|
1815
|
-
// Seafood Watch certified (sustainable seafood)
|
|
1816
|
-
seafood_watch?: boolean;
|
|
1817
|
-
// Certified for general wellbeing
|
|
1818
|
-
wellbeing?: boolean;
|
|
1819
|
-
// Farm to Fork certified (locally sourced)
|
|
1820
|
-
farm_to_fork?: boolean;
|
|
1821
|
-
// In Balance certified (nutritionally balanced)
|
|
1822
|
-
in_balance?: boolean;
|
|
1823
|
-
// Certified organic
|
|
1824
|
-
organic?: boolean;
|
|
1825
|
-
// No gluten ingredients present
|
|
1826
|
-
no_gluten_ingredients?: boolean;
|
|
1827
|
-
// Certified halal
|
|
1828
|
-
halal?: boolean;
|
|
1829
|
-
// Certified kosher
|
|
1830
|
-
kosher?: boolean;
|
|
1831
|
-
// Certified humane (animal welfare)
|
|
1832
|
-
humane?: boolean;
|
|
1833
|
-
// Locally crafted product
|
|
1834
|
-
locally_crafted?: boolean;
|
|
1835
|
-
// Contains nuts
|
|
1836
|
-
nuts?: boolean;
|
|
1837
|
-
// Oracle Garden Grown certified
|
|
1838
|
-
oracle_garden_grown?: boolean;
|
|
1839
|
-
// Oracle OYES certified
|
|
1840
|
-
oracle_oyes?: boolean;
|
|
1841
|
-
// Peanut free
|
|
1842
|
-
peanut_free?: boolean;
|
|
1843
|
-
// Tree nut free
|
|
1844
|
-
tree_nut_free?: boolean;
|
|
1845
|
-
// Wheat free
|
|
1846
|
-
wheat_free?: boolean;
|
|
1847
|
-
// Non-GMO certified
|
|
1848
|
-
non_gmo?: boolean;
|
|
1849
|
-
// Milk free
|
|
1850
|
-
milk_free?: boolean;
|
|
1851
|
-
// Egg free
|
|
1852
|
-
egg_free?: boolean;
|
|
1853
|
-
// Soy free
|
|
1854
|
-
soy_free?: boolean;
|
|
1855
|
-
// Fair Trade certified
|
|
1856
|
-
fair_trade?: boolean;
|
|
1857
|
-
// Rainforest Alliance certified
|
|
1858
|
-
rainforest_alliance?: boolean;
|
|
1859
|
-
// Salt free
|
|
1860
|
-
salt_free?: boolean;
|
|
1861
|
-
}
|
|
1862
|
-
|
|
1863
1867
|
export interface GetMenuOptionNutritionConsumer {
|
|
1864
|
-
// Calories
|
|
1865
1868
|
calories?: GetMenuItemNutritionValueConsumer;
|
|
1866
|
-
// Total fat
|
|
1867
1869
|
total_fat?: GetMenuItemNutritionValueConsumer;
|
|
1868
|
-
// Saturated fat
|
|
1869
1870
|
saturated_fat?: GetMenuItemNutritionValueConsumer;
|
|
1870
|
-
// Total carbohydrates
|
|
1871
1871
|
total_carbohydrate?: GetMenuItemNutritionValueConsumer;
|
|
1872
|
-
// Total sugars
|
|
1873
1872
|
total_sugars?: GetMenuItemNutritionValueConsumer;
|
|
1874
|
-
// Protein
|
|
1875
1873
|
protein?: GetMenuItemNutritionValueConsumer;
|
|
1876
|
-
// Dietary fiber
|
|
1877
1874
|
dietary_fiber?: GetMenuItemNutritionValueConsumer;
|
|
1878
|
-
// Sodium
|
|
1879
1875
|
sodium?: GetMenuItemNutritionValueConsumer;
|
|
1880
|
-
// Trans fat
|
|
1881
1876
|
trans_fat?: GetMenuItemNutritionValueConsumer;
|
|
1882
|
-
// Cholesterol
|
|
1883
1877
|
cholesterol?: GetMenuItemNutritionValueConsumer;
|
|
1884
|
-
// Added sugars
|
|
1885
1878
|
added_sugars?: GetMenuItemNutritionValueConsumer;
|
|
1886
1879
|
}
|
|
1887
1880
|
|
|
1888
1881
|
export interface GetMenuItemOptionSizingConsumer {
|
|
1889
|
-
// Sizing name
|
|
1890
1882
|
name?: string;
|
|
1891
|
-
// POS ID for sizing
|
|
1892
1883
|
posid?: string;
|
|
1893
|
-
// Price for this sizing
|
|
1894
1884
|
price?: number;
|
|
1895
1885
|
}
|
|
1896
1886
|
|
|
@@ -1899,6 +1889,16 @@ export interface GetMenuItemOptionMetaConsumer {
|
|
|
1899
1889
|
sizing?: GetMenuItemOptionSizingConsumer[];
|
|
1900
1890
|
}
|
|
1901
1891
|
|
|
1892
|
+
export interface GetMenuItemImageSizesConsumer {
|
|
1893
|
+
original?: string;
|
|
1894
|
+
thumbnail_80_80?: string;
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
export interface GetMenuItemImageConsumer {
|
|
1898
|
+
src?: string;
|
|
1899
|
+
sizes?: GetMenuItemImageSizesConsumer;
|
|
1900
|
+
}
|
|
1901
|
+
|
|
1902
1902
|
export interface GetMenuItemOptionConsumer {
|
|
1903
1903
|
// Menu Option ID
|
|
1904
1904
|
id?: string;
|
|
@@ -1913,7 +1913,6 @@ export interface GetMenuItemOptionConsumer {
|
|
|
1913
1913
|
}
|
|
1914
1914
|
|
|
1915
1915
|
export interface GetMenuItemGroupIsConsumer {
|
|
1916
|
-
// Options group incremental?
|
|
1917
1916
|
incremental?: boolean;
|
|
1918
1917
|
}
|
|
1919
1918
|
|
|
@@ -1925,17 +1924,11 @@ export interface GetMenuItemGroupMetaConsumer {
|
|
|
1925
1924
|
export interface GetMenuItemOptionsGroupConsumer {
|
|
1926
1925
|
// Menu Options Group ID
|
|
1927
1926
|
id?: string;
|
|
1928
|
-
// Label for the options group
|
|
1929
1927
|
label?: GetMenuItemLabelConsumer;
|
|
1930
|
-
// Options group items
|
|
1931
1928
|
items?: GetMenuItemOptionConsumer[];
|
|
1932
|
-
// Minimum number of options
|
|
1933
1929
|
min?: number;
|
|
1934
|
-
// Maximum number of options
|
|
1935
1930
|
max?: number;
|
|
1936
|
-
// Object containing quick boolean details
|
|
1937
1931
|
is?: GetMenuItemGroupIsConsumer;
|
|
1938
|
-
// Metadata for the options group
|
|
1939
1932
|
meta?: GetMenuItemGroupMetaConsumer;
|
|
1940
1933
|
}
|
|
1941
1934
|
|
|
@@ -1953,31 +1946,14 @@ export interface GetMenuItemMetaConsumer {
|
|
|
1953
1946
|
recipe?: GetMenuItemRecipeConsumer;
|
|
1954
1947
|
}
|
|
1955
1948
|
|
|
1956
|
-
export interface GetMenuItemImageSizesConsumer {
|
|
1957
|
-
// Image URL
|
|
1958
|
-
original?: string;
|
|
1959
|
-
// 80x80 thumbnail image URL
|
|
1960
|
-
thumbnail_80_80?: string;
|
|
1961
|
-
}
|
|
1962
|
-
|
|
1963
|
-
export interface GetMenuItemImageConsumer {
|
|
1964
|
-
// Image source URL
|
|
1965
|
-
src?: string;
|
|
1966
|
-
// Image sizes
|
|
1967
|
-
sizes?: GetMenuItemImageSizesConsumer;
|
|
1968
|
-
}
|
|
1969
|
-
|
|
1970
1949
|
export interface GetMenuItemIsConsumer {
|
|
1971
1950
|
// Is the item out of stock?
|
|
1972
1951
|
out_of_stock?: boolean;
|
|
1973
1952
|
}
|
|
1974
1953
|
|
|
1975
1954
|
export interface GetMenuItemMenuLabelConsumer {
|
|
1976
|
-
// Menu label ID
|
|
1977
1955
|
id?: string;
|
|
1978
|
-
// Menu label text
|
|
1979
1956
|
text?: string;
|
|
1980
|
-
// Image for Menu label S3 link
|
|
1981
1957
|
s3_link?: string;
|
|
1982
1958
|
}
|
|
1983
1959
|
|
|
@@ -2096,10 +2072,12 @@ export interface ConsumerCashlessLog {
|
|
|
2096
2072
|
}
|
|
2097
2073
|
|
|
2098
2074
|
export interface ConsumerUserMeta {
|
|
2099
|
-
|
|
2075
|
+
// Whether the user has opted in to marketing
|
|
2100
2076
|
marketing_opt_in?: boolean;
|
|
2077
|
+
// Date the user opted in to marketing
|
|
2101
2078
|
marketing_opt_in_date?: string;
|
|
2102
|
-
|
|
2079
|
+
// Source where the user opted in to marketing
|
|
2080
|
+
marketing_opt_in_source?: 'App' | 'Web';
|
|
2103
2081
|
order_status_notification?: {
|
|
2104
2082
|
send_emails?: boolean;
|
|
2105
2083
|
send_emails_date_updated?: string;
|
|
@@ -2143,6 +2121,17 @@ export interface ConsumerUserIs {
|
|
|
2143
2121
|
placeholder?: boolean;
|
|
2144
2122
|
}
|
|
2145
2123
|
|
|
2124
|
+
export interface ConsumerScopes {
|
|
2125
|
+
scopes?: string[];
|
|
2126
|
+
}
|
|
2127
|
+
|
|
2128
|
+
export interface ConsumerTemporaryPermissions {
|
|
2129
|
+
// Expiry date of the temporary permissions
|
|
2130
|
+
expiry: string;
|
|
2131
|
+
// Permission scopes
|
|
2132
|
+
scopes: string[];
|
|
2133
|
+
}
|
|
2134
|
+
|
|
2146
2135
|
export interface PostConsumerUserChangePasswordResponse {
|
|
2147
2136
|
// The ID of the user
|
|
2148
2137
|
id: string;
|
|
@@ -2152,17 +2141,37 @@ export interface PostConsumerUserChangePasswordResponse {
|
|
|
2152
2141
|
name?: ConsumerUserName;
|
|
2153
2142
|
// The date the user was created
|
|
2154
2143
|
date?: ConsumerUserDate;
|
|
2144
|
+
// The birthday of the user
|
|
2145
|
+
birthday?: string;
|
|
2146
|
+
// The password of the user
|
|
2147
|
+
password?: string;
|
|
2148
|
+
// The phone of the user
|
|
2149
|
+
phone?: number;
|
|
2150
|
+
// The phone country code of the user
|
|
2151
|
+
phone_country_code?: string;
|
|
2152
|
+
// The realm of the user
|
|
2153
|
+
realm?: string;
|
|
2154
|
+
// The location group of the user
|
|
2155
|
+
location_group?: string;
|
|
2156
|
+
// The ssoId of the user
|
|
2157
|
+
ssoId?: string;
|
|
2158
|
+
// The last accessed date of the user
|
|
2159
|
+
last_accessed?: string;
|
|
2155
2160
|
// The gender of the user
|
|
2156
|
-
gender?:
|
|
2161
|
+
gender?: 'male' | 'female' | 'non-binary';
|
|
2162
|
+
// The meta of the user
|
|
2157
2163
|
meta?: ConsumerUserMeta;
|
|
2164
|
+
// Quick boolean details for the user
|
|
2158
2165
|
is?: ConsumerUserIs;
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2166
|
+
// The permissions of the user
|
|
2167
|
+
permissions?: ConsumerScopes;
|
|
2168
|
+
// Temporary permissions for the user
|
|
2169
|
+
temporary_permissions?: ConsumerTemporaryPermissions;
|
|
2163
2170
|
}
|
|
2164
2171
|
|
|
2165
2172
|
export interface PutConsumerUserRequest {
|
|
2173
|
+
// The id of the user
|
|
2174
|
+
id?: string;
|
|
2166
2175
|
// The email of the user
|
|
2167
2176
|
email?: string;
|
|
2168
2177
|
// The name of the user
|
|
@@ -2180,7 +2189,7 @@ export interface PutConsumerUserRequest {
|
|
|
2180
2189
|
// The realm of the user
|
|
2181
2190
|
realm?: string;
|
|
2182
2191
|
// The gender of the user
|
|
2183
|
-
gender?:
|
|
2192
|
+
gender?: 'male' | 'female' | 'non-binary';
|
|
2184
2193
|
// The meta of the user
|
|
2185
2194
|
meta?: ConsumerUserMeta;
|
|
2186
2195
|
// The is of the user
|
|
@@ -2227,6 +2236,8 @@ export interface PutConsumerUserResponse {
|
|
|
2227
2236
|
}
|
|
2228
2237
|
|
|
2229
2238
|
export interface PatchConsumerUserRequest {
|
|
2239
|
+
// The id of the user
|
|
2240
|
+
id?: string;
|
|
2230
2241
|
// The email of the user
|
|
2231
2242
|
email?: string;
|
|
2232
2243
|
// The name of the user
|
|
@@ -2244,7 +2255,7 @@ export interface PatchConsumerUserRequest {
|
|
|
2244
2255
|
// The realm of the user
|
|
2245
2256
|
realm?: string;
|
|
2246
2257
|
// The gender of the user
|
|
2247
|
-
gender?:
|
|
2258
|
+
gender?: 'male' | 'female' | 'non-binary';
|
|
2248
2259
|
// The meta of the user
|
|
2249
2260
|
meta?: ConsumerUserMeta;
|
|
2250
2261
|
// The is of the user
|
|
@@ -2295,7 +2306,7 @@ export interface GetConsumerUserResponse {
|
|
|
2295
2306
|
// The realm of the user
|
|
2296
2307
|
realm?: string;
|
|
2297
2308
|
// The gender of the user
|
|
2298
|
-
gender?:
|
|
2309
|
+
gender?: 'male' | 'female' | 'non-binary';
|
|
2299
2310
|
// The meta of the user
|
|
2300
2311
|
meta?: ConsumerUserMeta;
|
|
2301
2312
|
// The is of the user
|
|
@@ -2306,6 +2317,8 @@ export interface GetConsumerUserResponse {
|
|
|
2306
2317
|
location_group?: string;
|
|
2307
2318
|
// The ssoId of the user
|
|
2308
2319
|
ssoId?: string;
|
|
2320
|
+
// The last accessed date of the user
|
|
2321
|
+
last_accessed?: string;
|
|
2309
2322
|
}
|
|
2310
2323
|
|
|
2311
2324
|
export interface ConsumerCashlessTender {
|
|
@@ -3445,20 +3458,57 @@ export interface PostConsumerUserGuestRequest {
|
|
|
3445
3458
|
name: ConsumerUserName;
|
|
3446
3459
|
}
|
|
3447
3460
|
|
|
3461
|
+
export interface GuestUserAccess {
|
|
3462
|
+
// Access token
|
|
3463
|
+
token?: string;
|
|
3464
|
+
// Token expiry date
|
|
3465
|
+
expires?: string;
|
|
3466
|
+
}
|
|
3467
|
+
|
|
3468
|
+
export interface GuestUserProfile {
|
|
3469
|
+
// The ID of the user
|
|
3470
|
+
id?: string;
|
|
3471
|
+
// The email of the user
|
|
3472
|
+
email?: string;
|
|
3473
|
+
// The name of the user
|
|
3474
|
+
name?: ConsumerUserName;
|
|
3475
|
+
// The date of the user
|
|
3476
|
+
date?: ConsumerUserDate;
|
|
3477
|
+
// The birthday of the user
|
|
3478
|
+
birthday?: string;
|
|
3479
|
+
// The password of the user
|
|
3480
|
+
password?: string;
|
|
3481
|
+
// The phone of the user
|
|
3482
|
+
phone?: number;
|
|
3483
|
+
// The phone country code of the user
|
|
3484
|
+
phone_country_code?: string;
|
|
3485
|
+
// The realm of the user
|
|
3486
|
+
realm?: string;
|
|
3487
|
+
// The gender of the user
|
|
3488
|
+
gender?: 'male' | 'female' | 'non-binary';
|
|
3489
|
+
// The meta of the user
|
|
3490
|
+
meta?: ConsumerUserMeta;
|
|
3491
|
+
// Quick boolean details for the user
|
|
3492
|
+
is?: ConsumerUserIs;
|
|
3493
|
+
// The permissions of the user
|
|
3494
|
+
permissions?: ConsumerScopes;
|
|
3495
|
+
// The location group of the user
|
|
3496
|
+
location_group?: string;
|
|
3497
|
+
// The ssoId of the user
|
|
3498
|
+
ssoId?: string;
|
|
3499
|
+
// The last accessed date of the user
|
|
3500
|
+
last_accessed?: string;
|
|
3501
|
+
}
|
|
3502
|
+
|
|
3448
3503
|
export interface PostConsumerUserGuestResponse {
|
|
3449
|
-
//
|
|
3504
|
+
// @deprecated
|
|
3450
3505
|
token?: string;
|
|
3451
|
-
access
|
|
3452
|
-
|
|
3453
|
-
expires?: string;
|
|
3454
|
-
};
|
|
3506
|
+
// The access information of the guest user
|
|
3507
|
+
access?: GuestUserAccess;
|
|
3455
3508
|
// The user ID of the guest user
|
|
3456
3509
|
user?: string;
|
|
3457
|
-
profile
|
|
3458
|
-
|
|
3459
|
-
email?: string;
|
|
3460
|
-
realm?: string;
|
|
3461
|
-
};
|
|
3510
|
+
// The profile of the guest user
|
|
3511
|
+
profile?: GuestUserProfile;
|
|
3462
3512
|
}
|
|
3463
3513
|
|
|
3464
3514
|
export interface OpenAiToolCallFunction {
|
|
@@ -3668,6 +3718,363 @@ export interface GetConsumerLocationResponse {
|
|
|
3668
3718
|
address?: ConsumerAddress;
|
|
3669
3719
|
}
|
|
3670
3720
|
|
|
3721
|
+
export interface GetMenuItemNutritionValueConsumerV2 {
|
|
3722
|
+
amount?: number;
|
|
3723
|
+
unit?: string;
|
|
3724
|
+
display?: string;
|
|
3725
|
+
}
|
|
3726
|
+
|
|
3727
|
+
export interface GetMenuItemNutritionConsumerV2 {
|
|
3728
|
+
kcal?: number;
|
|
3729
|
+
calories?: GetMenuItemNutritionValueConsumerV2;
|
|
3730
|
+
serving_size?: GetMenuItemNutritionValueConsumerV2;
|
|
3731
|
+
total_fat?: GetMenuItemNutritionValueConsumerV2;
|
|
3732
|
+
saturated_fat?: GetMenuItemNutritionValueConsumerV2;
|
|
3733
|
+
trans_fat?: GetMenuItemNutritionValueConsumerV2;
|
|
3734
|
+
cholesterol?: GetMenuItemNutritionValueConsumerV2;
|
|
3735
|
+
sodium?: GetMenuItemNutritionValueConsumerV2;
|
|
3736
|
+
total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
|
|
3737
|
+
dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
|
|
3738
|
+
sugars?: GetMenuItemNutritionValueConsumerV2;
|
|
3739
|
+
total_sugars?: GetMenuItemNutritionValueConsumerV2;
|
|
3740
|
+
protein?: GetMenuItemNutritionValueConsumerV2;
|
|
3741
|
+
well_being?: GetMenuItemNutritionValueConsumerV2;
|
|
3742
|
+
}
|
|
3743
|
+
|
|
3744
|
+
export interface GetMenuOptionNutritionConsumerV2 {
|
|
3745
|
+
calories?: GetMenuItemNutritionValueConsumerV2;
|
|
3746
|
+
total_fat?: GetMenuItemNutritionValueConsumerV2;
|
|
3747
|
+
saturated_fat?: GetMenuItemNutritionValueConsumerV2;
|
|
3748
|
+
total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
|
|
3749
|
+
total_sugars?: GetMenuItemNutritionValueConsumerV2;
|
|
3750
|
+
protein?: GetMenuItemNutritionValueConsumerV2;
|
|
3751
|
+
dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
|
|
3752
|
+
sodium?: GetMenuItemNutritionValueConsumerV2;
|
|
3753
|
+
trans_fat?: GetMenuItemNutritionValueConsumerV2;
|
|
3754
|
+
cholesterol?: GetMenuItemNutritionValueConsumerV2;
|
|
3755
|
+
added_sugars?: GetMenuItemNutritionValueConsumerV2;
|
|
3756
|
+
}
|
|
3757
|
+
|
|
3758
|
+
export interface GetMenuItemPriceConsumerV2 {
|
|
3759
|
+
amount?: number;
|
|
3760
|
+
currency?: string;
|
|
3761
|
+
total_price?: number;
|
|
3762
|
+
discount?: number;
|
|
3763
|
+
}
|
|
3764
|
+
|
|
3765
|
+
export interface GetMenuItemImageSizesConsumerV2 {
|
|
3766
|
+
original?: string;
|
|
3767
|
+
thumbnail_80_80?: string;
|
|
3768
|
+
}
|
|
3769
|
+
|
|
3770
|
+
export interface GetMenuItemImageConsumerV2 {
|
|
3771
|
+
src?: string;
|
|
3772
|
+
sizes?: GetMenuItemImageSizesConsumerV2;
|
|
3773
|
+
}
|
|
3774
|
+
|
|
3775
|
+
export interface GetMenuItemCertifiedConsumerV2 {
|
|
3776
|
+
vegan?: boolean;
|
|
3777
|
+
vegetarian?: boolean;
|
|
3778
|
+
seafood_watch?: boolean;
|
|
3779
|
+
wellbeing?: boolean;
|
|
3780
|
+
farm_to_fork?: boolean;
|
|
3781
|
+
in_balance?: boolean;
|
|
3782
|
+
organic?: boolean;
|
|
3783
|
+
no_gluten_ingredients?: boolean;
|
|
3784
|
+
halal?: boolean;
|
|
3785
|
+
kosher?: boolean;
|
|
3786
|
+
humane?: boolean;
|
|
3787
|
+
locally_crafted?: boolean;
|
|
3788
|
+
nuts?: boolean;
|
|
3789
|
+
oracle_garden_grown?: boolean;
|
|
3790
|
+
oracle_oyes?: boolean;
|
|
3791
|
+
peanut_free?: boolean;
|
|
3792
|
+
tree_nut_free?: boolean;
|
|
3793
|
+
wheat_free?: boolean;
|
|
3794
|
+
non_gmo?: boolean;
|
|
3795
|
+
milk_free?: boolean;
|
|
3796
|
+
egg_free?: boolean;
|
|
3797
|
+
soy_free?: boolean;
|
|
3798
|
+
fair_trade?: boolean;
|
|
3799
|
+
rainforest_alliance?: boolean;
|
|
3800
|
+
salt_free?: boolean;
|
|
3801
|
+
}
|
|
3802
|
+
|
|
3803
|
+
export interface GetMenuItemReportingConsumerV2 {
|
|
3804
|
+
category?: {
|
|
3805
|
+
primary?: string;
|
|
3806
|
+
secondary?: string;
|
|
3807
|
+
};
|
|
3808
|
+
jde_category?: string;
|
|
3809
|
+
}
|
|
3810
|
+
|
|
3811
|
+
export interface GetMenuItemIsConsumerV2 {
|
|
3812
|
+
disabled?: boolean;
|
|
3813
|
+
hidden?: boolean;
|
|
3814
|
+
meq_eligible?: boolean;
|
|
3815
|
+
out_of_stock?: boolean;
|
|
3816
|
+
deleted?: boolean;
|
|
3817
|
+
featured?: boolean;
|
|
3818
|
+
}
|
|
3819
|
+
|
|
3820
|
+
export interface GetMenuItemMenuLabelConsumerV2 {
|
|
3821
|
+
id?: string;
|
|
3822
|
+
text?: string;
|
|
3823
|
+
s3_link?: string;
|
|
3824
|
+
}
|
|
3825
|
+
|
|
3826
|
+
export interface GetMenuItemOptionMetaConsumerV2 {
|
|
3827
|
+
sizing?: {
|
|
3828
|
+
name?: string;
|
|
3829
|
+
posid?: string;
|
|
3830
|
+
price?: number;
|
|
3831
|
+
}[];
|
|
3832
|
+
sort_number?: number;
|
|
3833
|
+
menu_sort_number?: number;
|
|
3834
|
+
unique_id?: number;
|
|
3835
|
+
tax?: {
|
|
3836
|
+
tax_tag_code?: string;
|
|
3837
|
+
};
|
|
3838
|
+
}
|
|
3839
|
+
|
|
3840
|
+
export interface GetMenuItemOptionIsConsumerV2 {
|
|
3841
|
+
disabled?: boolean;
|
|
3842
|
+
hidden?: boolean;
|
|
3843
|
+
out_of_stock?: boolean;
|
|
3844
|
+
}
|
|
3845
|
+
|
|
3846
|
+
export interface GetMenuItemOptionConsumerV2 {
|
|
3847
|
+
id?: string;
|
|
3848
|
+
label?: {
|
|
3849
|
+
en?: string;
|
|
3850
|
+
};
|
|
3851
|
+
name?: string;
|
|
3852
|
+
description?: {
|
|
3853
|
+
en?: string;
|
|
3854
|
+
};
|
|
3855
|
+
price?: GetMenuItemPriceConsumerV2;
|
|
3856
|
+
nutrition?: GetMenuOptionNutritionConsumerV2;
|
|
3857
|
+
meta?: GetMenuItemOptionMetaConsumerV2;
|
|
3858
|
+
image?: GetMenuItemImageConsumerV2;
|
|
3859
|
+
certified?: GetMenuItemCertifiedConsumerV2;
|
|
3860
|
+
is?: GetMenuItemOptionIsConsumerV2;
|
|
3861
|
+
reporting?: GetMenuItemReportingConsumerV2;
|
|
3862
|
+
sku?: number;
|
|
3863
|
+
weight?: {
|
|
3864
|
+
unit?: string;
|
|
3865
|
+
amount?: number;
|
|
3866
|
+
};
|
|
3867
|
+
line_route?: string;
|
|
3868
|
+
amount_off_exclusions?: string[];
|
|
3869
|
+
}
|
|
3870
|
+
|
|
3871
|
+
export interface GetMenuItemGroupIsConsumerV2 {
|
|
3872
|
+
incremental?: boolean;
|
|
3873
|
+
}
|
|
3874
|
+
|
|
3875
|
+
export interface GetMenuItemGroupMetaConsumerV2 {
|
|
3876
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
3877
|
+
sort_number?: number;
|
|
3878
|
+
menu_sort_number?: number;
|
|
3879
|
+
surcharge_limit_value?: number;
|
|
3880
|
+
}
|
|
3881
|
+
|
|
3882
|
+
export interface GetMenuItemOptionsGroupConsumerV2 {
|
|
3883
|
+
id?: string;
|
|
3884
|
+
label?: {
|
|
3885
|
+
en?: string;
|
|
3886
|
+
};
|
|
3887
|
+
items?: GetMenuItemOptionConsumerV2[];
|
|
3888
|
+
min?: number;
|
|
3889
|
+
max?: number;
|
|
3890
|
+
is?: GetMenuItemGroupIsConsumerV2;
|
|
3891
|
+
meta?: GetMenuItemGroupMetaConsumerV2;
|
|
3892
|
+
}
|
|
3893
|
+
|
|
3894
|
+
export interface GetMenuItemRecipeConsumerV2 {
|
|
3895
|
+
smart_tags?: string[];
|
|
3896
|
+
allergen_tags?: string[];
|
|
3897
|
+
mrn?: string;
|
|
3898
|
+
unit_id?: string;
|
|
3899
|
+
portion_quantity?: number;
|
|
3900
|
+
portion_unit_name?: string;
|
|
3901
|
+
grams?: number;
|
|
3902
|
+
cost?: number;
|
|
3903
|
+
ingredients?: string[];
|
|
3904
|
+
}
|
|
3905
|
+
|
|
3906
|
+
export interface GetMenuItemMetaConsumerV2 {
|
|
3907
|
+
barcodes?: string[];
|
|
3908
|
+
recipe?: GetMenuItemRecipeConsumerV2;
|
|
3909
|
+
superplate?: {
|
|
3910
|
+
type_id?: number;
|
|
3911
|
+
type?: string;
|
|
3912
|
+
};
|
|
3913
|
+
sort_number?: number;
|
|
3914
|
+
menu_sort_number?: number;
|
|
3915
|
+
unique_id?: number;
|
|
3916
|
+
tax?: {
|
|
3917
|
+
tax_tag_code?: string;
|
|
3918
|
+
tax_jwo_code?: string;
|
|
3919
|
+
tax_rate?: number;
|
|
3920
|
+
tax_amount?: number;
|
|
3921
|
+
};
|
|
3922
|
+
}
|
|
3923
|
+
|
|
3924
|
+
export interface GetMenuItemConsumerV2 {
|
|
3925
|
+
id?: string;
|
|
3926
|
+
label?: {
|
|
3927
|
+
en?: string;
|
|
3928
|
+
};
|
|
3929
|
+
name?: string;
|
|
3930
|
+
description?: {
|
|
3931
|
+
en?: string;
|
|
3932
|
+
};
|
|
3933
|
+
price?: GetMenuItemPriceConsumerV2;
|
|
3934
|
+
meal_value?: number;
|
|
3935
|
+
sale_price?: GetMenuItemPriceConsumerV2;
|
|
3936
|
+
unit?: number;
|
|
3937
|
+
sku?: number;
|
|
3938
|
+
item_number?: number;
|
|
3939
|
+
parent_id?: string;
|
|
3940
|
+
location?: string;
|
|
3941
|
+
line_route?: string;
|
|
3942
|
+
weight?: {
|
|
3943
|
+
unit?: string;
|
|
3944
|
+
amount?: number;
|
|
3945
|
+
};
|
|
3946
|
+
category?: {
|
|
3947
|
+
en?: string;
|
|
3948
|
+
};
|
|
3949
|
+
ingredients?: Record<string, any>[];
|
|
3950
|
+
amount_off_exclusions?: string[];
|
|
3951
|
+
nutrition?: GetMenuItemNutritionConsumerV2;
|
|
3952
|
+
certified?: GetMenuItemCertifiedConsumerV2;
|
|
3953
|
+
options?: GetMenuItemOptionsGroupConsumerV2[];
|
|
3954
|
+
meta?: GetMenuItemMetaConsumerV2;
|
|
3955
|
+
image?: GetMenuItemImageConsumerV2;
|
|
3956
|
+
is?: GetMenuItemIsConsumerV2;
|
|
3957
|
+
menu_labels?: GetMenuItemMenuLabelConsumerV2[];
|
|
3958
|
+
reporting?: GetMenuItemReportingConsumerV2;
|
|
3959
|
+
}
|
|
3960
|
+
|
|
3961
|
+
export interface GetMenuGroupConsumerV2 {
|
|
3962
|
+
id: string;
|
|
3963
|
+
label?: {
|
|
3964
|
+
en?: string;
|
|
3965
|
+
fr?: string;
|
|
3966
|
+
};
|
|
3967
|
+
items?: GetMenuItemConsumerV2[];
|
|
3968
|
+
}
|
|
3969
|
+
|
|
3970
|
+
export interface GetMenuIsConsumerV2 {
|
|
3971
|
+
disabled?: boolean;
|
|
3972
|
+
hidden?: boolean;
|
|
3973
|
+
linked?: boolean;
|
|
3974
|
+
promo_exemptions_enabled?: boolean;
|
|
3975
|
+
plu_enabled?: boolean;
|
|
3976
|
+
item_images_enabled?: boolean;
|
|
3977
|
+
item_showcase_enabled?: boolean;
|
|
3978
|
+
item_desc_edit_enabled?: boolean;
|
|
3979
|
+
calories_edit_enabled?: boolean;
|
|
3980
|
+
item_label_edit_enabled?: boolean;
|
|
3981
|
+
frictionless?: boolean;
|
|
3982
|
+
category_images_enabled?: boolean;
|
|
3983
|
+
}
|
|
3984
|
+
|
|
3985
|
+
export interface GetMenuMetaConsumerV2 {
|
|
3986
|
+
locked_by_user?: string;
|
|
3987
|
+
last_modified_user?: string;
|
|
3988
|
+
centricos?: boolean;
|
|
3989
|
+
version?: number;
|
|
3990
|
+
revision?: string;
|
|
3991
|
+
}
|
|
3992
|
+
|
|
3993
|
+
export interface GetMenuDateConsumerV2 {
|
|
3994
|
+
created?: string;
|
|
3995
|
+
modified?: string;
|
|
3996
|
+
published?: string;
|
|
3997
|
+
}
|
|
3998
|
+
|
|
3999
|
+
export interface GetMenuImageSizesConsumerV2 {
|
|
4000
|
+
original?: string;
|
|
4001
|
+
thumbnail_80_80?: string;
|
|
4002
|
+
}
|
|
4003
|
+
|
|
4004
|
+
export interface GetMenuImageConsumerV2 {
|
|
4005
|
+
src?: string;
|
|
4006
|
+
sizes?: GetMenuImageSizesConsumerV2;
|
|
4007
|
+
}
|
|
4008
|
+
|
|
4009
|
+
export interface GetMenuResponseConsumerV2 {
|
|
4010
|
+
id: string;
|
|
4011
|
+
label?: {
|
|
4012
|
+
en?: string;
|
|
4013
|
+
};
|
|
4014
|
+
groups?: GetMenuGroupConsumerV2[];
|
|
4015
|
+
parent_id?: string;
|
|
4016
|
+
location_brand?: string;
|
|
4017
|
+
company?: string;
|
|
4018
|
+
sector?: string;
|
|
4019
|
+
date?: GetMenuDateConsumerV2;
|
|
4020
|
+
is?: GetMenuIsConsumerV2;
|
|
4021
|
+
meta?: GetMenuMetaConsumerV2;
|
|
4022
|
+
image?: GetMenuImageConsumerV2;
|
|
4023
|
+
}
|
|
4024
|
+
|
|
4025
|
+
export interface Certified {
|
|
4026
|
+
// Certified vegan
|
|
4027
|
+
vegan?: boolean;
|
|
4028
|
+
// Certified vegetarian
|
|
4029
|
+
vegetarian?: boolean;
|
|
4030
|
+
// Seafood Watch certified (sustainable seafood)
|
|
4031
|
+
seafood_watch?: boolean;
|
|
4032
|
+
// Certified for general wellbeing
|
|
4033
|
+
wellbeing?: boolean;
|
|
4034
|
+
// Farm to Fork certified (locally sourced)
|
|
4035
|
+
farm_to_fork?: boolean;
|
|
4036
|
+
// In Balance certified (nutritionally balanced)
|
|
4037
|
+
in_balance?: boolean;
|
|
4038
|
+
// Certified organic
|
|
4039
|
+
organic?: boolean;
|
|
4040
|
+
// No gluten ingredients present
|
|
4041
|
+
no_gluten_ingredients?: boolean;
|
|
4042
|
+
// Certified halal
|
|
4043
|
+
halal?: boolean;
|
|
4044
|
+
// Certified kosher
|
|
4045
|
+
kosher?: boolean;
|
|
4046
|
+
// Certified humane (animal welfare)
|
|
4047
|
+
humane?: boolean;
|
|
4048
|
+
// Locally crafted product
|
|
4049
|
+
locally_crafted?: boolean;
|
|
4050
|
+
// Contains nuts
|
|
4051
|
+
nuts?: boolean;
|
|
4052
|
+
// Oracle Garden Grown certified
|
|
4053
|
+
oracle_garden_grown?: boolean;
|
|
4054
|
+
// Oracle OYES certified
|
|
4055
|
+
oracle_oyes?: boolean;
|
|
4056
|
+
// Peanut free
|
|
4057
|
+
peanut_free?: boolean;
|
|
4058
|
+
// Tree nut free
|
|
4059
|
+
tree_nut_free?: boolean;
|
|
4060
|
+
// Wheat free
|
|
4061
|
+
wheat_free?: boolean;
|
|
4062
|
+
// Non-GMO certified
|
|
4063
|
+
non_gmo?: boolean;
|
|
4064
|
+
// Milk free
|
|
4065
|
+
milk_free?: boolean;
|
|
4066
|
+
// Egg free
|
|
4067
|
+
egg_free?: boolean;
|
|
4068
|
+
// Soy free
|
|
4069
|
+
soy_free?: boolean;
|
|
4070
|
+
// Fair Trade certified
|
|
4071
|
+
fair_trade?: boolean;
|
|
4072
|
+
// Rainforest Alliance certified
|
|
4073
|
+
rainforest_alliance?: boolean;
|
|
4074
|
+
// Salt free
|
|
4075
|
+
salt_free?: boolean;
|
|
4076
|
+
}
|
|
4077
|
+
|
|
3671
4078
|
// GET /consumer/v1/health-check
|
|
3672
4079
|
|
|
3673
4080
|
export type HealthCheckControllerExecuteResponse = {};
|
|
@@ -3762,12 +4169,33 @@ export type PostFrictionlessQrcodeBody = FrictionlessQrCodeRequest;
|
|
|
3762
4169
|
|
|
3763
4170
|
export type PostFrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
|
|
3764
4171
|
|
|
4172
|
+
// POST /consumer/v2/frictionless/qrCode - Create a QR code for a frictionless checkin
|
|
4173
|
+
|
|
4174
|
+
export type PostConsumerV2FrictionlessQrcodeBody = FrictionlessQrCodeV2Request;
|
|
4175
|
+
|
|
4176
|
+
export type PostConsumerV2FrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
|
|
4177
|
+
|
|
3765
4178
|
// POST /consumer/forgotpassword - Forgot password
|
|
3766
4179
|
|
|
3767
|
-
export type PostConsumerForgotPasswordBody =
|
|
4180
|
+
export type PostConsumerForgotPasswordBody = ForgotPasswordV1Request;
|
|
3768
4181
|
|
|
3769
4182
|
export type PostConsumerForgotPasswordResponse = ForgotPasswordResponse;
|
|
3770
4183
|
|
|
4184
|
+
// POST /consumer/v2/forgotpassword - Forgot password
|
|
4185
|
+
|
|
4186
|
+
export interface PostConsumerV2ForgotPasswordQuery {
|
|
4187
|
+
// hCaptcha response key
|
|
4188
|
+
captchaResponseKey: string;
|
|
4189
|
+
// The realm of the user
|
|
4190
|
+
realm?: string;
|
|
4191
|
+
// The language, e.g. en, fr
|
|
4192
|
+
lang?: string;
|
|
4193
|
+
}
|
|
4194
|
+
|
|
4195
|
+
export type PostConsumerV2ForgotPasswordBody = ForgotPasswordRequest;
|
|
4196
|
+
|
|
4197
|
+
export type PostConsumerV2ForgotPasswordResponse = ForgotPasswordResponse;
|
|
4198
|
+
|
|
3771
4199
|
// POST /consumer/user/{id}/secret/{key} - Add user secret
|
|
3772
4200
|
|
|
3773
4201
|
export interface PostConsumerAddSecretPath {
|
|
@@ -4466,3 +4894,12 @@ export interface GetConsumerLocationQuery {
|
|
|
4466
4894
|
}
|
|
4467
4895
|
|
|
4468
4896
|
export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;
|
|
4897
|
+
|
|
4898
|
+
// GET /consumer/v2/menu/{id} - Get full Menu by ID (v2)
|
|
4899
|
+
|
|
4900
|
+
export interface GetConsumerMenuV2Path {
|
|
4901
|
+
// Menu ID as Encoded CDL ID
|
|
4902
|
+
id: string;
|
|
4903
|
+
}
|
|
4904
|
+
|
|
4905
|
+
export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;
|