@wix/auto_sdk_restaurants_menus 1.0.93 → 1.0.94

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.
@@ -88,73 +88,117 @@ interface ExtendedFields {
88
88
  namespaces?: Record<string, Record<string, any>>;
89
89
  }
90
90
  /**
91
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
92
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
93
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
91
+ * The SEO data for a single page or dynamic item, in the shape stored today.
92
+ *
93
+ * FROZEN. Existing server code maps onto this message field by field, so its
94
+ * field set must never change (see the file header). New writers use
95
+ * `SeoSchemaV2`.
96
+ *
97
+ * These tags are rendered into the <head> of the HTML document and are not
98
+ * visible on the page itself. They override every other source of tags
99
+ * (site defaults, vertical presets, patterns) for this page.
94
100
  */
95
101
  interface SeoSchema {
96
- /** SEO tag information. */
102
+ /**
103
+ * The tags rendered into <head>, in no particular order. Render order is
104
+ * decided by the renderer, not by position in this list.
105
+ *
106
+ * No maxSize: this list is already populated by data written years ago, and
107
+ * a bound added now could reject a page that is already stored.
108
+ */
97
109
  tags?: Tag[];
98
- /** SEO general settings. */
110
+ /** Page-level SEO settings that are not themselves tags. */
99
111
  settings?: Settings;
100
112
  }
113
+ /** A keyword term the user is targeting. */
101
114
  interface Keyword {
102
- /** Keyword value. */
115
+ /**
116
+ * The term itself, e.g. "trail running shoes".
117
+ *
118
+ * No maxLength, for the same reason as the legacy tag fields: keywords are
119
+ * already stored, and a bound added now could reject a record written
120
+ * before the bound existed. The flynt `missing-string-validations` warning
121
+ * on this field is accepted deliberately.
122
+ */
103
123
  term?: string;
104
- /** Whether the keyword is the main focus keyword. */
124
+ /** Whether this is the page's primary focus keyword. At most one per page. */
105
125
  isMain?: boolean;
106
126
  /**
107
- * The source that added the keyword terms to the SEO settings.
127
+ * Which surface added the term, e.g. a panel or a suggestion flow. Used for
128
+ * attribution in BI. Opaque to the renderer.
108
129
  * @maxLength 1000
109
130
  */
110
131
  origin?: string | null;
111
132
  }
133
+ /**
134
+ * One tag in the page's <head>.
135
+ *
136
+ * Not deprecated, and with no removal date, deliberately: stored data is
137
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
138
+ * normalizes both shapes on READ.
139
+ */
112
140
  interface Tag {
113
141
  /**
114
- * SEO tag type.
115
- *
142
+ * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
143
+ * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
144
+ * the invalid combinations unrepresentable rather than merely discouraged.
116
145
  *
117
- * Supported values: `title`, `meta`, `script`, `link`.
118
- *
119
- * Which of these an API actually accepts depends on where the tag is being set: this
120
- * list is not a blanket guarantee across every API that reuses this message. Site SEO
121
- * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
122
- * `title`/`script`/`link` with a validation error even though they appear here —
123
- * check the field description of the specific `tags`-typed field you're writing to
124
- * for the types it actually supports and the error it returns.
146
+ * Which of these an API actually accepts depends on where the tag is being
147
+ * set: this list is not a blanket guarantee across every API that reuses
148
+ * this message. Site SEO Tags in particular accepts only `meta` (see
149
+ * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
150
+ * error even though they appear here — check the field description of the
151
+ * specific `tags`-typed field you are writing to.
125
152
  *
126
153
  * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
127
- * `"application/ld+json"` carrying structured data) are supported only when
128
- * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
129
- * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
130
- * write through the site's Advanced/Custom Tags list. To write structured data,
131
- * omit `custom` (or set it to `false`).
154
+ * "application/ld+json" carrying structured data) are supported only when
155
+ * `custom` is unset or `false`. Setting `custom: true` on a `title` or
156
+ * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
157
+ * `custom: true` routes the write through the site's Advanced/Custom Tags
158
+ * list. To write structured data, omit `custom` (or set it to `false`).
159
+ *
160
+ * No length limit: this field holds data written years ago by writers we
161
+ * are not migrating. A constraint here could reject a record that is
162
+ * already stored, which is exactly the promise this design makes.
132
163
  */
133
164
  type?: string;
134
165
  /**
135
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
136
- * For example: `{"name": "description", "content": "the description itself"}`.
166
+ * Legacy. Was an untyped bag of HTML attributes.
167
+ * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
137
168
  */
138
169
  props?: Record<string, any> | null;
139
- /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
170
+ /**
171
+ * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
172
+ * its contents are split by purpose: per-page structured-data state moves to
173
+ * StructuredDataTag, authorship to `written_by`, and render-time preset
174
+ * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
175
+ * stored document entirely — it belongs to the preset definition, not to the
176
+ * page. See the design log for the full key-by-key mapping.
177
+ */
140
178
  meta?: Record<string, any> | null;
141
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
179
+ /**
180
+ * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
181
+ * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
182
+ * `StructuredDataTag.json_ld`.
183
+ * No length limit, for the same reason as `type` above.
184
+ */
142
185
  children?: string;
143
186
  /**
144
187
  * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
145
188
  * i.e. an entry from the site's Advanced/Custom Tags list.
146
189
  *
147
- * Setting this to `true` on a write restricts which `type` values are accepted
148
- * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
149
- * `script` tags (including JSON-LD structured data) must be sent with `custom`
150
- * omitted or `false`; sending them with `custom: true` is rejected with
151
- * `TAG_TYPE_NOT_ALLOWED`.
190
+ * Setting this to `true` on a write restricts which `type` values are
191
+ * accepted — the same restriction the Advanced/Custom Tags UI enforces.
192
+ * `title` and `script` tags (including JSON-LD structured data) must be sent
193
+ * with `custom` omitted or `false`; sending them with `custom: true` is
194
+ * rejected with `TAG_TYPE_NOT_ALLOWED`.
152
195
  *
153
- * Note this is a separate restriction from Site SEO Tags' own type restriction on
154
- * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
155
- * for site-wide structured data) unconditionally. There is currently no way to set
156
- * site-wide, every-page structured data through any of these APIs — write a per-page
157
- * `script` tag through the Item SEO Tags API instead.
196
+ * Note this is a separate restriction from Site SEO Tags' own type
197
+ * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
198
+ * rejects `script` (e.g. for site-wide structured data) unconditionally.
199
+ * There is currently no way to set site-wide, every-page structured data
200
+ * through any of these APIs — write a per-page `script` tag through the Item
201
+ * SEO Tags API instead.
158
202
  *
159
203
  * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
160
204
  * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -167,22 +211,39 @@ interface Tag {
167
211
  * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
168
212
  * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
169
213
  * Pass `seoData` explicitly to resolve against a known set of tags.
214
+ *
215
+ * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
170
216
  */
171
217
  custom?: boolean;
172
- /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
218
+ /**
219
+ * Whether the tag is excluded from the rendered <head>.
220
+ *
221
+ * A disabled tag is still stored, so the user can re-enable it and so a
222
+ * pattern-provided tag stays suppressed on this page. Default false.
223
+ */
173
224
  disabled?: boolean;
174
225
  }
