@compassdigital/sdk.typescript 4.376.0 → 4.377.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/src/index.ts CHANGED
@@ -1209,6 +1209,8 @@ import {
1209
1209
  GetConsumerLocationMultigroupResponse,
1210
1210
  GetConsumerActiveMenusQuery,
1211
1211
  GetConsumerActiveMenusResponse,
1212
+ GetConsumerMenuRecommendedItemsQuery,
1213
+ GetConsumerMenuRecommendedItemsResponse$0,
1212
1214
  GetConsumerMenuQuery,
1213
1215
  GetConsumerMenuResponse,
1214
1216
  GetConsumerMenuItemsQuery,
@@ -13212,6 +13214,28 @@ export class ServiceClient extends BaseServiceClient {
13212
13214
  );
13213
13215
  }
13214
13216
 
13217
+ /**
13218
+ * GET /consumer/menu/{id}/recommended - Get recommended menu items
13219
+ *
13220
+ * @param id - Menu ID as Encoded CDL ID
13221
+ * @param options - additional request options
13222
+ */
13223
+ get_consumer_menu_recommended_items(
13224
+ id: string,
13225
+ options?: {
13226
+ query?: GetConsumerMenuRecommendedItemsQuery;
13227
+ } & RequestOptions,
13228
+ ): ResponsePromise<GetConsumerMenuRecommendedItemsResponse$0> {
13229
+ return this.request(
13230
+ 'consumer',
13231
+ '/consumer/menu/{id}/recommended',
13232
+ 'GET',
13233
+ `/consumer/menu/${id}/recommended`,
13234
+ null,
13235
+ options,
13236
+ );
13237
+ }
13238
+
13215
13239
  /**
13216
13240
  * GET /consumer/menu/{id} - Get full Menu by ID
13217
13241
  *
@@ -1508,6 +1508,172 @@ export interface ConsumerGetActiveMenusResponse {
1508
1508
  menus: ConsumerMenuHours[];
1509
1509
  }
1510
1510
 
1511
+ export interface ConsumerOption {
1512
+ // Metadata for the option
1513
+ meta?: Record<string, any>;
1514
+ id?: string;
1515
+ label?: {
1516
+ en?: string;
1517
+ };
1518
+ name?: string;
1519
+ description?: {
1520
+ en?: string;
1521
+ };
1522
+ price?: {
1523
+ amount?: number;
1524
+ currency?: string;
1525
+ };
1526
+ reporting?: {
1527
+ category: {
1528
+ primary?: string;
1529
+ secondary?: string;
1530
+ };
1531
+ };
1532
+ weight?: {
1533
+ unit?: string;
1534
+ amount?: number;
1535
+ };
1536
+ image?: {
1537
+ src?: string;
1538
+ sizes: {
1539
+ original?: string;
1540
+ thumbnail_80_80?: string;
1541
+ };
1542
+ };
1543
+ sku?: number;
1544
+ nutrition?: {
1545
+ kcal?: number;
1546
+ calories?: Record<string, any>;
1547
+ };
1548
+ certified?: {
1549
+ vegan?: boolean;
1550
+ };
1551
+ is?: {
1552
+ disabled?: boolean;
1553
+ hidden?: boolean;
1554
+ out_of_stock?: boolean;
1555
+ };
1556
+ amount_off_exclusions?: Record<string, any>[];
1557
+ line_route?: string;
1558
+ }
1559
+
1560
+ export interface ConsumerOptionsGroup {
1561
+ // Metadata for the options group
1562
+ meta?: Record<string, any>;
1563
+ id?: string;
1564
+ label?: {
1565
+ en?: string;
1566
+ };
1567
+ unique_name?: string;
1568
+ name?: string;
1569
+ items?: ConsumerOption[];
1570
+ min?: number;
1571
+ max?: number;
1572
+ is?: {
1573
+ disabled?: boolean;
1574
+ hidden?: boolean;
1575
+ out_of_stock?: boolean;
1576
+ incremental?: boolean;
1577
+ surcharge_limit?: boolean;
1578
+ };
1579
+ limit?: number;
1580
+ }
1581
+
1582
+ export interface ConsumerItem {
1583
+ // Metadata for the item
1584
+ meta?: Record<string, any>;
1585
+ id?: string;
1586
+ label?: {
1587
+ en?: string;
1588
+ };
1589
+ name?: string;
1590
+ description?: {
1591
+ en?: string;
1592
+ };
1593
+ price?: {
1594
+ amount?: number;
1595
+ currency?: string;
1596
+ total_price?: number;
1597
+ discount?: number;
1598
+ };
1599
+ meal_value?: number;
1600
+ sale_price?: {
1601
+ amount?: number;
1602
+ currency?: string;
1603
+ };
1604
+ unit?: number;
1605
+ ingredients?: Record<string, any>[];
1606
+ amount_off_exclusions?: Record<string, any>[];
1607
+ certified?: {
1608
+ vegan?: boolean;
1609
+ vegetarian?: boolean;
1610
+ seafood_watch?: boolean;
1611
+ wellbeing?: boolean;
1612
+ farm_to_fork?: boolean;
1613
+ in_balance?: boolean;
1614
+ organic?: boolean;
1615
+ no_gluten_ingredients?: boolean;
1616
+ halal?: boolean;
1617
+ kosher?: boolean;
1618
+ humane?: boolean;
1619
+ locally_crafted?: boolean;
1620
+ nuts?: boolean;
1621
+ oracle_garden_grown?: boolean;
1622
+ oracle_oyes?: boolean;
1623
+ peanut_free?: boolean;
1624
+ tree_nut_free?: boolean;
1625
+ wheat_free?: boolean;
1626
+ non_gmo?: boolean;
1627
+ milk_free?: boolean;
1628
+ egg_free?: boolean;
1629
+ soy_free?: boolean;
1630
+ fair_trade?: boolean;
1631
+ rainforest_alliance?: boolean;
1632
+ salt_free?: boolean;
1633
+ };
1634
+ options?: ConsumerOptionsGroup[];
1635
+ required?: boolean;
1636
+ special?: boolean;
1637
+ category?: {
1638
+ en?: string;
1639
+ };
1640
+ location?: string;
1641
+ sku?: number;
1642
+ item_number?: number;
1643
+ image?: {
1644
+ src?: string;
1645
+ sizes: {
1646
+ original?: string;
1647
+ thumbnail_80_80?: string;
1648
+ };
1649
+ };
1650
+ weight?: {
1651
+ unit?: string;
1652
+ amount?: number;
1653
+ };
1654
+ line_route?: string;
1655
+ reporting?: {
1656
+ category: {
1657
+ primary?: string;
1658
+ secondary?: string;
1659
+ };
1660
+ };
1661
+ is_deleted?: boolean;
1662
+ is?: {
1663
+ disabled?: boolean;
1664
+ hidden?: boolean;
1665
+ meq_eligible?: boolean;
1666
+ out_of_stock?: boolean;
1667
+ deleted?: boolean;
1668
+ featured?: boolean;
1669
+ };
1670
+ }
1671
+
1672
+ export interface GetConsumerMenuRecommendedItemsResponse {
1673
+ // items
1674
+ items: ConsumerItem[];
1675
+ }
1676
+
1511
1677
  export interface GetMenuLabelConsumer {
1512
1678
  // English
1513
1679
  en?: string;
@@ -1738,167 +1904,6 @@ export interface GetMenuResponseConsumer {
1738
1904
  parent_id?: string;
1739
1905
  }
1740
1906
 
1741
- export interface ConsumerOption {
1742
- // Metadata for the option
1743
- meta?: Record<string, any>;
1744
- id?: string;
1745
- label?: {
1746
- en?: string;
1747
- };
1748
- name?: string;
1749
- description?: {
1750
- en?: string;
1751
- };
1752
- price?: {
1753
- amount?: number;
1754
- currency?: string;
1755
- };
1756
- reporting?: {
1757
- category: {
1758
- primary?: string;
1759
- secondary?: string;
1760
- };
1761
- };
1762
- weight?: {
1763
- unit?: string;
1764
- amount?: number;
1765
- };
1766
- image?: {
1767
- src?: string;
1768
- sizes: {
1769
- original?: string;
1770
- thumbnail_80_80?: string;
1771
- };
1772
- };
1773
- sku?: number;
1774
- nutrition?: {
1775
- kcal?: number;
1776
- calories?: Record<string, any>;
1777
- };
1778
- certified?: {
1779
- vegan?: boolean;
1780
- };
1781
- is?: {
1782
- disabled?: boolean;
1783
- hidden?: boolean;
1784
- out_of_stock?: boolean;
1785
- };
1786
- amount_off_exclusions?: Record<string, any>[];
1787
- line_route?: string;
1788
- }
1789
-
1790
- export interface ConsumerOptionsGroup {
1791
- // Metadata for the options group
1792
- meta?: Record<string, any>;
1793
- id?: string;
1794
- label?: {
1795
- en?: string;
1796
- };
1797
- unique_name?: string;
1798
- name?: string;
1799
- items?: ConsumerOption[];
1800
- min?: number;
1801
- max?: number;
1802
- is?: {
1803
- disabled?: boolean;
1804
- hidden?: boolean;
1805
- out_of_stock?: boolean;
1806
- incremental?: boolean;
1807
- surcharge_limit?: boolean;
1808
- };
1809
- limit?: number;
1810
- }
1811
-
1812
- export interface ConsumerItem {
1813
- // Metadata for the item
1814
- meta?: Record<string, any>;
1815
- id?: string;
1816
- label?: {
1817
- en?: string;
1818
- };
1819
- name?: string;
1820
- description?: {
1821
- en?: string;
1822
- };
1823
- price?: {
1824
- amount?: number;
1825
- currency?: string;
1826
- total_price?: number;
1827
- discount?: number;
1828
- };
1829
- meal_value?: number;
1830
- sale_price?: {
1831
- amount?: number;
1832
- currency?: string;
1833
- };
1834
- unit?: number;
1835
- ingredients?: Record<string, any>[];
1836
- amount_off_exclusions?: Record<string, any>[];
1837
- certified?: {
1838
- vegan?: boolean;
1839
- vegetarian?: boolean;
1840
- seafood_watch?: boolean;
1841
- wellbeing?: boolean;
1842
- farm_to_fork?: boolean;
1843
- in_balance?: boolean;
1844
- organic?: boolean;
1845
- no_gluten_ingredients?: boolean;
1846
- halal?: boolean;
1847
- kosher?: boolean;
1848
- humane?: boolean;
1849
- locally_crafted?: boolean;
1850
- nuts?: boolean;
1851
- oracle_garden_grown?: boolean;
1852
- oracle_oyes?: boolean;
1853
- peanut_free?: boolean;
1854
- tree_nut_free?: boolean;
1855
- wheat_free?: boolean;
1856
- non_gmo?: boolean;
1857
- milk_free?: boolean;
1858
- egg_free?: boolean;
1859
- soy_free?: boolean;
1860
- fair_trade?: boolean;
1861
- rainforest_alliance?: boolean;
1862
- salt_free?: boolean;
1863
- };
1864
- options?: ConsumerOptionsGroup[];
1865
- required?: boolean;
1866
- special?: boolean;
1867
- category?: {
1868
- en?: string;
1869
- };
1870
- location?: string;
1871
- sku?: number;
1872
- item_number?: number;
1873
- image?: {
1874
- src?: string;
1875
- sizes: {
1876
- original?: string;
1877
- thumbnail_80_80?: string;
1878
- };
1879
- };
1880
- weight?: {
1881
- unit?: string;
1882
- amount?: number;
1883
- };
1884
- line_route?: string;
1885
- reporting?: {
1886
- category: {
1887
- primary?: string;
1888
- secondary?: string;
1889
- };
1890
- };
1891
- is_deleted?: boolean;
1892
- is?: {
1893
- disabled?: boolean;
1894
- hidden?: boolean;
1895
- meq_eligible?: boolean;
1896
- out_of_stock?: boolean;
1897
- deleted?: boolean;
1898
- featured?: boolean;
1899
- };
1900
- }
1901
-
1902
1907
  export interface GetConsumerMenuItemsResponse {
1903
1908
  // meta
1904
1909
  meta?: Record<string, any>;
@@ -2948,7 +2953,7 @@ export interface PostConsumerShoppingCartCloneBodyRequest {
2948
2953
 
2949
2954
  export interface PostCustomerRewardsBodyDTO {
2950
2955
  // The shoppingcart brands
2951
- shoppingcart_brands?: string[];
2956
+ shoppingcartBrands?: string[];
2952
2957
  }
2953
2958
 
2954
2959
  export interface ConsumerRewardWindowDTO {
@@ -3355,6 +3360,22 @@ export interface GetConsumerActiveMenusQuery {
3355
3360
 
3356
3361
  export type GetConsumerActiveMenusResponse = ConsumerGetActiveMenusResponse;
3357
3362
 
3363
+ // GET /consumer/menu/{id}/recommended - Get recommended menu items
3364
+
3365
+ export interface GetConsumerMenuRecommendedItemsPath {
3366
+ // Menu ID as Encoded CDL ID
3367
+ id: string;
3368
+ }
3369
+
3370
+ export interface GetConsumerMenuRecommendedItemsQuery {
3371
+ // Comma-separated list of item IDs to exclude from recommendations
3372
+ excludedItems?: string;
3373
+ // Graphql query string
3374
+ _query?: string;
3375
+ }
3376
+
3377
+ export type GetConsumerMenuRecommendedItemsResponse$0 = GetConsumerMenuRecommendedItemsResponse;
3378
+
3358
3379
  // GET /consumer/menu/{id} - Get full Menu by ID
3359
3380
 
3360
3381
  export interface GetConsumerMenuPath {