@wix/auto_sdk_restaurants_menus 1.0.77 → 1.0.78

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.
@@ -51,6 +51,12 @@ interface Menu {
51
51
  urlQueryParam?: string | null;
52
52
  /** Custom SEO data for the menu. */
53
53
  seoData?: SeoSchema;
54
+ /**
55
+ * Information about the business location where this menu is available. This information is taken from the `Location` object ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations)) corresponding with this menu's `businessLocationId`.
56
+ * @internal
57
+ * @readonly
58
+ */
59
+ businessLocationDetails?: BusinessLocationDetails;
54
60
  /**
55
61
  * ID of the business location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations)) where this menu is available.
56
62
  * @format GUID
@@ -58,6 +64,17 @@ interface Menu {
58
64
  * @readonly
59
65
  */
60
66
  businessLocationId?: string | null;
67
+ /**
68
+ * @internal
69
+ * @readonly
70
+ * @maxLength 150
71
+ */
72
+ oloMigrationMenuId?: string | null;
73
+ /**
74
+ * References to an external app and resource associated with this object. Used for integration and tracking across different platforms.
75
+ * @internal
76
+ */
77
+ externalReferenceInfo?: ExternalReferenceInfo;
61
78
  }
62
79
  interface ExtendedFields {
63
80
  /**
@@ -109,7 +126,15 @@ interface Tag {
109
126
  meta?: Record<string, any> | null;
110
127
  /** SEO tag inner content. For example, `<title> inner content </title>`. */
111
128
  children?: string;
112
- /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
129
+ /**
130
+ * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
131
+ *
132
+ * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
133
+ * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
134
+ * or Wix Studio pages, so custom tags saved on those pages are missing from the response entirely. For
135
+ * those pages `false` therefore does not mean "not a custom tag" — it means this API could not tell.
136
+ * Pass `seoData` explicitly to resolve against a known set of tags.
137
+ */
113
138
  custom?: boolean;
114
139
  /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
115
140
  disabled?: boolean;
@@ -479,6 +504,20 @@ interface Sorting {
479
504
  fieldName?: string;
480
505
  /** Sort order. */
481
506
  order?: SortOrderWithLiterals;
507
+ /**
508
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
509
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
510
+ *
511
+ * If multiple filters are provided, they are combined with AND operator.
512
+ *
513
+ * Example:
514
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
515
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
516
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
517
+ * @internal
518
+ * @maxSize 10
519
+ */
520
+ selectItemsBy?: Record<string, any>[] | null;
482
521
  /**
483
522
  * Origin point for geo-distance sorting on a GEO field
484
523
  * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -506,6 +545,11 @@ interface QueryMenusResponse {
506
545
  interface UpdateMenuRequest {
507
546
  /** Menu to update. */
508
547
  menu: Menu;
548
+ /**
549
+ * Explicit list of fields to update.
550
+ * @internal
551
+ */
552
+ mask?: string[];
509
553
  }
510
554
  interface UpdateMenuResponse {
511
555
  /** Updated menu. */
@@ -1157,6 +1201,20 @@ type MenuQuery = {
1157
1201
  */
1158
1202
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
1159
1203
  /**
1204
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
1205
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
1206
+
1207
+ If multiple filters are provided, they are combined with AND operator.
1208
+
1209
+ Example:
1210
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
1211
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
1212
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
1213
+ @internal: undefined,
1214
+ @maxSize: 10
1215
+ */
1216
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
1217
+ /**
1160
1218
  Origin point for geo-distance sorting on a GEO field
1161
1219
  results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
1162
1220
  */
@@ -1240,6 +1298,12 @@ interface UpdateMenu {
1240
1298
  urlQueryParam?: string | null;
1241
1299
  /** Custom SEO data for the menu. */
1242
1300
  seoData?: SeoSchema;
1301
+ /**
1302
+ * Information about the business location where this menu is available. This information is taken from the `Location` object ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations)) corresponding with this menu's `businessLocationId`.
1303
+ * @internal
1304
+ * @readonly
1305
+ */
1306
+ businessLocationDetails?: BusinessLocationDetails;
1243
1307
  /**
1244
1308
  * ID of the business location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations)) where this menu is available.
1245
1309
  * @format GUID
@@ -1247,6 +1311,17 @@ interface UpdateMenu {
1247
1311
  * @readonly
1248
1312
  */
1249
1313
  businessLocationId?: string | null;
1314
+ /**
1315
+ * @internal
1316
+ * @readonly
1317
+ * @maxLength 150
1318
+ */
1319
+ oloMigrationMenuId?: string | null;
1320
+ /**
1321
+ * References to an external app and resource associated with this object. Used for integration and tracking across different platforms.
1322
+ * @internal
1323
+ */
1324
+ externalReferenceInfo?: ExternalReferenceInfo;
1250
1325
  }
1251
1326
  /**
1252
1327
  * > **Note:** The Menu API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).