226
+ /** Page-level SEO settings that are not tags. */
175
227
  interface Settings {
176
228
  /**
177
- * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
229
+ * Whether to suppress the automatic redirect from this page's previous URL to
230
+ * its current one after a slug change.
178
231
  *
179
- *
180
- * Default: `false` (automatical redirect is enabled).
232
+ * Default false, meaning the redirect IS created. The field is named for the
233
+ * exception rather than the rule, which reads backwards; kept as-is because
234
+ * renaming a stored boolean is not worth the migration.
181
235
  */
182
236
  preventAutoRedirect?: boolean;
183
237
  /**
184
- * User-selected keyword terms for a specific page.
185
- * @maxSize 5
238
+ * Keyword terms the user is targeting for this page. Used by the SEO
239
+ * assistant and checklist; never rendered into <head>.
240
+ *
241
+ * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
242
+ * the panel happens to allow today — which is exactly the mistake we are
243
+ * fixing for structured data. A product decision to allow 8 should not need
244
+ * a proto release, so the panel owns that number and the proto only stops
245
+ * something absurd.
246
+ * @maxSize 20
186
247
  */
187
248
  keywords?: Keyword[];
188
249
  }
@@ -222,288 +283,205 @@ interface ExternalReferenceInfo {
222
283
  /** Whether the connection to the external system is currently active. */
223
284
  connected?: boolean | null;
224
285
  }
