@compassdigital/sdk.typescript 3.76.0 → 3.77.1

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.js CHANGED
@@ -362,25 +362,6 @@ class ServiceClient extends base_1.BaseServiceClient {
362
362
  patch_location(id, body, options) {
363
363
  return this.request("location", "patch_location", "patch", `/location/${id}`, body, options);
364
364
  }
365
- /**
366
- * GET /location/pos/{id} - Get information about a POS
367
- *
368
- * @param id - POS ID
369
- * @param options - additional request options
370
- */
371
- get_location_pos(id, options) {
372
- return this.request("location", "get_location_pos", "get", `/location/pos/${id}`, null, options);
373
- }
374
- /**
375
- * PUT /location/pos/{id} - Set information about a POS
376
- *
377
- * @param id - POS ID
378
- * @param body
379
- * @param options - additional request options
380
- */
381
- put_location_pos(id, body, options) {
382
- return this.request("location", "put_location_pos", "put", `/location/pos/${id}`, body, options);
383
- }
384
365
  /**
385
366
  * GET /location/multigroup - Get all the top level multigroups
386
367
  *
@@ -544,16 +525,6 @@ class ServiceClient extends base_1.BaseServiceClient {
544
525
  get_location_group_deliverydestination(id, delivery_destination, options) {
545
526
  return this.request("location", "get_location_group_deliverydestination", "get", `/location/group/${id}/deliverydestination/${delivery_destination}`, null, options);
546
527
  }
547
- /**
548
- * GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
549
- *
550
- * @param id - group
551
- * @param user_id - user
552
- * @param options - additional request options
553
- */
554
- get_location_user_group(id, user_id, options) {
555
- return this.request("location", "get_location_user_group", "get", `/location/group/${id}/user/${user_id}`, null, options);
556
- }
557
528
  /**
558
529
  * GET /location/brands - Get all location brands
559
530
  *
@@ -571,43 +542,6 @@ class ServiceClient extends base_1.BaseServiceClient {
571
542
  get_location_brand_destinations(id, options) {
572
543
  return this.request("location", "get_location_brand_destinations", "get", `/location/brand/${id}/deliverydestinations`, null, options);
573
544
  }
574
- /**
575
- * POST /location/brand/{id}/document - Attach document to a brand
576
- *
577
- * @param id - Brand ID
578
- * @param body
579
- * @param options - additional request options
580
- */
581
- post_location_brand_document(id, body, options) {
582
- return this.request("location", "post_location_brand_document", "post", `/location/brand/${id}/document`, body, options);
583
- }
584
- /**
585
- * PATCH /location/brand/{id}/document - Edit location document
586
- *
587
- * @param id - Brand ID
588
- * @param options - additional request options
589
- */
590
- patch_location_brand_document(id, options) {
591
- return this.request("location", "patch_location_brand_document", "patch", `/location/brand/${id}/document`, null, options);
592
- }
593
- /**
594
- * DELETE /location/brand/{id}/document - Deleted brand document
595
- *
596
- * @param id - Brand ID
597
- * @param options - additional request options
598
- */
599
- delete_location_brand_document(id, options) {
600
- return this.request("location", "delete_location_brand_document", "delete", `/location/brand/${id}/document`, null, options);
601
- }
602
- /**
603
- * GET /location/brand/{id}/documents - Get location brand attached documents
604
- *
605
- * @param id - Brand ID
606
- * @param options - additional request options
607
- */
608
- get_location_brand_documents(id, options) {
609
- return this.request("location", "get_location_brand_documents", "get", `/location/brand/${id}/documents`, null, options);
610
- }
611
545
  /**
612
546
  * GET /location/brand/{id}/timeslots - Get location brand timeslots
613
547
  *
@@ -792,6 +726,24 @@ class ServiceClient extends base_1.BaseServiceClient {
792
726
  get_location_v2_groups(options) {
793
727
  return this.request("location", "get_location_v2_groups", "get", `/location/v2/groups`, null, options);
794
728
  }
729
+ /**
730
+ * GET /location/menu_association/{id}/brand - Get menu association for a brand
731
+ *
732
+ * @param id - brand id
733
+ * @param options - additional request options
734
+ */
735
+ get_location_menu_association_brand(id, options) {
736
+ return this.request("location", "get_location_menu_association_brand", "get", `/location/menu_association/${id}/brand`, null, options);
737
+ }
738
+ /**
739
+ * GET /location/menu_association/{id}/menu - Get menu association for a brand
740
+ *
741
+ * @param id - menu id
742
+ * @param options - additional request options
743
+ */
744
+ get_location_menu_association_menu(id, options) {
745
+ return this.request("location", "get_location_menu_association_menu", "get", `/location/menu_association/${id}/menu`, null, options);
746
+ }
795
747
  /**
796
748
  * POST /shoppingcart/ - Create a new ShoppingCart
797
749
  *
@@ -1255,8 +1207,8 @@ class ServiceClient extends base_1.BaseServiceClient {
1255
1207
  *
1256
1208
  * @param options - additional request options
1257
1209
  */
1258
- get_swagger(options) {
1259
- return this.request("datalake", "get_swagger", "get", `/swagger.json`, null, options);
1210
+ get_datalake_swagger(options) {
1211
+ return this.request("datalake", "get_datalake_swagger", "get", `/swagger.json`, null, options);
1260
1212
  }
1261
1213
  /**
1262
1214
  * POST /promo - Create a new promotion
@@ -1380,7 +1332,7 @@ class ServiceClient extends base_1.BaseServiceClient {
1380
1332
  /**
1381
1333
  * POST /promo/voucher/{id}/reverse - Reverse a redemption from a promo voucher
1382
1334
  *
1383
- * @param id - TODO: add parameter to swagger.json
1335
+ * @param id - For FP: order request ID (`requestID` from the FP invoice service)
1384
1336
  * @param body
1385
1337
  * @param options - additional request options
1386
1338
  */
@@ -1989,8 +1941,8 @@ class ServiceClient extends base_1.BaseServiceClient {
1989
1941
  * @param body
1990
1942
  * @param options - additional request options
1991
1943
  */
1992
- post_menu(body, options) {
1993
- return this.request("menu", "post_menu", "post", `/menu`, body, options);
1944
+ create_menu(body, options) {
1945
+ return this.request("menu", "create_menu", "post", `/menu`, body, options);
1994
1946
  }
1995
1947
  /**
1996
1948
  * HEAD /menu/{id} - Get an individual Menu
@@ -1998,8 +1950,8 @@ class ServiceClient extends base_1.BaseServiceClient {
1998
1950
  * @param id - menu
1999
1951
  * @param options - additional request options
2000
1952
  */
2001
- head_menu(id, options) {
2002
- return this.request("menu", "head_menu", "head", `/menu/${id}`, null, options);
1953
+ get_menu_headers(id, options) {
1954
+ return this.request("menu", "get_menu_headers", "head", `/menu/${id}`, null, options);
2003
1955
  }
2004
1956
  /**
2005
1957
  * GET /menu/{id} - Get an individual Menu
@@ -2017,8 +1969,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2017
1969
  * @param body
2018
1970
  * @param options - additional request options
2019
1971
  */
2020
- put_menu(id, body, options) {
2021
- return this.request("menu", "put_menu", "put", `/menu/${id}`, body, options);
1972
+ update_menu(id, body, options) {
1973
+ return this.request("menu", "update_menu", "put", `/menu/${id}`, body, options);
2022
1974
  }
2023
1975
  /**
2024
1976
  * DELETE /menu/{id} - Delete a Menu
@@ -2045,8 +1997,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2045
1997
  * @param body
2046
1998
  * @param options - additional request options
2047
1999
  */
2048
- post_menu_import_menu(body, options) {
2049
- return this.request("menu", "post_menu_import_menu", "post", `/menu/import`, body, options);
2000
+ import_menu(body, options) {
2001
+ return this.request("menu", "import_menu", "post", `/menu/import`, body, options);
2050
2002
  }
2051
2003
  /**
2052
2004
  * GET /menu/item/{id} - Get menu item
@@ -2054,8 +2006,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2054
2006
  * @param id - Item ID
2055
2007
  * @param options - additional request options
2056
2008
  */
2057
- get_menu_item(id, options) {
2058
- return this.request("menu", "get_menu_item", "get", `/menu/item/${id}`, null, options);
2009
+ get_item(id, options) {
2010
+ return this.request("menu", "get_item", "get", `/menu/item/${id}`, null, options);
2059
2011
  }
2060
2012
  /**
2061
2013
  * DELETE /menu/item/{id} - Delete a menu item
@@ -2063,8 +2015,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2063
2015
  * @param id - Item ID
2064
2016
  * @param options - additional request options
2065
2017
  */
2066
- delete_menu_item(id, options) {
2067
- return this.request("menu", "delete_menu_item", "delete", `/menu/item/${id}`, null, options);
2018
+ delete_item(id, options) {
2019
+ return this.request("menu", "delete_item", "delete", `/menu/item/${id}`, null, options);
2068
2020
  }
2069
2021
  /**
2070
2022
  * POST /menu/item - Create a menu item
@@ -2072,8 +2024,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2072
2024
  * @param body
2073
2025
  * @param options - additional request options
2074
2026
  */
2075
- post_menu_item(body, options) {
2076
- return this.request("menu", "post_menu_item", "post", `/menu/item`, body, options);
2027
+ create_item(body, options) {
2028
+ return this.request("menu", "create_item", "post", `/menu/item`, body, options);
2077
2029
  }
2078
2030
  /**
2079
2031
  * GET /menu/items - Search for menu items
@@ -2089,8 +2041,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2089
2041
  * @param location - Location ID
2090
2042
  * @param options - additional request options
2091
2043
  */
2092
- post_menu_import_items_canteen(location, options) {
2093
- return this.request("menu", "post_menu_import_items_canteen", "post", `/menu/items/import/${location}`, null, options);
2044
+ import_items_canteen(location, options) {
2045
+ return this.request("menu", "import_items_canteen", "post", `/menu/items/import/${location}`, null, options);
2094
2046
  }
2095
2047
  /**
2096
2048
  * GET /menu/items/location/{location} - Get all menu items for a location
@@ -2098,8 +2050,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2098
2050
  * @param location - Location ID
2099
2051
  * @param options - additional request options
2100
2052
  */
2101
- get_menu_location_items(location, options) {
2102
- return this.request("menu", "get_menu_location_items", "get", `/menu/items/location/${location}`, null, options);
2053
+ get_location_items(location, options) {
2054
+ return this.request("menu", "get_location_items", "get", `/menu/items/location/${location}`, null, options);
2103
2055
  }
2104
2056
  /**
2105
2057
  * GET /menu/item/random/location/{location} - Get a random item
@@ -2107,8 +2059,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2107
2059
  * @param location - Location ID
2108
2060
  * @param options - additional request options
2109
2061
  */
2110
- get_menu_location_item_random(location, options) {
2111
- return this.request("menu", "get_menu_location_item_random", "get", `/menu/item/random/location/${location}`, null, options);
2062
+ get_location_item_random(location, options) {
2063
+ return this.request("menu", "get_location_item_random", "get", `/menu/item/random/location/${location}`, null, options);
2112
2064
  }
2113
2065
  /**
2114
2066
  * GET /menu/items/random/location/{location} - Get a set of random items
@@ -2116,8 +2068,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2116
2068
  * @param location - Location ID
2117
2069
  * @param options - additional request options
2118
2070
  */
2119
- get_menu_location_items_random(location, options) {
2120
- return this.request("menu", "get_menu_location_items_random", "get", `/menu/items/random/location/${location}`, null, options);
2071
+ get_location_items_random(location, options) {
2072
+ return this.request("menu", "get_location_items_random", "get", `/menu/items/random/location/${location}`, null, options);
2121
2073
  }
2122
2074
  /**
2123
2075
  * GET /menu/sector/{sector} - Get menus that belong to sector
@@ -2125,8 +2077,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2125
2077
  * @param sector - Sector ID
2126
2078
  * @param options - additional request options
2127
2079
  */
2128
- get_menu_sector_menus(sector, options) {
2129
- return this.request("menu", "get_menu_sector_menus", "get", `/menu/sector/${sector}`, null, options);
2080
+ get_sector_menus(sector, options) {
2081
+ return this.request("menu", "get_sector_menus", "get", `/menu/sector/${sector}`, null, options);
2130
2082
  }
2131
2083
  /**
2132
2084
  * GET /menu/company/{company} - Get menus that belong to company
@@ -2134,8 +2086,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2134
2086
  * @param company - Company ID
2135
2087
  * @param options - additional request options
2136
2088
  */
2137
- get_menu_company_menus(company, options) {
2138
- return this.request("menu", "get_menu_company_menus", "get", `/menu/company/${company}`, null, options);
2089
+ get_company_menus(company, options) {
2090
+ return this.request("menu", "get_company_menus", "get", `/menu/company/${company}`, null, options);
2139
2091
  }
2140
2092
  /**
2141
2093
  * POST /menu/modifier/group - Create a new Menu Modifier Group
@@ -2143,8 +2095,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2143
2095
  * @param body
2144
2096
  * @param options - additional request options
2145
2097
  */
2146
- post_menu_modifier_group(body, options) {
2147
- return this.request("menu", "post_menu_modifier_group", "post", `/menu/modifier/group`, body, options);
2098
+ create_modifier_group(body, options) {
2099
+ return this.request("menu", "create_modifier_group", "post", `/menu/modifier/group`, body, options);
2148
2100
  }
2149
2101
  /**
2150
2102
  * GET /menu/modifier/group/{id} - Get a Menu Modifier Group
@@ -2152,8 +2104,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2152
2104
  * @param id - modifier_group
2153
2105
  * @param options - additional request options
2154
2106
  */
2155
- get_menu_modifier_group(id, options) {
2156
- return this.request("menu", "get_menu_modifier_group", "get", `/menu/modifier/group/${id}`, null, options);
2107
+ get_modifier_group(id, options) {
2108
+ return this.request("menu", "get_modifier_group", "get", `/menu/modifier/group/${id}`, null, options);
2157
2109
  }
2158
2110
  /**
2159
2111
  * PUT /menu/modifier/group/{id} - Update a Menu Modifier Group
@@ -2162,8 +2114,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2162
2114
  * @param body
2163
2115
  * @param options - additional request options
2164
2116
  */
2165
- put_menu_modifier_group(id, body, options) {
2166
- return this.request("menu", "put_menu_modifier_group", "put", `/menu/modifier/group/${id}`, body, options);
2117
+ update_modifier_group(id, body, options) {
2118
+ return this.request("menu", "update_modifier_group", "put", `/menu/modifier/group/${id}`, body, options);
2167
2119
  }
2168
2120
  /**
2169
2121
  * DELETE /menu/modifier/group/{id} - Delete a Menu Modifier Group
@@ -2171,8 +2123,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2171
2123
  * @param id - modifier_group
2172
2124
  * @param options - additional request options
2173
2125
  */
2174
- delete_menu_modifier_group(id, options) {
2175
- return this.request("menu", "delete_menu_modifier_group", "delete", `/menu/modifier/group/${id}`, null, options);
2126
+ delete_modifier_group(id, options) {
2127
+ return this.request("menu", "delete_modifier_group", "delete", `/menu/modifier/group/${id}`, null, options);
2176
2128
  }
2177
2129
  /**
2178
2130
  * GET /menu/modifier/group/company/{company} - Get the modifier groups that belong to company
@@ -2180,8 +2132,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2180
2132
  * @param company - Company ID
2181
2133
  * @param options - additional request options
2182
2134
  */
2183
- get_menu_company_modifier_groups(company, options) {
2184
- return this.request("menu", "get_menu_company_modifier_groups", "get", `/menu/modifier/group/company/${company}`, null, options);
2135
+ get_company_modifier_groups(company, options) {
2136
+ return this.request("menu", "get_company_modifier_groups", "get", `/menu/modifier/group/company/${company}`, null, options);
2185
2137
  }
2186
2138
  /**
2187
2139
  * GET /menu/modifier/group/company/{company}/export - Export company modifier groups to zipped excel file.
@@ -2189,8 +2141,8 @@ class ServiceClient extends base_1.BaseServiceClient {
2189
2141
  * @param company - Company ID
2190
2142
  * @param options - additional request options
2191
2143
  */
2192
- get_menu_company_modifier_groups_export(company, options) {
2193
- return this.request("menu", "get_menu_company_modifier_groups_export", "get", `/menu/modifier/group/company/${company}/export`, null, options);
2144
+ get_company_modifier_groups_export(company, options) {
2145
+ return this.request("menu", "get_company_modifier_groups_export", "get", `/menu/modifier/group/company/${company}/export`, null, options);
2194
2146
  }
2195
2147
  /**
2196
2148
  * GET /menu/{id}/export - Export menu set to zipped excel file.
@@ -2926,29 +2878,29 @@ class ServiceClient extends base_1.BaseServiceClient {
2926
2878
  return this.request("menu", "get_menu_v3_draft_category_relationships_items_count", "get", `/menu/v3/draft/category/relationships/items/count`, null, options);
2927
2879
  }
2928
2880
  /**
2929
- * GET /menu/v3/category/relationships/modifier-group/{id}
2881
+ * GET /menu/v3/category/relationships/item/{id}
2930
2882
  *
2931
2883
  * @param id
2932
2884
  * @param options - additional request options
2933
2885
  */
2934
- get_menu_v3_category_relationships_modifier_group(id, options) {
2935
- return this.request("menu", "get_menu_v3_category_relationships_modifier_group", "get", `/menu/v3/category/relationships/modifier-group/${id}`, null, options);
2886
+ get_menu_v3_category_relationships_item(id, options) {
2887
+ return this.request("menu", "get_menu_v3_category_relationships_item", "get", `/menu/v3/category/relationships/item/${id}`, null, options);
2936
2888
  }
2937
2889
  /**
2938
- * GET /menu/v3/category/relationships/modifier-groups
2890
+ * GET /menu/v3/category/relationships/items
2939
2891
  *
2940
2892
  * @param options - additional request options
2941
2893
  */
2942
- get_menu_v3_category_relationships_modifier_groups(options) {
2943
- return this.request("menu", "get_menu_v3_category_relationships_modifier_groups", "get", `/menu/v3/category/relationships/modifier-groups`, null, options);
2894
+ get_menu_v3_category_relationships_items(options) {
2895
+ return this.request("menu", "get_menu_v3_category_relationships_items", "get", `/menu/v3/category/relationships/items`, null, options);
2944
2896
  }
2945
2897
  /**
2946
- * GET /menu/v3/category/relationships/modifier-groups/count
2898
+ * GET /menu/v3/category/relationships/items/count
2947
2899
  *
2948
2900
  * @param options - additional request options
2949
2901
  */
2950
- get_menu_v3_category_relationships_modifier_groups_count(options) {
2951
- return this.request("menu", "get_menu_v3_category_relationships_modifier_groups_count", "get", `/menu/v3/category/relationships/modifier-groups/count`, null, options);
2902
+ get_menu_v3_category_relationships_items_count(options) {
2903
+ return this.request("menu", "get_menu_v3_category_relationships_items_count", "get", `/menu/v3/category/relationships/items/count`, null, options);
2952
2904
  }
2953
2905
  /**
2954
2906
  * POST /menu/v3/draft/item
@@ -3704,6 +3656,77 @@ class ServiceClient extends base_1.BaseServiceClient {
3704
3656
  post_delivery_availability(id, body, options) {
3705
3657
  return this.request("delivery", "post_delivery_availability", "post", `/delivery/${id}/availability`, body, options);
3706
3658
  }
3659
+ /**
3660
+ * POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
3661
+ *
3662
+ * @param body
3663
+ * @param options - additional request options
3664
+ */
3665
+ StandardCognitionEventWebhookController_execute(body, options) {
3666
+ return this.request("frictionless", "StandardCognitionEventWebhookController_execute", "post", `/frictionless/webhook/standardcognition`, body, options);
3667
+ }
3668
+ /**
3669
+ * GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
3670
+ *
3671
+ * @param id_brand - Brand ID as Encoded CDL ID
3672
+ * @param options - additional request options
3673
+ */
3674
+ CheckFrictionlessSupportController_execute(id_brand, options) {
3675
+ return this.request("frictionless", "CheckFrictionlessSupportController_execute", "get", `/frictionless/brand/${id_brand}/frictionless-status`, null, options);
3676
+ }
3677
+ /**
3678
+ * POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
3679
+ *
3680
+ * @param body
3681
+ * @param options - additional request options
3682
+ */
3683
+ CreateQRCodeUserCheckInController_execute(body, options) {
3684
+ return this.request("frictionless", "CreateQRCodeUserCheckInController_execute", "post", `/frictionless/qrcode`, body, options);
3685
+ }
3686
+ /**
3687
+ * GET /frictionless/failed-checkins - List check-ins on error
3688
+ *
3689
+ * @param options - additional request options
3690
+ */
3691
+ ListFailedCheckinsController_execute(options) {
3692
+ return this.request("frictionless", "ListFailedCheckinsController_execute", "get", `/frictionless/failed-checkins`, null, options);
3693
+ }
3694
+ /**
3695
+ * POST /frictionless/checkin/{id_checkin}/reprocess - Reprocess checkin on error
3696
+ *
3697
+ * @param id_checkin - TODO: add parameter to swagger.json
3698
+ * @param options - additional request options
3699
+ */
3700
+ ReprocessCheckinOnErrorController_execute(id_checkin, options) {
3701
+ return this.request("frictionless", "ReprocessCheckinOnErrorController_execute", "post", `/frictionless/checkin/${id_checkin}/reprocess`, null, options);
3702
+ }
3703
+ /**
3704
+ * GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn status
3705
+ *
3706
+ * @param id_checkin - TODO: add parameter to swagger.json
3707
+ * @param options - additional request options
3708
+ */
3709
+ CheckCheckinStatusController_execute(id_checkin, options) {
3710
+ return this.request("frictionless", "CheckCheckinStatusController_execute", "get", `/frictionless/checkin/${id_checkin}/status`, null, options);
3711
+ }
3712
+ /**
3713
+ * POST /ai/language/generate - Generate text from a given prompt
3714
+ *
3715
+ * @param body
3716
+ * @param options - additional request options
3717
+ */
3718
+ post_ai_language_generate(body, options) {
3719
+ return this.request("ai", "post_ai_language_generate", "post", `/ai/language/generate`, body, options);
3720
+ }
3721
+ /**
3722
+ * POST /ai/image/generate - Generate image from a given prompt
3723
+ *
3724
+ * @param body
3725
+ * @param options - additional request options
3726
+ */
3727
+ post_ai_image_generate(body, options) {
3728
+ return this.request("ai", "post_ai_image_generate", "post", `/ai/image/generate`, body, options);
3729
+ }
3707
3730
  }
3708
3731
  exports.ServiceClient = ServiceClient;
3709
3732
  //# sourceMappingURL=index.js.map