@wix/auto_sdk_restaurants_menus 1.0.76 → 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.
- package/build/cjs/index.d.ts +11 -11
- package/build/cjs/index.js +113 -90
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +242 -224
- package/build/cjs/index.typings.js +86 -63
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +204 -185
- package/build/cjs/meta.js +71 -48
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +16 -12
- package/build/cjs/schemas.js +34 -28
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +11 -11
- package/build/es/index.mjs +113 -90
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +242 -224
- package/build/es/index.typings.mjs +86 -63
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +204 -185
- package/build/es/meta.mjs +71 -48
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +16 -12
- package/build/es/schemas.mjs +34 -28
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -11
- package/build/internal/cjs/index.js +113 -90
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +309 -224
- package/build/internal/cjs/index.typings.js +86 -63
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +282 -185
- package/build/internal/cjs/meta.js +71 -48
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +16 -12
- package/build/internal/cjs/schemas.js +34 -28
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -11
- package/build/internal/es/index.mjs +113 -90
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +309 -224
- package/build/internal/es/index.typings.mjs +86 -63
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +282 -185
- package/build/internal/es/meta.mjs +71 -48
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +16 -12
- package/build/internal/es/schemas.mjs +34 -28
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +4 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CreateMenuRequest as CreateMenuRequest$1, CreateMenuResponse as CreateMenuResponse$1, BulkCreateMenusRequest as BulkCreateMenusRequest$1, BulkCreateMenusResponse as BulkCreateMenusResponse$1, GetMenuRequest as GetMenuRequest$1, GetMenuResponse as GetMenuResponse$1, ListMenusRequest as ListMenusRequest$1, ListMenusResponse as ListMenusResponse$1, QueryMenusRequest as QueryMenusRequest$1, QueryMenusResponse as QueryMenusResponse$1, UpdateMenuRequest as UpdateMenuRequest$1, UpdateMenuResponse as UpdateMenuResponse$1, BulkUpdateMenuRequest as BulkUpdateMenuRequest$1, BulkUpdateMenuResponse as BulkUpdateMenuResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1, DeleteMenuRequest as DeleteMenuRequest$1, DeleteMenuResponse as DeleteMenuResponse$1, DuplicateMenuRequest as DuplicateMenuRequest$1, DuplicateMenuResponse as DuplicateMenuResponse$1, GetMenuSiteUrlRequest as GetMenuSiteUrlRequest$1, GetMenuSiteUrlResponse as GetMenuSiteUrlResponse$1, QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Menu {
|
|
@@ -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
|
-
/**
|
|
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;
|
|
@@ -164,185 +189,6 @@ interface ExternalReferenceInfo {
|
|
|
164
189
|
/** Whether the connection to the external system is currently active. */
|
|
165
190
|
connected?: boolean | null;
|
|
166
191
|
}
|
|
167
|
-
interface DuplicateMenuRequest {
|
|
168
|
-
/**
|
|
169
|
-
* Menu id to be duplicated.
|
|
170
|
-
* @format GUID
|
|
171
|
-
*/
|
|
172
|
-
id: string;
|
|
173
|
-
/**
|
|
174
|
-
* Business location ids to duplicate the menu to.
|
|
175
|
-
* @format GUID
|
|
176
|
-
* @maxSize 100
|
|
177
|
-
*/
|
|
178
|
-
businessLocationIds?: string[] | null;
|
|
179
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
180
|
-
duplicateSubEntities?: boolean | null;
|
|
181
|
-
/**
|
|
182
|
-
* The new name of the duplicated menu.
|
|
183
|
-
* @maxLength 500
|
|
184
|
-
*/
|
|
185
|
-
menuName?: string | null;
|
|
186
|
-
}
|
|
187
|
-
interface DuplicateMenuResponse {
|
|
188
|
-
/** @format GUID */
|
|
189
|
-
menuIds?: string[];
|
|
190
|
-
}
|
|
191
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
192
|
-
createdEvent?: EntityCreatedEvent;
|
|
193
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
194
|
-
deletedEvent?: EntityDeletedEvent;
|
|
195
|
-
actionEvent?: ActionEvent;
|
|
196
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
197
|
-
id?: string;
|
|
198
|
-
/**
|
|
199
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
200
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
201
|
-
*/
|
|
202
|
-
entityFqdn?: string;
|
|
203
|
-
/**
|
|
204
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
205
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
206
|
-
*/
|
|
207
|
-
slug?: string;
|
|
208
|
-
/** ID of the entity associated with the event. */
|
|
209
|
-
entityId?: string;
|
|
210
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
211
|
-
eventTime?: Date | null;
|
|
212
|
-
/**
|
|
213
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
214
|
-
* (for example, GDPR).
|
|
215
|
-
*/
|
|
216
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
217
|
-
/** If present, indicates the action that triggered the event. */
|
|
218
|
-
originatedFrom?: string | null;
|
|
219
|
-
/**
|
|
220
|
-
* 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.
|
|
221
|
-
* 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.
|
|
222
|
-
*/
|
|
223
|
-
entityEventSequence?: string | null;
|
|
224
|
-
}
|
|
225
|
-
/** @oneof */
|
|
226
|
-
interface DomainEventBodyOneOf {
|
|
227
|
-
createdEvent?: EntityCreatedEvent;
|
|
228
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
229
|
-
deletedEvent?: EntityDeletedEvent;
|
|
230
|
-
actionEvent?: ActionEvent;
|
|
231
|
-
}
|
|
232
|
-
interface EntityCreatedEvent {
|
|
233
|
-
entityAsJson?: string;
|
|
234
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
235
|
-
restoreInfo?: RestoreInfo;
|
|
236
|
-
}
|
|
237
|
-
interface RestoreInfo {
|
|
238
|
-
deletedDate?: Date | null;
|
|
239
|
-
}
|
|
240
|
-
interface EntityUpdatedEvent {
|
|
241
|
-
/**
|
|
242
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
243
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
244
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
245
|
-
*/
|
|
246
|
-
currentEntityAsJson?: string;
|
|
247
|
-
}
|
|
248
|
-
interface EntityDeletedEvent {
|
|
249
|
-
/** Entity that was deleted. */
|
|
250
|
-
deletedEntityAsJson?: string | null;
|
|
251
|
-
}
|
|
252
|
-
interface ActionEvent {
|
|
253
|
-
bodyAsJson?: string;
|
|
254
|
-
}
|
|
255
|
-
interface MessageEnvelope {
|
|
256
|
-
/**
|
|
257
|
-
* App instance ID.
|
|
258
|
-
* @format GUID
|
|
259
|
-
*/
|
|
260
|
-
instanceId?: string | null;
|
|
261
|
-
/**
|
|
262
|
-
* Event type.
|
|
263
|
-
* @maxLength 150
|
|
264
|
-
*/
|
|
265
|
-
eventType?: string;
|
|
266
|
-
/** The identification type and identity data. */
|
|
267
|
-
identity?: IdentificationData;
|
|
268
|
-
/** Stringify payload. */
|
|
269
|
-
data?: string;
|
|
270
|
-
/** Details related to the account */
|
|
271
|
-
accountInfo?: AccountInfo;
|
|
272
|
-
}
|
|
273
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
274
|
-
/**
|
|
275
|
-
* ID of a site visitor that has not logged in to the site.
|
|
276
|
-
* @format GUID
|
|
277
|
-
*/
|
|
278
|
-
anonymousVisitorId?: string;
|
|
279
|
-
/**
|
|
280
|
-
* ID of a site visitor that has logged in to the site.
|
|
281
|
-
* @format GUID
|
|
282
|
-
*/
|
|
283
|
-
memberId?: string;
|
|
284
|
-
/**
|
|
285
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
286
|
-
* @format GUID
|
|
287
|
-
*/
|
|
288
|
-
wixUserId?: string;
|
|
289
|
-
/**
|
|
290
|
-
* ID of an app.
|
|
291
|
-
* @format GUID
|
|
292
|
-
*/
|
|
293
|
-
appId?: string;
|
|
294
|
-
/** @readonly */
|
|
295
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
296
|
-
}
|
|
297
|
-
/** @oneof */
|
|
298
|
-
interface IdentificationDataIdOneOf {
|
|
299
|
-
/**
|
|
300
|
-
* ID of a site visitor that has not logged in to the site.
|
|
301
|
-
* @format GUID
|
|
302
|
-
*/
|
|
303
|
-
anonymousVisitorId?: string;
|
|
304
|
-
/**
|
|
305
|
-
* ID of a site visitor that has logged in to the site.
|
|
306
|
-
* @format GUID
|
|
307
|
-
*/
|
|
308
|
-
memberId?: string;
|
|
309
|
-
/**
|
|
310
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
311
|
-
* @format GUID
|
|
312
|
-
*/
|
|
313
|
-
wixUserId?: string;
|
|
314
|
-
/**
|
|
315
|
-
* ID of an app.
|
|
316
|
-
* @format GUID
|
|
317
|
-
*/
|
|
318
|
-
appId?: string;
|
|
319
|
-
}
|
|
320
|
-
declare enum WebhookIdentityType {
|
|
321
|
-
UNKNOWN = "UNKNOWN",
|
|
322
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
323
|
-
MEMBER = "MEMBER",
|
|
324
|
-
WIX_USER = "WIX_USER",
|
|
325
|
-
APP = "APP"
|
|
326
|
-
}
|
|
327
|
-
/** @enumType */
|
|
328
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
329
|
-
interface AccountInfo {
|
|
330
|
-
/**
|
|
331
|
-
* ID of the Wix account associated with the event.
|
|
332
|
-
* @format GUID
|
|
333
|
-
*/
|
|
334
|
-
accountId?: string | null;
|
|
335
|
-
/**
|
|
336
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
337
|
-
* @format GUID
|
|
338
|
-
*/
|
|
339
|
-
parentAccountId?: string | null;
|
|
340
|
-
/**
|
|
341
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
342
|
-
* @format GUID
|
|
343
|
-
*/
|
|
344
|
-
siteId?: string | null;
|
|
345
|
-
}
|
|
346
192
|
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
347
193
|
/**
|
|
348
194
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
@@ -658,6 +504,25 @@ interface Sorting {
|
|
|
658
504
|
fieldName?: string;
|
|
659
505
|
/** Sort order. */
|
|
660
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;
|
|
521
|
+
/**
|
|
522
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
523
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
524
|
+
*/
|
|
525
|
+
origin?: AddressLocation;
|
|
661
526
|
}
|
|
662
527
|
declare enum SortOrder {
|
|
663
528
|
ASC = "ASC",
|
|
@@ -665,6 +530,12 @@ declare enum SortOrder {
|
|
|
665
530
|
}
|
|
666
531
|
/** @enumType */
|
|
667
532
|
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
533
|
+
interface AddressLocation {
|
|
534
|
+
/** Address latitude. */
|
|
535
|
+
latitude?: number | null;
|
|
536
|
+
/** Address longitude. */
|
|
537
|
+
longitude?: number | null;
|
|
538
|
+
}
|
|
668
539
|
interface QueryMenusResponse {
|
|
669
540
|
/** Retrieved menus. */
|
|
670
541
|
menus?: Menu[];
|
|
@@ -674,6 +545,11 @@ interface QueryMenusResponse {
|
|
|
674
545
|
interface UpdateMenuRequest {
|
|
675
546
|
/** Menu to update. */
|
|
676
547
|
menu: Menu;
|
|
548
|
+
/**
|
|
549
|
+
* Explicit list of fields to update.
|
|
550
|
+
* @internal
|
|
551
|
+
*/
|
|
552
|
+
mask?: string[];
|
|
677
553
|
}
|
|
678
554
|
interface UpdateMenuResponse {
|
|
679
555
|
/** Updated menu. */
|
|
@@ -762,6 +638,112 @@ interface CloneMenusRequest {
|
|
|
762
638
|
}
|
|
763
639
|
interface CloneMenusResponse {
|
|
764
640
|
}
|
|
641
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
642
|
+
createdEvent?: EntityCreatedEvent;
|
|
643
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
644
|
+
deletedEvent?: EntityDeletedEvent;
|
|
645
|
+
actionEvent?: ActionEvent;
|
|
646
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
647
|
+
id?: string;
|
|
648
|
+
/**
|
|
649
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
650
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
651
|
+
*/
|
|
652
|
+
entityFqdn?: string;
|
|
653
|
+
/**
|
|
654
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
655
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
656
|
+
*/
|
|
657
|
+
slug?: string;
|
|
658
|
+
/** ID of the entity associated with the event. */
|
|
659
|
+
entityId?: string;
|
|
660
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
661
|
+
eventTime?: Date | null;
|
|
662
|
+
/**
|
|
663
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
664
|
+
* (for example, GDPR).
|
|
665
|
+
*/
|
|
666
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
667
|
+
/** If present, indicates the action that triggered the event. */
|
|
668
|
+
originatedFrom?: string | null;
|
|
669
|
+
/**
|
|
670
|
+
* 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.
|
|
671
|
+
* 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.
|
|
672
|
+
*/
|
|
673
|
+
entityEventSequence?: string | null;
|
|
674
|
+
}
|
|
675
|
+
/** @oneof */
|
|
676
|
+
interface DomainEventBodyOneOf {
|
|
677
|
+
createdEvent?: EntityCreatedEvent;
|
|
678
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
679
|
+
deletedEvent?: EntityDeletedEvent;
|
|
680
|
+
actionEvent?: ActionEvent;
|
|
681
|
+
}
|
|
682
|
+
interface EntityCreatedEvent {
|
|
683
|
+
entityAsJson?: string;
|
|
684
|
+
/**
|
|
685
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
686
|
+
* @internal
|
|
687
|
+
*/
|
|
688
|
+
triggeredByUndelete?: boolean | null;
|
|
689
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
690
|
+
restoreInfo?: RestoreInfo;
|
|
691
|
+
/**
|
|
692
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
693
|
+
* @internal
|
|
694
|
+
*/
|
|
695
|
+
additionalMetadataAsJson?: string | null;
|
|
696
|
+
}
|
|
697
|
+
interface RestoreInfo {
|
|
698
|
+
deletedDate?: Date | null;
|
|
699
|
+
}
|
|
700
|
+
interface EntityUpdatedEvent {
|
|
701
|
+
/**
|
|
702
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
703
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
704
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
705
|
+
*/
|
|
706
|
+
currentEntityAsJson?: string;
|
|
707
|
+
/**
|
|
708
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
709
|
+
* wont populate it / have any reference to it in the API.
|
|
710
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
711
|
+
* the developer should send only the new (current) entity.
|
|
712
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
713
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
714
|
+
* @internal
|
|
715
|
+
* @deprecated
|
|
716
|
+
*/
|
|
717
|
+
previousEntityAsJson?: string | null;
|
|
718
|
+
/**
|
|
719
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
720
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
721
|
+
* @internal
|
|
722
|
+
*/
|
|
723
|
+
modifiedFields?: Record<string, any>;
|
|
724
|
+
/**
|
|
725
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
726
|
+
* @internal
|
|
727
|
+
*/
|
|
728
|
+
additionalMetadataAsJson?: string | null;
|
|
729
|
+
}
|
|
730
|
+
interface EntityDeletedEvent {
|
|
731
|
+
/**
|
|
732
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
733
|
+
* @internal
|
|
734
|
+
*/
|
|
735
|
+
movedToTrash?: boolean | null;
|
|
736
|
+
/** Entity that was deleted. */
|
|
737
|
+
deletedEntityAsJson?: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
740
|
+
* @internal
|
|
741
|
+
*/
|
|
742
|
+
additionalMetadataAsJson?: string | null;
|
|
743
|
+
}
|
|
744
|
+
interface ActionEvent {
|
|
745
|
+
bodyAsJson?: string;
|
|
746
|
+
}
|
|
765
747
|
interface Empty {
|
|
766
748
|
}
|
|
767
749
|
interface SyncContentToMultilingualRequest {
|
|
@@ -773,6 +755,121 @@ interface SyncContentToMultilingualRequest {
|
|
|
773
755
|
}
|
|
774
756
|
interface SyncContentToMultilingualResponse {
|
|
775
757
|
}
|
|
758
|
+
interface MessageEnvelope {
|
|
759
|
+
/**
|
|
760
|
+
* App instance ID.
|
|
761
|
+
* @format GUID
|
|
762
|
+
*/
|
|
763
|
+
instanceId?: string | null;
|
|
764
|
+
/**
|
|
765
|
+
* Event type.
|
|
766
|
+
* @maxLength 150
|
|
767
|
+
*/
|
|
768
|
+
eventType?: string;
|
|
769
|
+
/** The identification type and identity data. */
|
|
770
|
+
identity?: IdentificationData;
|
|
771
|
+
/** Stringify payload. */
|
|
772
|
+
data?: string;
|
|
773
|
+
/** Details related to the account */
|
|
774
|
+
accountInfo?: AccountInfo;
|
|
775
|
+
}
|
|
776
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
777
|
+
/**
|
|
778
|
+
* ID of a site visitor that has not logged in to the site.
|
|
779
|
+
* @format GUID
|
|
780
|
+
*/
|
|
781
|
+
anonymousVisitorId?: string;
|
|
782
|
+
/**
|
|
783
|
+
* ID of a site visitor that has logged in to the site.
|
|
784
|
+
* @format GUID
|
|
785
|
+
*/
|
|
786
|
+
memberId?: string;
|
|
787
|
+
/**
|
|
788
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
789
|
+
* @format GUID
|
|
790
|
+
*/
|
|
791
|
+
wixUserId?: string;
|
|
792
|
+
/**
|
|
793
|
+
* ID of an app.
|
|
794
|
+
* @format GUID
|
|
795
|
+
*/
|
|
796
|
+
appId?: string;
|
|
797
|
+
/** @readonly */
|
|
798
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
799
|
+
}
|
|
800
|
+
/** @oneof */
|
|
801
|
+
interface IdentificationDataIdOneOf {
|
|
802
|
+
/**
|
|
803
|
+
* ID of a site visitor that has not logged in to the site.
|
|
804
|
+
* @format GUID
|
|
805
|
+
*/
|
|
806
|
+
anonymousVisitorId?: string;
|
|
807
|
+
/**
|
|
808
|
+
* ID of a site visitor that has logged in to the site.
|
|
809
|
+
* @format GUID
|
|
810
|
+
*/
|
|
811
|
+
memberId?: string;
|
|
812
|
+
/**
|
|
813
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
814
|
+
* @format GUID
|
|
815
|
+
*/
|
|
816
|
+
wixUserId?: string;
|
|
817
|
+
/**
|
|
818
|
+
* ID of an app.
|
|
819
|
+
* @format GUID
|
|
820
|
+
*/
|
|
821
|
+
appId?: string;
|
|
822
|
+
}
|
|
823
|
+
declare enum WebhookIdentityType {
|
|
824
|
+
UNKNOWN = "UNKNOWN",
|
|
825
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
826
|
+
MEMBER = "MEMBER",
|
|
827
|
+
WIX_USER = "WIX_USER",
|
|
828
|
+
APP = "APP"
|
|
829
|
+
}
|
|
830
|
+
/** @enumType */
|
|
831
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
832
|
+
interface AccountInfo {
|
|
833
|
+
/**
|
|
834
|
+
* ID of the Wix account associated with the event.
|
|
835
|
+
* @format GUID
|
|
836
|
+
*/
|
|
837
|
+
accountId?: string | null;
|
|
838
|
+
/**
|
|
839
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
840
|
+
* @format GUID
|
|
841
|
+
*/
|
|
842
|
+
parentAccountId?: string | null;
|
|
843
|
+
/**
|
|
844
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
845
|
+
* @format GUID
|
|
846
|
+
*/
|
|
847
|
+
siteId?: string | null;
|
|
848
|
+
}
|
|
849
|
+
interface DuplicateMenuRequest {
|
|
850
|
+
/**
|
|
851
|
+
* Menu id to be duplicated.
|
|
852
|
+
* @format GUID
|
|
853
|
+
*/
|
|
854
|
+
id: string;
|
|
855
|
+
/**
|
|
856
|
+
* Business location ids to duplicate the menu to.
|
|
857
|
+
* @format GUID
|
|
858
|
+
* @maxSize 100
|
|
859
|
+
*/
|
|
860
|
+
businessLocationIds?: string[] | null;
|
|
861
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
862
|
+
duplicateSubEntities?: boolean | null;
|
|
863
|
+
/**
|
|
864
|
+
* The new name of the duplicated menu.
|
|
865
|
+
* @maxLength 500
|
|
866
|
+
*/
|
|
867
|
+
menuName?: string | null;
|
|
868
|
+
}
|
|
869
|
+
interface DuplicateMenuResponse {
|
|
870
|
+
/** @format GUID */
|
|
871
|
+
menuIds?: string[];
|
|
872
|
+
}
|
|
776
873
|
interface GetMenuSiteUrlRequest {
|
|
777
874
|
/**
|
|
778
875
|
* Menu ID.
|
|
@@ -814,9 +911,6 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
814
911
|
__responseType: Q;
|
|
815
912
|
__originalResponseType: R;
|
|
816
913
|
};
|
|
817
|
-
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
818
|
-
id: string;
|
|
819
|
-
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
820
914
|
declare function createMenu(): __PublicMethodMetaInfo<'POST', {}, CreateMenuRequest$1, CreateMenuRequest, CreateMenuResponse$1, CreateMenuResponse>;
|
|
821
915
|
declare function bulkCreateMenus(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMenusRequest$1, BulkCreateMenusRequest, BulkCreateMenusResponse$1, BulkCreateMenusResponse>;
|
|
822
916
|
declare function getMenu(): __PublicMethodMetaInfo<'GET', {
|
|
@@ -834,9 +928,12 @@ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
|
834
928
|
declare function deleteMenu(): __PublicMethodMetaInfo<'DELETE', {
|
|
835
929
|
menuId: string;
|
|
836
930
|
}, DeleteMenuRequest$1, DeleteMenuRequest, DeleteMenuResponse$1, DeleteMenuResponse>;
|
|
931
|
+
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
932
|
+
id: string;
|
|
933
|
+
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
837
934
|
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
838
935
|
id: string;
|
|
839
936
|
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
840
937
|
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
841
938
|
|
|
842
|
-
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateMenuResult as BulkCreateMenuResultOriginal, type BulkCreateMenusRequest as BulkCreateMenusRequestOriginal, type BulkCreateMenusResponse as BulkCreateMenusResponseOriginal, type BulkMenuResult as BulkMenuResultOriginal, type BulkUpdateMenuRequest as BulkUpdateMenuRequestOriginal, type BulkUpdateMenuResponse as BulkUpdateMenuResponseOriginal, type BusinessLocationDetails as BusinessLocationDetailsOriginal, type CloneMenusRequest as CloneMenusRequestOriginal, type CloneMenusResponse as CloneMenusResponseOriginal, type CreateMenuRequest as CreateMenuRequestOriginal, type CreateMenuResponse as CreateMenuResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteMenuRequest as DeleteMenuRequestOriginal, type DeleteMenuResponse as DeleteMenuResponseOriginal, type DeleteOrphanSections as DeleteOrphanSectionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateMenuRequest as DuplicateMenuRequestOriginal, type DuplicateMenuResponse as DuplicateMenuResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReferenceInfo as ExternalReferenceInfoOriginal, type File as FileOriginal, type GetMenuRequest as GetMenuRequestOriginal, type GetMenuResponse as GetMenuResponseOriginal, type GetMenuSiteUrlRequest as GetMenuSiteUrlRequestOriginal, type GetMenuSiteUrlResponse as GetMenuSiteUrlResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type ListMenusRequest as ListMenusRequestOriginal, type ListMenusResponse as ListMenusResponseOriginal, type MaskedMenu as MaskedMenuOriginal, type Menu as MenuOriginal, type MenuSiteUrl as MenuSiteUrlOriginal, type MenusDataCloningCompleted as MenusDataCloningCompletedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type QueryMenusRequest as QueryMenusRequestOriginal, type QueryMenusResponse as QueryMenusResponseOriginal, type QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequestOriginal, type QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RunMenusMultiLocationMigrationRequest as RunMenusMultiLocationMigrationRequestOriginal, type RunMenusMultiLocationMigrationResponse as RunMenusMultiLocationMigrationResponseOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SyncContentToMultilingualRequest as SyncContentToMultilingualRequestOriginal, type SyncContentToMultilingualResponse as SyncContentToMultilingualResponseOriginal, type Tag as TagOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateBusinessLocationIdRequest as UpdateBusinessLocationIdRequestOriginal, type UpdateBusinessLocationIdResponse as UpdateBusinessLocationIdResponseOriginal, type UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequestOriginal, type UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponseOriginal, type UpdateMenuRequest as UpdateMenuRequestOriginal, type UpdateMenuResponse as UpdateMenuResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, queryMenus, queryMenusSiteUrl, updateExtendedFields, updateMenu };
|
|
939
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AddressLocation as AddressLocationOriginal, type App as AppOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateMenuResult as BulkCreateMenuResultOriginal, type BulkCreateMenusRequest as BulkCreateMenusRequestOriginal, type BulkCreateMenusResponse as BulkCreateMenusResponseOriginal, type BulkMenuResult as BulkMenuResultOriginal, type BulkUpdateMenuRequest as BulkUpdateMenuRequestOriginal, type BulkUpdateMenuResponse as BulkUpdateMenuResponseOriginal, type BusinessLocationDetails as BusinessLocationDetailsOriginal, type CloneMenusRequest as CloneMenusRequestOriginal, type CloneMenusResponse as CloneMenusResponseOriginal, type CreateMenuRequest as CreateMenuRequestOriginal, type CreateMenuResponse as CreateMenuResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, type DeleteMenuRequest as DeleteMenuRequestOriginal, type DeleteMenuResponse as DeleteMenuResponseOriginal, type DeleteOrphanSections as DeleteOrphanSectionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateMenuRequest as DuplicateMenuRequestOriginal, type DuplicateMenuResponse as DuplicateMenuResponseOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReferenceInfo as ExternalReferenceInfoOriginal, type File as FileOriginal, type GetMenuRequest as GetMenuRequestOriginal, type GetMenuResponse as GetMenuResponseOriginal, type GetMenuSiteUrlRequest as GetMenuSiteUrlRequestOriginal, type GetMenuSiteUrlResponse as GetMenuSiteUrlResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type ListMenusRequest as ListMenusRequestOriginal, type ListMenusResponse as ListMenusResponseOriginal, type MaskedMenu as MaskedMenuOriginal, type Menu as MenuOriginal, type MenuSiteUrl as MenuSiteUrlOriginal, type MenusDataCloningCompleted as MenusDataCloningCompletedOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Page as PageOriginal, type Pages as PagesOriginal, type QueryMenusRequest as QueryMenusRequestOriginal, type QueryMenusResponse as QueryMenusResponseOriginal, type QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequestOriginal, type QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RunMenusMultiLocationMigrationRequest as RunMenusMultiLocationMigrationRequestOriginal, type RunMenusMultiLocationMigrationResponse as RunMenusMultiLocationMigrationResponseOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SyncContentToMultilingualRequest as SyncContentToMultilingualRequestOriginal, type SyncContentToMultilingualResponse as SyncContentToMultilingualResponseOriginal, type Tag as TagOriginal, type URI as URIOriginal, type URIs as URIsOriginal, type UpdateBusinessLocationIdRequest as UpdateBusinessLocationIdRequestOriginal, type UpdateBusinessLocationIdResponse as UpdateBusinessLocationIdResponseOriginal, type UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequestOriginal, type UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponseOriginal, type UpdateMenuRequest as UpdateMenuRequestOriginal, type UpdateMenuResponse as UpdateMenuResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateMenus, bulkUpdateMenu, createMenu, deleteMenu, duplicateMenu, getMenu, getMenuSiteUrl, listMenus, queryMenus, queryMenusSiteUrl, updateExtendedFields, updateMenu };
|