225
- interface InvalidateCache extends InvalidateCacheGetByOneOf {
286
+ interface DuplicateMenuRequest {
226
287
  /**
227
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
288
+ * Menu id to be duplicated.
228
289
  * @format GUID
229
290
  */
230
- metaSiteId?: string;
291
+ _id: string;
231
292
  /**
232
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
293
+ * Business location ids to duplicate the menu to.
233
294
  * @format GUID
295
+ * @maxSize 100
234
296
  */
235
- siteId?: string;
236
- /** Invalidate by App */
237
- app?: App;
238
- /** Invalidate by page id */
239
- page?: Page;
240
- /** Invalidate by URI path */
241
- uri?: URI;
242
- /** Invalidate by file (for media files such as PDFs) */
243
- file?: File;
244
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
245
- customTag?: CustomTag;
246
- /** Invalidate by multiple page ids */
247
- pages?: Pages;
248
- /** Invalidate by multiple URI paths */
249
- uris?: URIs;
297
+ businessLocationIds?: string[] | null;
298
+ /** Indicates whether sub-entities (such as items) should be duplicated as well. */
299
+ duplicateSubEntities?: boolean | null;
250
300
  /**
251
- * tell us why you're invalidating the cache. You don't need to add your app name
252
- * @maxLength 256
301
+ * The new name of the duplicated menu.
302
+ * @maxLength 500
253
303
  */
254
- reason?: string | null;
255
- /** Is local DS */
256
- localDc?: boolean;
257
- hardPurge?: boolean;
304
+ menuName?: string | null;
305
+ }
306
+ interface DuplicateMenuResponse {
307
+ /** @format GUID */
308
+ menuIds?: string[];
309
+ }
310
+ interface DomainEvent extends DomainEventBodyOneOf {
311
+ createdEvent?: EntityCreatedEvent;
312
+ updatedEvent?: EntityUpdatedEvent;
313
+ deletedEvent?: EntityDeletedEvent;
314
+ actionEvent?: ActionEvent;
315
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
316
+ _id?: string;
258
317
  /**
259
- * Optional caller-provided ID for tracking this invalidation through the system.
260
- * When set, the corresponding CDN purge completion event will include this ID,
261
- * allowing you to confirm when the invalidation has fully propagated.
262
- * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
263
- * @maxLength 256
318
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
319
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
264
320
  */
265
- correlationId?: string | null;
266
- }
267
- /** @oneof */
268
- interface InvalidateCacheGetByOneOf {
321
+ entityFqdn?: string;
269
322
  /**
270
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
271
- * @format GUID
323
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
324
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
272
325
  */
273
- metaSiteId?: string;
326
+ slug?: string;
327
+ /** ID of the entity associated with the event. */
328
+ entityId?: string;
329
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
330
+ eventTime?: Date | null;
274
331
  /**
275
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
276
- * @format GUID
332
+ * Whether the event was triggered as a result of a privacy regulation application
333
+ * (for example, GDPR).
277
334
  */
278
- siteId?: string;
279
- /** Invalidate by App */
280
- app?: App;
281
- /** Invalidate by page id */
282
- page?: Page;
283
- /** Invalidate by URI path */
284
- uri?: URI;
285
- /** Invalidate by file (for media files such as PDFs) */
286
- file?: File;
287
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
288
- customTag?: CustomTag;
289
- /** Invalidate by multiple page ids */
290
- pages?: Pages;
291
- /** Invalidate by multiple URI paths */
292
- uris?: URIs;
293
- }
294
- interface App {
335
+ triggeredByAnonymizeRequest?: boolean | null;
336
+ /** If present, indicates the action that triggered the event. */
337
+ originatedFrom?: string | null;
295
338
  /**
296
- * The AppDefId
297
- * @minLength 1
339
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
340
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
298
341
  */
299
- appDefId?: string;
342
+ entityEventSequence?: string | null;
343
+ }
344
+ /** @oneof */
345
+ interface DomainEventBodyOneOf {
346
+ createdEvent?: EntityCreatedEvent;
347
+ updatedEvent?: EntityUpdatedEvent;
348
+ deletedEvent?: EntityDeletedEvent;
349
+ actionEvent?: ActionEvent;
350
+ }
351
+ interface EntityCreatedEvent {
352
+ entity?: string;
353
+ }
354
+ interface RestoreInfo {
355
+ deletedDate?: Date | null;
356
+ }
357
+ interface EntityUpdatedEvent {
300
358
  /**
301
- * The instance Id
302
- * @format GUID
359
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
360
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
361
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
303
362
  */
304
- instanceId?: string;
363
+ currentEntity?: string;
305
364
  }
306
- interface Page {
365
+ interface EntityDeletedEvent {
366
+ /** Entity that was deleted. */
367
+ deletedEntity?: string | null;
368
+ }
369
+ interface ActionEvent {
370
+ body?: string;
371
+ }
372
+ interface MessageEnvelope {
307
373
  /**
308
- * the msid the page is on
374
+ * App instance ID.
309
375
  * @format GUID
310
376
  */
311
- metaSiteId?: string;
377
+ instanceId?: string | null;
312
378
  /**
313
- * Invalidate by Page ID
314
- * @minLength 1
379
+ * Event type.
380
+ * @maxLength 150
315
381
  */
316
- pageId?: string;
382
+ eventType?: string;
383
+ /** The identification type and identity data. */
384
+ identity?: IdentificationData;
385
+ /** Stringify payload. */
386
+ data?: string;
387
+ /** Details related to the account */
388
+ accountInfo?: AccountInfo;
317
389
  }
318
- interface URI {
390
+ interface IdentificationData extends IdentificationDataIdOneOf {
319
391
  /**
320
- * the msid the URI is on
392
+ * ID of a site visitor that has not logged in to the site.
321
393
  * @format GUID
322
394
  */
323
- metaSiteId?: string;
395
+ anonymousVisitorId?: string;
324
396
  /**
325
- * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
326
- * @minLength 1
397
+ * ID of a site visitor that has logged in to the site.
398
+ * @format GUID
327
399
  */
328
- uriPath?: string;
329
- }
330
- interface File {
400
+ memberId?: string;
331
401
  /**
332
- * the msid the file is related to
402
+ * ID of a Wix user (site owner, contributor, etc.).
333
403
  * @format GUID
334
404
  */
335
- metaSiteId?: string;
405
+ wixUserId?: string;
336
406
  /**
337
- * Invalidate by filename (for media files such as PDFs)
338
- * @minLength 1
339
- * @maxLength 256
407
+ * ID of an app.
408
+ * @format GUID
340
409
  */
341
- fileName?: string;
410
+ appId?: string;
411
+ /** @readonly */
412
+ identityType?: WebhookIdentityTypeWithLiterals;
342
413
  }
343
- interface CustomTag {
414
+ /** @oneof */
415
+ interface IdentificationDataIdOneOf {
344
416
  /**
345
- * the msid the tag is related to
417
+ * ID of a site visitor that has not logged in to the site.
346
418
  * @format GUID
347
419
  */
348
- metaSiteId?: string;
420
+ anonymousVisitorId?: string;
349
421
  /**
350
- * Tag to invalidate by
351
- * @minLength 1
352
- * @maxLength 256
422
+ * ID of a site visitor that has logged in to the site.
423
+ * @format GUID
353
424
  */
354
- tag?: string;
355
- }
356
- interface Pages {
425
+ memberId?: string;
357
426
  /**
358
- * the msid the pages are on
427
+ * ID of a Wix user (site owner, contributor, etc.).
359
428
  * @format GUID
360
429
  */
361
- metaSiteId?: string;
430
+ wixUserId?: string;
362
431
  /**
363
- * Invalidate by multiple Page IDs in a single message
364
- * @maxSize 100
365
- * @minLength 1
432
+ * ID of an app.
433
+ * @format GUID
366
434
  */
367
- pageIds?: string[];
435
+ appId?: string;
368
436
  }
369
- interface URIs {
437
+ declare enum WebhookIdentityType {
438
+ UNKNOWN = "UNKNOWN",
439
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
440
+ MEMBER = "MEMBER",
441
+ WIX_USER = "WIX_USER",
442
+ APP = "APP"
443
+ }
444
+ /** @enumType */
445
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
446
+ interface AccountInfo {
370
447
  /**
371
- * the msid the URIs are on
448
+ * ID of the Wix account associated with the event.
372
449
  * @format GUID
373
450
  */
374
- metaSiteId?: string;
451
+ accountId?: string | null;
375
452
  /**
376
- * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
377
- * @maxSize 100
378
- * @minLength 1
453
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
454
+ * @format GUID
379
455
  */
380
- uriPaths?: string[];
381
- }
382
- interface DeleteOrphanSections {
383
- /** Menu id */
384
- menuId?: string;
456
+ parentAccountId?: string | null;
457
+ /**
458
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
459
+ * @format GUID
460
+ */
461
+ siteId?: string | null;
385
462
  }
386
- interface MenusDataCloningCompleted {
387
- }
388
- interface CreateMenuRequest {
389
- /** Menu details. */
390
- menu: Menu;
391
- }
392
- interface CreateMenuResponse {
393
- /** Menu. */
394
- menu?: Menu;
395
- }
396
- interface BulkCreateMenusRequest {
397
- /**
398
- * Menu details.
399
- * @maxSize 100
400
- */
401
- menus: Menu[];
402
- /** Whether to receive the created menus in the response. */
403
- returnEntity?: boolean;
404
- }
405
- interface BulkCreateMenusResponse {
406
- /** Information about the created menus. */
407
- results?: BulkCreateMenuResult[];
408
- /** Metadata for the API call. */
409
- bulkActionMetadata?: BulkActionMetadata;
410
- }
411
- interface BulkCreateMenuResult {
412
- /** Whether to receive the created menus in the response. */
413
- menuMetadata?: ItemMetadata;
414
- /** Created menu. */
415
- menu?: Menu;
416
- }
417
- interface ItemMetadata {
418
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
419
- _id?: string | null;
420
- /** Index of the item within the request array. Allows for correlation between request and response items. */
421
- originalIndex?: number;
422
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
423
- success?: boolean;
424
- /** Details about the error in case of failure. */
425
- error?: ApplicationError;
426
- }
427
- interface ApplicationError {
428
- /** Error code. */
429
- code?: string;
430
- /** Description of the error. */
431
- description?: string;
432
- /** Data related to the error. */
433
- data?: Record<string, any> | null;
434
- }
435
- interface BulkActionMetadata {
436
- /** Number of items that were successfully processed. */
437
- totalSuccesses?: number;
438
- /** Number of items that couldn't be processed. */
439
- totalFailures?: number;
440
- /** Number of failures without details because detailed failure threshold was exceeded. */
441
- undetailedFailures?: number;
442
- }
443
- interface GetMenuRequest {
463
+ interface GetMenuSiteUrlRequest {
444
464
  /**
445
465
  * Menu ID.
446
466
  * @format GUID
467
+ * @readonly
447
468
  */
448
- menuId: string;
449
- }
450
- interface GetMenuResponse {
451
- /** Menu. */
452
- menu?: Menu;
453
- }
454
- interface ListMenusRequest {
455
- /**
456
- * Menu IDs.
457
- * @format GUID
458
- * @maxSize 500
459
- */
460
- menuIds?: string[];
461
- /** The metadata of the paginated results. */
462
- paging?: CursorPaging;
463
- /** Whether to return only menus that are visible to site visitors. */
464
- onlyVisible?: boolean | null;
465
- }
466
- interface CursorPaging {
467
- /**
468
- * Number of items to load.
469
- * @max 500
470
- */
471
- limit?: number | null;
472
- /**
473
- * Pointer to the next or previous page in the list of results.
474
- *
475
- * You can get the relevant cursor token
476
- * from the `pagingMetadata` object in the previous call's response.
477
- * Not relevant for the first request.
478
- */
479
- cursor?: string | null;
469
+ _id: string | null;
480
470
  }
481
- interface ListMenusResponse {
482
- /** Retrieved menus. */
483
- menus?: Menu[];
484
- /** The metadata of the paginated results. */
485
- pagingMetadata?: CursorPagingMetadata;
471
+ interface GetMenuSiteUrlResponse {
472
+ /** Retrieved menuInfo with path url. */
473
+ menuSiteUrl?: MenuSiteUrl;
486
474
  }
487
- interface CursorPagingMetadata {
488
- /** Number of items returned in the response. */
489
- count?: number | null;
490
- /** Offset that was requested. */
491
- cursors?: Cursors;
475
+ interface MenuSiteUrl {
492
476
  /**
493
- * Indicates if there are more results after the current page.
494
- * If `true`, another page of results can be retrieved.
495
- * If `false`, this is the last page.
477
+ * Path URL.
478
+ * @minLength 1
479
+ * @maxLength 1000
496
480
  */
497
- hasNext?: boolean | null;
498
- }
499
- interface Cursors {
500
- /** Cursor pointing to next page in the list of results. */
501
- next?: string | null;
502
- /** Cursor pointing to previous page in the list of results. */
503
- prev?: string | null;
481
+ path?: string;
504
482
  }
505
- interface QueryMenusRequest {
506
- /** Query options. */
483
+ interface QueryMenusSiteUrlRequest {
484
+ /** Query options */
507
485
  query?: CursorQuery;
508
486
  }
509
487
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -569,325 +547,408 @@ interface AddressLocation {
569
547
  /** Address longitude. */
570
548
  longitude?: number | null;
571
549
  }
572
- interface QueryMenusResponse {
573
- /** Retrieved menus. */
574
- menus?: Menu[];
575
- /** The metadata of the paginated results. */
576
- pagingMetadata?: CursorPagingMetadata;
577
- }
578
- interface UpdateMenuRequest {
579
- /** Menu to update. */
580
- menu: Menu;
550
+ interface CursorPaging {
581
551
  /**
582
- * Explicit list of fields to update.
583
- * @internal
552
+ * Number of items to load.
553
+ * @max 500
584
554
  */
585
- mask?: string[];
586
- }
587
- interface UpdateMenuResponse {
588
- /** Updated menu. */
589
- menu?: Menu;
590
- }
591
- interface BulkUpdateMenuRequest {
555
+ limit?: number | null;
592
556
  /**
593
- * Menus to update.
594
- * @minSize 1
595
- * @maxSize 100
557
+ * Pointer to the next or previous page in the list of results.
558
+ *
559
+ * You can get the relevant cursor token
560
+ * from the `pagingMetadata` object in the previous call's response.
561
+ * Not relevant for the first request.
596
562
  */
597
- menus: MaskedMenu[];
598
- /** Whether to receive the entity in the response. */
599
- returnEntity?: boolean;
563
+ cursor?: string | null;
600
564
  }
601
- interface MaskedMenu {
602
- /** Menu to updated. */
603
- menu?: Menu;
604
- /** Explicit list of fields to update. */
605
- mask?: string[];
565
+ interface QueryMenusSiteUrlResponse {
566
+ /** Retrieved menuInfos with path urls. */
567
+ menuSiteUrls?: MenuSiteUrl[];
568
+ /** The metadata of the paginated results. */
569
+ pagingMetadata?: CursorPagingMetadata;
606
570
  }
607
- interface BulkUpdateMenuResponse {
571
+ interface CursorPagingMetadata {
572
+ /** Number of items returned in the response. */
573
+ count?: number | null;
574
+ /** Offset that was requested. */
575
+ cursors?: Cursors;
608
576
  /**
609
- * Results of bulk menu update.
610
- * @minSize 1
611
- * @maxSize 100
577
+ * Indicates if there are more results after the current page.
578
+ * If `true`, another page of results can be retrieved.
579
+ * If `false`, this is the last page.
612
580
  */
613
- results?: BulkMenuResult[];
614
- /** Metadata for the API call. */
615
- bulkActionMetadata?: BulkActionMetadata;
616
- }
617
- interface BulkMenuResult {
618
- /** Metadata for menu update. */
619
- menuMetadata?: ItemMetadata;
620
- /** Updated menu. Only returned if `returnEntity` is set to `true`. */
621
- menu?: Menu;
622
- }
623
- interface UpdateExtendedFieldsRequest {
624
- /** ID of the entity to update. */
625
- _id: string;
626
- /** Identifier for the app whose extended fields are being updated. */
627
- namespace: string;
628
- /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
629
- namespaceData: Record<string, any> | null;
581
+ hasNext?: boolean | null;
630
582
  }
631
- interface UpdateExtendedFieldsResponse {
632
- /** Namespace of the app. */
633
- namespace?: string;
634
- /** Updated extended fields data. */
635
- namespaceData?: Record<string, any> | null;
583
+ interface Cursors {
584
+ /** Cursor pointing to next page in the list of results. */
585
+ next?: string | null;
586
+ /** Cursor pointing to previous page in the list of results. */
587
+ prev?: string | null;
636
588
  }
637
- interface DeleteMenuRequest {
589
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
638
590
  /**
639
- * Menu ID.
591
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
640
592
  * @format GUID
641
593
  */
642
- menuId: string;
643
- }
644
- interface DeleteMenuResponse {
645
- }
646
- interface RunMenusMultiLocationMigrationRequest {
594
+ metaSiteId?: string;
647
595
  /**
648
- * business location id
596
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
649
597
  * @format GUID
650
598
  */
651
- businessLocationId?: string;
652
- }
653
- interface RunMenusMultiLocationMigrationResponse {
654
- /** Whether menus multi-location migration finished successfully */
655
- success?: boolean;
656
- }
657
- interface UpdateBusinessLocationIdRequest {
658
- /** @format GUID */
659
- menuId?: string;
660
- /** @format GUID */
661
- businessLocationId?: string | null;
662
- }
663
- interface UpdateBusinessLocationIdResponse {
664
- }
665
- interface CloneMenusRequest {
599
+ siteId?: string;
600
+ /** Invalidate by App */
601
+ app?: App;
602
+ /** Invalidate by page id */
603
+ page?: Page;
604
+ /** Invalidate by URI path */
605
+ uri?: URI;
606
+ /** Invalidate by file (for media files such as PDFs) */
607
+ file?: File;
608
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
609
+ customTag?: CustomTag;
610
+ /** Invalidate by multiple page ids */
611
+ pages?: Pages;
612
+ /** Invalidate by multiple URI paths */
613
+ uris?: URIs;
666
614
  /**
667
- * The MetaSiteId to clone from.
668
- * @format GUID
615
+ * tell us why you're invalidating the cache. You don't need to add your app name
616
+ * @maxLength 256
669
617
  */
670
- metaSiteId?: string;
671
- }
672
- interface CloneMenusResponse {
618
+ reason?: string | null;
619
+ /** Is local DS */
620
+ localDc?: boolean;
621
+ hardPurge?: boolean;
622
+ /**
623
+ * Optional caller-provided ID for tracking this invalidation through the system.
624
+ * When set, the corresponding CDN purge completion event will include this ID,
625
+ * allowing you to confirm when the invalidation has fully propagated.
626
+ * Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
627
+ * @maxLength 256
628
+ */
629
+ correlationId?: string | null;
673
630
  }
674
- interface DomainEvent extends DomainEventBodyOneOf {
675
- createdEvent?: EntityCreatedEvent;
676
- updatedEvent?: EntityUpdatedEvent;
677
- deletedEvent?: EntityDeletedEvent;
678
- actionEvent?: ActionEvent;
679
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
680
- _id?: string;
631
+ /** @oneof */
632
+ interface InvalidateCacheGetByOneOf {
681
633
  /**
682
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
683
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
634
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
635
+ * @format GUID
684
636
  */
685
- entityFqdn?: string;
637
+ metaSiteId?: string;
686
638
  /**
687
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
688
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
639
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
640
+ * @format GUID
689
641
  */
690
- slug?: string;
691
- /** ID of the entity associated with the event. */
692
- entityId?: string;
693
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
694
- eventTime?: Date | null;
642
+ siteId?: string;
643
+ /** Invalidate by App */
644
+ app?: App;
645
+ /** Invalidate by page id */
646
+ page?: Page;
647
+ /** Invalidate by URI path */
648
+ uri?: URI;
649
+ /** Invalidate by file (for media files such as PDFs) */
650
+ file?: File;
651
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
652
+ customTag?: CustomTag;
653
+ /** Invalidate by multiple page ids */
654
+ pages?: Pages;
655
+ /** Invalidate by multiple URI paths */
656
+ uris?: URIs;
657
+ }
658
+ interface App {
695
659
  /**
696
- * Whether the event was triggered as a result of a privacy regulation application
697
- * (for example, GDPR).
660
+ * The AppDefId
661
+ * @minLength 1
698
662
  */
699
- triggeredByAnonymizeRequest?: boolean | null;
700
- /** If present, indicates the action that triggered the event. */
701
- originatedFrom?: string | null;
663
+ appDefId?: string;
702
664
  /**
703
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
704
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
665
+ * The instance Id
666
+ * @format GUID
705
667
  */
706
- entityEventSequence?: string | null;
707
- }
708
- /** @oneof */
709
- interface DomainEventBodyOneOf {
710
- createdEvent?: EntityCreatedEvent;
711
- updatedEvent?: EntityUpdatedEvent;
712
- deletedEvent?: EntityDeletedEvent;
713
- actionEvent?: ActionEvent;
714
- }
715
- interface EntityCreatedEvent {
716
- entity?: string;
717
- }
718
- interface RestoreInfo {
719
- deletedDate?: Date | null;
668
+ instanceId?: string;
720
669
  }
721
- interface EntityUpdatedEvent {
670
+ interface Page {
722
671
  /**
723
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
724
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
725
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
672
+ * the msid the page is on
673
+ * @format GUID
726
674
  */
727
- currentEntity?: string;
728
- }
729
- interface EntityDeletedEvent {
730
- /** Entity that was deleted. */
731
- deletedEntity?: string | null;
732
- }
733
- interface ActionEvent {
734
- body?: string;
735
- }
736
- interface Empty {
675
+ metaSiteId?: string;
676
+ /**
677
+ * Invalidate by Page ID
678
+ * @minLength 1
679
+ */
680
+ pageId?: string;
737
681
  }
738
- interface SyncContentToMultilingualRequest {
682
+ interface URI {
739
683
  /**
740
- * MetaSite ID
684
+ * the msid the URI is on
741
685
  * @format GUID
742
686
  */
743
687
  metaSiteId?: string;
688
+ /**
689
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
690
+ * @minLength 1
691
+ */
692
+ uriPath?: string;
744
693
  }
745
- interface SyncContentToMultilingualResponse {
746
- }
747
- interface MessageEnvelope {
694
+ interface File {
748
695
  /**
749
- * App instance ID.
696
+ * the msid the file is related to
750
697
  * @format GUID
751
698
  */
752
- instanceId?: string | null;
699
+ metaSiteId?: string;
753
700
  /**
754
- * Event type.
755
- * @maxLength 150
701
+ * Invalidate by filename (for media files such as PDFs)
702
+ * @minLength 1
703
+ * @maxLength 256
756
704
  */
757
- eventType?: string;
758
- /** The identification type and identity data. */
759
- identity?: IdentificationData;
760
- /** Stringify payload. */
761
- data?: string;
762
- /** Details related to the account */
763
- accountInfo?: AccountInfo;
705
+ fileName?: string;
764
706
  }
765
- interface IdentificationData extends IdentificationDataIdOneOf {
707
+ interface CustomTag {
766
708
  /**
767
- * ID of a site visitor that has not logged in to the site.
709
+ * the msid the tag is related to
768
710
  * @format GUID
769
711
  */
770
- anonymousVisitorId?: string;
712
+ metaSiteId?: string;
771
713
  /**
772
- * ID of a site visitor that has logged in to the site.
773
- * @format GUID
714
+ * Tag to invalidate by
715
+ * @minLength 1
716
+ * @maxLength 256
774
717
  */
775
- memberId?: string;
718
+ tag?: string;
719
+ }
720
+ interface Pages {
776
721
  /**
777
- * ID of a Wix user (site owner, contributor, etc.).
722
+ * the msid the pages are on
778
723
  * @format GUID
779
724
  */
780
- wixUserId?: string;
725
+ metaSiteId?: string;
781
726
  /**
782
- * ID of an app.
783
- * @format GUID
727
+ * Invalidate by multiple Page IDs in a single message
728
+ * @maxSize 100
729
+ * @minLength 1
784
730
  */
785
- appId?: string;
786
- /** @readonly */
787
- identityType?: WebhookIdentityTypeWithLiterals;
731
+ pageIds?: string[];
788
732
  }
789
- /** @oneof */
790
- interface IdentificationDataIdOneOf {
733
+ interface URIs {
791
734
  /**
792
- * ID of a site visitor that has not logged in to the site.
735
+ * the msid the URIs are on
793
736
  * @format GUID
794
737
  */
795
- anonymousVisitorId?: string;
738
+ metaSiteId?: string;
796
739
  /**
797
- * ID of a site visitor that has logged in to the site.
740
+ * URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
741
+ * @maxSize 100
742
+ * @minLength 1
743
+ */
744
+ uriPaths?: string[];
745
+ }
746
+ interface DeleteOrphanSections {
747
+ /** Menu id */
748
+ menuId?: string;
749
+ }
750
+ interface MenusDataCloningCompleted {
751
+ }
752
+ interface CreateMenuRequest {
753
+ /** Menu details. */
754
+ menu: Menu;
755
+ }
756
+ interface CreateMenuResponse {
757
+ /** Menu. */
758
+ menu?: Menu;
759
+ }
760
+ interface BulkCreateMenusRequest {
761
+ /**
762
+ * Menu details.
763
+ * @maxSize 100
764
+ */
765
+ menus: Menu[];
766
+ /** Whether to receive the created menus in the response. */
767
+ returnEntity?: boolean;
768
+ }
769
+ interface BulkCreateMenusResponse {
770
+ /** Information about the created menus. */
771
+ results?: BulkCreateMenuResult[];
772
+ /** Metadata for the API call. */
773
+ bulkActionMetadata?: BulkActionMetadata;
774
+ }
775
+ interface BulkCreateMenuResult {
776
+ /** Whether to receive the created menus in the response. */
777
+ menuMetadata?: ItemMetadata;
778
+ /** Created menu. */
779
+ menu?: Menu;
780
+ }
781
+ interface ItemMetadata {
782
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
783
+ _id?: string | null;
784
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
785
+ originalIndex?: number;
786
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
787
+ success?: boolean;
788
+ /** Details about the error in case of failure. */
789
+ error?: ApplicationError;
790
+ }
791
+ interface ApplicationError {
792
+ /** Error code. */
793
+ code?: string;
794
+ /** Description of the error. */
795
+ description?: string;
796
+ /** Data related to the error. */
797
+ data?: Record<string, any> | null;
798
+ }
799
+ interface BulkActionMetadata {
800
+ /** Number of items that were successfully processed. */
801
+ totalSuccesses?: number;
802
+ /** Number of items that couldn't be processed. */
803
+ totalFailures?: number;
804
+ /** Number of failures without details because detailed failure threshold was exceeded. */
805
+ undetailedFailures?: number;
806
+ }
807
+ interface GetMenuRequest {
808
+ /**
809
+ * Menu ID.
798
810
  * @format GUID
799
811
  */
800
- memberId?: string;
812
+ menuId: string;
813
+ }
814
+ interface GetMenuResponse {
815
+ /** Menu. */
816
+ menu?: Menu;
817
+ }
818
+ interface ListMenusRequest {
801
819
  /**
802
- * ID of a Wix user (site owner, contributor, etc.).
820
+ * Menu IDs.
803
821
  * @format GUID
822
+ * @maxSize 500
804
823
  */
805
- wixUserId?: string;
824
+ menuIds?: string[];
825
+ /** The metadata of the paginated results. */
826
+ paging?: CursorPaging;
827
+ /** Whether to return only menus that are visible to site visitors. */
828
+ onlyVisible?: boolean | null;
829
+ }
830
+ interface ListMenusResponse {
831
+ /** Retrieved menus. */
832
+ menus?: Menu[];
833
+ /** The metadata of the paginated results. */
834
+ pagingMetadata?: CursorPagingMetadata;
835
+ }
836
+ interface QueryMenusRequest {
837
+ /** Query options. */
838
+ query?: CursorQuery;
839
+ }
840
+ interface QueryMenusResponse {
841
+ /** Retrieved menus. */
842
+ menus?: Menu[];
843
+ /** The metadata of the paginated results. */
844
+ pagingMetadata?: CursorPagingMetadata;
845
+ }
846
+ interface UpdateMenuRequest {
847
+ /** Menu to update. */
848
+ menu: Menu;
806
849
  /**
807
- * ID of an app.
808
- * @format GUID
850
+ * Explicit list of fields to update.
851
+ * @internal
809
852
  */
810
- appId?: string;
853
+ mask?: string[];
811
854
  }
812
- declare enum WebhookIdentityType {
813
- UNKNOWN = "UNKNOWN",
814
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
815
- MEMBER = "MEMBER",
816
- WIX_USER = "WIX_USER",
817
- APP = "APP"
855
+ interface UpdateMenuResponse {
856
+ /** Updated menu. */
857
+ menu?: Menu;
818
858
  }
819
- /** @enumType */
820
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
821
- interface AccountInfo {
822
- /**
823
- * ID of the Wix account associated with the event.
824
- * @format GUID
825
- */
826
- accountId?: string | null;
827
- /**
828
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
829
- * @format GUID
830
- */
831
- parentAccountId?: string | null;
859
+ interface BulkUpdateMenuRequest {
832
860
  /**
833
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
834
- * @format GUID
861
+ * Menus to update.
862
+ * @minSize 1
863
+ * @maxSize 100
835
864
  */
836
- siteId?: string | null;
865
+ menus: MaskedMenu[];
866
+ /** Whether to receive the entity in the response. */
867
+ returnEntity?: boolean;
837
868
  }
838
- interface DuplicateMenuRequest {
869
+ interface MaskedMenu {
870
+ /** Menu to updated. */
871
+ menu?: Menu;
872
+ /** Explicit list of fields to update. */
873
+ mask?: string[];
874
+ }
875
+ interface BulkUpdateMenuResponse {
839
876
  /**
840
- * Menu id to be duplicated.
841
- * @format GUID
877
+ * Results of bulk menu update.
878
+ * @minSize 1
879
+ * @maxSize 100
842
880
  */
881
+ results?: BulkMenuResult[];
882
+ /** Metadata for the API call. */
883
+ bulkActionMetadata?: BulkActionMetadata;
884
+ }
885
+ interface BulkMenuResult {
886
+ /** Metadata for menu update. */
887
+ menuMetadata?: ItemMetadata;
888
+ /** Updated menu. Only returned if `returnEntity` is set to `true`. */
889
+ menu?: Menu;
890
+ }
891
+ interface UpdateExtendedFieldsRequest {
892
+ /** ID of the entity to update. */
843
893
  _id: string;
894
+ /** Identifier for the app whose extended fields are being updated. */
895
+ namespace: string;
896
+ /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
897
+ namespaceData: Record<string, any> | null;
898
+ }
899
+ interface UpdateExtendedFieldsResponse {
900
+ /** Namespace of the app. */
901
+ namespace?: string;
902
+ /** Updated extended fields data. */
903
+ namespaceData?: Record<string, any> | null;
904
+ }
905
+ interface DeleteMenuRequest {
844
906
  /**
845
- * Business location ids to duplicate the menu to.
907
+ * Menu ID.
846
908
  * @format GUID
847
- * @maxSize 100
848
909
  */
849
- businessLocationIds?: string[] | null;
850
- /** Indicates whether sub-entities (such as items) should be duplicated as well. */
851
- duplicateSubEntities?: boolean | null;
910
+ menuId: string;
911
+ }
912
+ interface DeleteMenuResponse {
913
+ }
914
+ interface RunMenusMultiLocationMigrationRequest {
852
915
  /**
853
- * The new name of the duplicated menu.
854
- * @maxLength 500
916
+ * business location id
917
+ * @format GUID
855
918
  */
856
- menuName?: string | null;
919
+ businessLocationId?: string;
857
920
  }
858
- interface DuplicateMenuResponse {
921
+ interface RunMenusMultiLocationMigrationResponse {
922
+ /** Whether menus multi-location migration finished successfully */
923
+ success?: boolean;
924
+ }
925
+ interface UpdateBusinessLocationIdRequest {
859
926
  /** @format GUID */
860
- menuIds?: string[];
927
+ menuId?: string;
928
+ /** @format GUID */
929
+ businessLocationId?: string | null;
861
930
  }
862
- interface GetMenuSiteUrlRequest {
931
+ interface UpdateBusinessLocationIdResponse {
932
+ }
933
+ interface CloneMenusRequest {
863
934
  /**
864
- * Menu ID.
935
+ * The MetaSiteId to clone from.
865
936
  * @format GUID
866
- * @readonly
867
937
  */
868
- _id: string | null;
938
+ metaSiteId?: string;
869
939
  }
870
- interface GetMenuSiteUrlResponse {
871
- /** Retrieved menuInfo with path url. */
872
- menuSiteUrl?: MenuSiteUrl;
940
+ interface CloneMenusResponse {
873
941
  }
874
- interface MenuSiteUrl {
942
+ interface Empty {
943
+ }
944
+ interface SyncContentToMultilingualRequest {
875
945
  /**
876
- * Path URL.
877
- * @minLength 1
878
- * @maxLength 1000
946
+ * MetaSite ID
947
+ * @format GUID
879
948
  */
880
- path?: string;
881
- }
882
- interface QueryMenusSiteUrlRequest {
883
- /** Query options */
884
- query?: CursorQuery;
949
+ metaSiteId?: string;
885
950
  }
886
- interface QueryMenusSiteUrlResponse {
887
- /** Retrieved menuInfos with path urls. */
888
- menuSiteUrls?: MenuSiteUrl[];
889
- /** The metadata of the paginated results. */
890
- pagingMetadata?: CursorPagingMetadata;
951
+ interface SyncContentToMultilingualResponse {
891
952
  }
892
953
  interface BaseEventMetadata {
893
954
  /**
@@ -944,6 +1005,21 @@ interface AccountInfoMetadata {
944
1005
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
945
1006
  parentAccountId?: string;
946
1007
  }
1008
+ interface MenuUpdatedEnvelope {
1009
+ entity: Menu;
1010
+ metadata: EventMetadata;
1011
+ /** @hidden */
1012
+ modifiedFields: Record<string, any>;
1013
+ }
1014
+ /** @permissionScope Manage Restaurants - all permissions
1015
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1016
+ * @permissionId RESTAURANTS.MENU_READ
1017
+ * @webhook
1018
+ * @eventType wix.restaurants.menus.v1.menu_updated
1019
+ * @slug updated
1020
+ * @documentationMaturity preview
1021
+ */
1022
+ declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
947
1023
  interface MenuCreatedEnvelope {
948
1024
  entity: Menu;
949
1025
  metadata: EventMetadata;
@@ -973,21 +1049,54 @@ interface MenuDeletedEnvelope {
973
1049
  * @documentationMaturity preview
974
1050
  */
975
1051
  declare function onMenuDeleted(handler: (event: MenuDeletedEnvelope) => void | Promise<void>): void;
976
- interface MenuUpdatedEnvelope {
977
- entity: Menu;
978
- metadata: EventMetadata;
979
- /** @hidden */
980
- modifiedFields: Record<string, any>;
1052
+ /** @param _id - Menu id to be duplicated.
1053
+ * @public
1054
+ * @documentationMaturity preview
1055
+ * @requiredField _id
1056
+ * @permissionId RESTAURANTS.MENU_CREATE
1057
+ * @applicableIdentity APP
1058
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
1059
+ */
1060
+ declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
1061
+ interface DuplicateMenuOptions {
1062
+ /**
1063
+ * Business location ids to duplicate the menu to.
1064
+ * @format GUID
1065
+ * @maxSize 100
1066
+ */
1067
+ businessLocationIds?: string[] | null;
1068
+ /** Indicates whether sub-entities (such as items) should be duplicated as well. */
1069
+ duplicateSubEntities?: boolean | null;
1070
+ /**
1071
+ * The new name of the duplicated menu.
1072
+ * @maxLength 500
1073
+ */
1074
+ menuName?: string | null;
981
1075
  }
982
- /** @permissionScope Manage Restaurants - all permissions
983
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1076
+ /**
1077
+ * Get menu details and path URL by menu ID.
1078
+ * @param _id - Menu ID.
1079
+ * @public
1080
+ * @documentationMaturity preview
1081
+ * @requiredField _id
984
1082
  * @permissionId RESTAURANTS.MENU_READ
985
- * @webhook
986
- * @eventType wix.restaurants.menus.v1.menu_updated
987
- * @slug updated
1083
+ * @applicableIdentity APP
1084
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
1085
+ */
1086
+ declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
1087
+ /**
1088
+ * Query menu details and path URL
1089
+ * @public
988
1090
  * @documentationMaturity preview
1091
+ * @permissionId RESTAURANTS.MENU_READ
1092
+ * @applicableIdentity APP
1093
+ * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
989
1094
  */
990
- declare function onMenuUpdated(handler: (event: MenuUpdatedEnvelope) => void | Promise<void>): void;
1095
+ declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
1096
+ interface QueryMenusSiteUrlOptions {
1097
+ /** Query options */
1098
+ query?: CursorQuery;
1099
+ }
991
1100
  /**
992
1101
  * > **Note:** The Menus 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).
993
1102
  *
@@ -1405,53 +1514,5 @@ interface UpdateExtendedFieldsOptions {
1405
1514
  * @fqn com.wixpress.restaurants.menus_menu.v1.RestaurantsMenusMenu.DeleteMenu
1406
1515
  */
1407
1516
  declare function deleteMenu(menuId: string): Promise<void>;
1408
- /** @param _id - Menu id to be duplicated.
1409
- * @public
1410
- * @documentationMaturity preview
1411
- * @requiredField _id
1412
- * @permissionId RESTAURANTS.MENU_CREATE
1413
- * @applicableIdentity APP
1414
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_duplicate_menu.RestaurantsDuplicateMenu.DuplicateMenu
1415
- */
1416
- declare function duplicateMenu(_id: string, options?: DuplicateMenuOptions): Promise<NonNullablePaths<DuplicateMenuResponse, `menuIds`, 0>>;
1417
- interface DuplicateMenuOptions {
1418
- /**
1419
- * Business location ids to duplicate the menu to.
1420
- * @format GUID
1421
- * @maxSize 100
1422
- */
1423
- businessLocationIds?: string[] | null;
1424
- /** Indicates whether sub-entities (such as items) should be duplicated as well. */
1425
- duplicateSubEntities?: boolean | null;
1426
- /**
1427
- * The new name of the duplicated menu.
1428
- * @maxLength 500
1429
- */
1430
- menuName?: string | null;
1431
- }
1432
- /**
1433
- * Get menu details and path URL by menu ID.
1434
- * @param _id - Menu ID.
1435
- * @public
1436
- * @documentationMaturity preview
1437
- * @requiredField _id
1438
- * @permissionId RESTAURANTS.MENU_READ
1439
- * @applicableIdentity APP
1440
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.GetMenuSiteUrl
1441
- */
1442
- declare function getMenuSiteUrl(_id: string): Promise<NonNullablePaths<GetMenuSiteUrlResponse, `menuSiteUrl.path`, 1>>;
1443
- /**
1444
- * Query menu details and path URL
1445
- * @public
1446
- * @documentationMaturity preview
1447
- * @permissionId RESTAURANTS.MENU_READ
1448
- * @applicableIdentity APP
1449
- * @fqn com.wixpress.restaurants.menus_menu.v1.restaurants_menus_site_url.RestaurantsMenusSiteUrl.QueryMenusSiteUrl
1450
- */
1451
- declare function queryMenusSiteUrl(options?: QueryMenusSiteUrlOptions): Promise<NonNullablePaths<QueryMenusSiteUrlResponse, `menuSiteUrls` | `menuSiteUrls.${number}.path`, 2>>;
1452
- interface QueryMenusSiteUrlOptions {
1453
- /** Query options */
1454
- query?: CursorQuery;
1455
- }
1456
1517
 
1457
1518
  export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type App, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateMenuResult, type BulkCreateMenusOptions, type BulkCreateMenusRequest, type BulkCreateMenusResponse, type BulkMenuResult, type BulkUpdateMenuOptions, type BulkUpdateMenuRequest, type BulkUpdateMenuResponse, type BusinessLocationDetails, type CloneMenusRequest, type CloneMenusResponse, type CommonQueryWithEntityContext, type CreateMenuRequest, type CreateMenuResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomTag, type DeleteMenuRequest, type DeleteMenuResponse, type DeleteOrphanSections, type DomainEvent, type DomainEventBodyOneOf, type DuplicateMenuOptions, type DuplicateMenuRequest, type DuplicateMenuResponse, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type ExternalReferenceInfo, type File, type GetMenuRequest, type GetMenuResponse, type GetMenuSiteUrlRequest, type GetMenuSiteUrlResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvalidateCache, type InvalidateCacheGetByOneOf, type ItemMetadata, type Keyword, type ListMenusOptions, type ListMenusRequest, type ListMenusResponse, type MaskedMenu, type Menu, type MenuCreatedEnvelope, type MenuDeletedEnvelope, type MenuQuery, type MenuQuerySpec, type MenuSiteUrl, type MenuUpdatedEnvelope, type MenusDataCloningCompleted, type MenusQueryBuilder, type MenusQueryResult, type MessageEnvelope, type Page, type Pages, type QueryMenusRequest, type QueryMenusResponse, type QueryMenusSiteUrlOptions, type QueryMenusSiteUrlRequest, type QueryMenusSiteUrlResponse, type RestoreInfo, type RunMenusMultiLocationMigrationRequest, type RunMenusMultiLocationMigrationResponse, type SeoSchema, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, type SyncContentToMultilingualRequest, type SyncContentToMultilingualResponse, type Tag, type URI, type URIs, type UpdateBusinessLocationIdRequest, type UpdateBusinessLocationIdResponse, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, type UpdateMenu, type UpdateMenuRequest, type UpdateMenuResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, onMenuCreated, onMenuDeleted, onMenuUpdated, queryMenus, queryMenusSiteUrl, typedQueryMenus, updateExtendedFields, updateMenu, utils };