@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.
- package/build/cjs/index.d.ts +27 -27
- package/build/cjs/index.js +215 -215
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +613 -552
- package/build/cjs/index.typings.js +173 -173
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +532 -471
- package/build/cjs/meta.js +146 -146
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +27 -27
- package/build/es/index.mjs +215 -215
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +613 -552
- package/build/es/index.typings.mjs +173 -173
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +532 -471
- package/build/es/meta.mjs +146 -146
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +27 -27
- package/build/internal/cjs/index.typings.d.ts +614 -553
- package/build/internal/cjs/meta.d.ts +587 -526
- package/build/internal/es/index.d.mts +27 -27
- package/build/internal/es/index.typings.d.mts +614 -553
- package/build/internal/es/meta.d.mts +587 -526
- package/package.json +4 -4
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DuplicateMenuRequest as DuplicateMenuRequest$1, DuplicateMenuResponse as DuplicateMenuResponse$1, GetMenuSiteUrlRequest as GetMenuSiteUrlRequest$1, GetMenuSiteUrlResponse as GetMenuSiteUrlResponse$1, QueryMenusSiteUrlRequest as QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlResponse as QueryMenusSiteUrlResponse$1, 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 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Menu {
|
|
@@ -71,73 +71,117 @@ interface ExtendedFields {
|
|
|
71
71
|
namespaces?: Record<string, Record<string, any>>;
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
-
* The SEO
|
|
75
|
-
*
|
|
76
|
-
*
|
|
74
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
75
|
+
*
|
|
76
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
77
|
+
* field set must never change (see the file header). New writers use
|
|
78
|
+
* `SeoSchemaV2`.
|
|
79
|
+
*
|
|
80
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
81
|
+
* visible on the page itself. They override every other source of tags
|
|
82
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
77
83
|
*/
|
|
78
84
|
interface SeoSchema {
|
|
79
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
87
|
+
* decided by the renderer, not by position in this list.
|
|
88
|
+
*
|
|
89
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
90
|
+
* a bound added now could reject a page that is already stored.
|
|
91
|
+
*/
|
|
80
92
|
tags?: Tag[];
|
|
81
|
-
/** SEO
|
|
93
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
82
94
|
settings?: Settings;
|
|
83
95
|
}
|
|
96
|
+
/** A keyword term the user is targeting. */
|
|
84
97
|
interface Keyword {
|
|
85
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* The term itself, e.g. "trail running shoes".
|
|
100
|
+
*
|
|
101
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
102
|
+
* already stored, and a bound added now could reject a record written
|
|
103
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
104
|
+
* on this field is accepted deliberately.
|
|
105
|
+
*/
|
|
86
106
|
term?: string;
|
|
87
|
-
/** Whether
|
|
107
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
88
108
|
isMain?: boolean;
|
|
89
109
|
/**
|
|
90
|
-
*
|
|
110
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
111
|
+
* attribution in BI. Opaque to the renderer.
|
|
91
112
|
* @maxLength 1000
|
|
92
113
|
*/
|
|
93
114
|
origin?: string | null;
|
|
94
115
|
}
|
|
116
|
+
/**
|
|
117
|
+
* One tag in the page's <head>.
|
|
118
|
+
*
|
|
119
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
120
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
121
|
+
* normalizes both shapes on READ.
|
|
122
|
+
*/
|
|
95
123
|
interface Tag {
|
|
96
124
|
/**
|
|
97
|
-
*
|
|
125
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
126
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
127
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
98
128
|
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* `title`/`script`/`link` with a validation error even though they appear here —
|
|
106
|
-
* check the field description of the specific `tags`-typed field you're writing to
|
|
107
|
-
* for the types it actually supports and the error it returns.
|
|
129
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
130
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
131
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
132
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
133
|
+
* error even though they appear here — check the field description of the
|
|
134
|
+
* specific `tags`-typed field you are writing to.
|
|
108
135
|
*
|
|
109
136
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
110
|
-
*
|
|
111
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
112
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
113
|
-
* write through the site's Advanced/Custom Tags
|
|
114
|
-
* omit `custom` (or set it to `false`).
|
|
137
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
138
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
139
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
140
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
141
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
142
|
+
*
|
|
143
|
+
* No length limit: this field holds data written years ago by writers we
|
|
144
|
+
* are not migrating. A constraint here could reject a record that is
|
|
145
|
+
* already stored, which is exactly the promise this design makes.
|
|
115
146
|
*/
|
|
116
147
|
type?: string;
|
|
117
148
|
/**
|
|
118
|
-
*
|
|
119
|
-
*
|
|
149
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
150
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
120
151
|
*/
|
|
121
152
|
props?: Record<string, any> | null;
|
|
122
|
-
/**
|
|
153
|
+
/**
|
|
154
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
155
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
156
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
157
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
158
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
159
|
+
* page. See the design log for the full key-by-key mapping.
|
|
160
|
+
*/
|
|
123
161
|
meta?: Record<string, any> | null;
|
|
124
|
-
/**
|
|
162
|
+
/**
|
|
163
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
164
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
165
|
+
* `StructuredDataTag.json_ld`.
|
|
166
|
+
* No length limit, for the same reason as `type` above.
|
|
167
|
+
*/
|
|
125
168
|
children?: string;
|
|
126
169
|
/**
|
|
127
170
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
128
171
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
129
172
|
*
|
|
130
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
131
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
132
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
133
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
134
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
173
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
174
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
175
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
176
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
177
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
135
178
|
*
|
|
136
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
137
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
138
|
-
* for site-wide structured data) unconditionally.
|
|
139
|
-
* site-wide, every-page structured data
|
|
140
|
-
* `script` tag through the Item
|
|
179
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
180
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
181
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
182
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
183
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
184
|
+
* SEO Tags API instead.
|
|
141
185
|
*
|
|
142
186
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
143
187
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -150,22 +194,39 @@ interface Tag {
|
|
|
150
194
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
151
195
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
152
196
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
197
|
+
*
|
|
198
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
153
199
|
*/
|
|
154
200
|
custom?: boolean;
|
|
155
|
-
/**
|
|
201
|
+
/**
|
|
202
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
203
|
+
*
|
|
204
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
205
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
206
|
+
*/
|
|
156
207
|
disabled?: boolean;
|
|
157
208
|
}
|
|
209
|
+
/** Page-level SEO settings that are not tags. */
|
|
158
210
|
interface Settings {
|
|
159
211
|
/**
|
|
160
|
-
* Whether the
|
|
161
|
-
*
|
|
212
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
213
|
+
* its current one after a slug change.
|
|
162
214
|
*
|
|
163
|
-
* Default
|
|
215
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
216
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
217
|
+
* renaming a stored boolean is not worth the migration.
|
|
164
218
|
*/
|
|
165
219
|
preventAutoRedirect?: boolean;
|
|
166
220
|
/**
|
|
167
|
-
*
|
|
168
|
-
*
|
|
221
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
222
|
+
* assistant and checklist; never rendered into <head>.
|
|
223
|
+
*
|
|
224
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
225
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
226
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
227
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
228
|
+
* something absurd.
|
|
229
|
+
* @maxSize 20
|
|
169
230
|
*/
|
|
170
231
|
keywords?: Keyword[];
|
|
171
232
|
}
|
|
@@ -205,168 +266,459 @@ interface ExternalReferenceInfo {
|
|
|
205
266
|
/** Whether the connection to the external system is currently active. */
|
|
206
267
|
connected?: boolean | null;
|
|
207
268
|
}
|
|
208
|
-
interface
|
|
269
|
+
interface DuplicateMenuRequest {
|
|
209
270
|
/**
|
|
210
|
-
*
|
|
271
|
+
* Menu id to be duplicated.
|
|
211
272
|
* @format GUID
|
|
212
273
|
*/
|
|
213
|
-
|
|
274
|
+
id: string;
|
|
214
275
|
/**
|
|
215
|
-
*
|
|
276
|
+
* Business location ids to duplicate the menu to.
|
|
216
277
|
* @format GUID
|
|
278
|
+
* @maxSize 100
|
|
217
279
|
*/
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
|
|
221
|
-
/** Invalidate by page id */
|
|
222
|
-
page?: Page;
|
|
223
|
-
/** Invalidate by URI path */
|
|
224
|
-
uri?: URI;
|
|
225
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
226
|
-
file?: File;
|
|
227
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
228
|
-
customTag?: CustomTag;
|
|
229
|
-
/** Invalidate by multiple page ids */
|
|
230
|
-
pages?: Pages;
|
|
231
|
-
/** Invalidate by multiple URI paths */
|
|
232
|
-
uris?: URIs;
|
|
280
|
+
businessLocationIds?: string[] | null;
|
|
281
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
282
|
+
duplicateSubEntities?: boolean | null;
|
|
233
283
|
/**
|
|
234
|
-
*
|
|
235
|
-
* @maxLength
|
|
284
|
+
* The new name of the duplicated menu.
|
|
285
|
+
* @maxLength 500
|
|
236
286
|
*/
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
287
|
+
menuName?: string | null;
|
|
288
|
+
}
|
|
289
|
+
interface DuplicateMenuResponse {
|
|
290
|
+
/** @format GUID */
|
|
291
|
+
menuIds?: string[];
|
|
292
|
+
}
|
|
293
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
294
|
+
createdEvent?: EntityCreatedEvent;
|
|
295
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
296
|
+
deletedEvent?: EntityDeletedEvent;
|
|
297
|
+
actionEvent?: ActionEvent;
|
|
298
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
299
|
+
id?: string;
|
|
241
300
|
/**
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
* allowing you to confirm when the invalidation has fully propagated.
|
|
245
|
-
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
246
|
-
* @maxLength 256
|
|
301
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
302
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
247
303
|
*/
|
|
248
|
-
|
|
249
|
-
}
|
|
250
|
-
/** @oneof */
|
|
251
|
-
interface InvalidateCacheGetByOneOf {
|
|
304
|
+
entityFqdn?: string;
|
|
252
305
|
/**
|
|
253
|
-
*
|
|
254
|
-
*
|
|
306
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
307
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
255
308
|
*/
|
|
256
|
-
|
|
309
|
+
slug?: string;
|
|
310
|
+
/** ID of the entity associated with the event. */
|
|
311
|
+
entityId?: string;
|
|
312
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
313
|
+
eventTime?: Date | null;
|
|
257
314
|
/**
|
|
258
|
-
*
|
|
259
|
-
*
|
|
315
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
316
|
+
* (for example, GDPR).
|
|
260
317
|
*/
|
|
261
|
-
|
|
262
|
-
/**
|
|
263
|
-
|
|
264
|
-
/** Invalidate by page id */
|
|
265
|
-
page?: Page;
|
|
266
|
-
/** Invalidate by URI path */
|
|
267
|
-
uri?: URI;
|
|
268
|
-
/** Invalidate by file (for media files such as PDFs) */
|
|
269
|
-
file?: File;
|
|
270
|
-
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
271
|
-
customTag?: CustomTag;
|
|
272
|
-
/** Invalidate by multiple page ids */
|
|
273
|
-
pages?: Pages;
|
|
274
|
-
/** Invalidate by multiple URI paths */
|
|
275
|
-
uris?: URIs;
|
|
276
|
-
}
|
|
277
|
-
interface App {
|
|
318
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
319
|
+
/** If present, indicates the action that triggered the event. */
|
|
320
|
+
originatedFrom?: string | null;
|
|
278
321
|
/**
|
|
279
|
-
*
|
|
280
|
-
*
|
|
322
|
+
* 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.
|
|
323
|
+
* 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.
|
|
281
324
|
*/
|
|
282
|
-
|
|
325
|
+
entityEventSequence?: string | null;
|
|
326
|
+
}
|
|
327
|
+
/** @oneof */
|
|
328
|
+
interface DomainEventBodyOneOf {
|
|
329
|
+
createdEvent?: EntityCreatedEvent;
|
|
330
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
331
|
+
deletedEvent?: EntityDeletedEvent;
|
|
332
|
+
actionEvent?: ActionEvent;
|
|
333
|
+
}
|
|
334
|
+
interface EntityCreatedEvent {
|
|
335
|
+
entityAsJson?: string;
|
|
336
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
337
|
+
restoreInfo?: RestoreInfo;
|
|
338
|
+
}
|
|
339
|
+
interface RestoreInfo {
|
|
340
|
+
deletedDate?: Date | null;
|
|
341
|
+
}
|
|
342
|
+
interface EntityUpdatedEvent {
|
|
283
343
|
/**
|
|
284
|
-
*
|
|
285
|
-
*
|
|
344
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
345
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
346
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
286
347
|
*/
|
|
287
|
-
|
|
348
|
+
currentEntityAsJson?: string;
|
|
288
349
|
}
|
|
289
|
-
interface
|
|
350
|
+
interface EntityDeletedEvent {
|
|
351
|
+
/** Entity that was deleted. */
|
|
352
|
+
deletedEntityAsJson?: string | null;
|
|
353
|
+
}
|
|
354
|
+
interface ActionEvent {
|
|
355
|
+
bodyAsJson?: string;
|
|
356
|
+
}
|
|
357
|
+
interface MessageEnvelope {
|
|
290
358
|
/**
|
|
291
|
-
*
|
|
359
|
+
* App instance ID.
|
|
292
360
|
* @format GUID
|
|
293
361
|
*/
|
|
294
|
-
|
|
362
|
+
instanceId?: string | null;
|
|
295
363
|
/**
|
|
296
|
-
*
|
|
297
|
-
* @
|
|
364
|
+
* Event type.
|
|
365
|
+
* @maxLength 150
|
|
298
366
|
*/
|
|
299
|
-
|
|
367
|
+
eventType?: string;
|
|
368
|
+
/** The identification type and identity data. */
|
|
369
|
+
identity?: IdentificationData;
|
|
370
|
+
/** Stringify payload. */
|
|
371
|
+
data?: string;
|
|
372
|
+
/** Details related to the account */
|
|
373
|
+
accountInfo?: AccountInfo;
|
|
300
374
|
}
|
|
301
|
-
interface
|
|
375
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
302
376
|
/**
|
|
303
|
-
*
|
|
377
|
+
* ID of a site visitor that has not logged in to the site.
|
|
304
378
|
* @format GUID
|
|
305
379
|
*/
|
|
306
|
-
|
|
380
|
+
anonymousVisitorId?: string;
|
|
307
381
|
/**
|
|
308
|
-
*
|
|
309
|
-
* @
|
|
382
|
+
* ID of a site visitor that has logged in to the site.
|
|
383
|
+
* @format GUID
|
|
310
384
|
*/
|
|
311
|
-
|
|
312
|
-
}
|
|
313
|
-
interface File {
|
|
385
|
+
memberId?: string;
|
|
314
386
|
/**
|
|
315
|
-
*
|
|
387
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
316
388
|
* @format GUID
|
|
317
389
|
*/
|
|
318
|
-
|
|
390
|
+
wixUserId?: string;
|
|
319
391
|
/**
|
|
320
|
-
*
|
|
321
|
-
* @
|
|
322
|
-
* @maxLength 256
|
|
392
|
+
* ID of an app.
|
|
393
|
+
* @format GUID
|
|
323
394
|
*/
|
|
324
|
-
|
|
395
|
+
appId?: string;
|
|
396
|
+
/** @readonly */
|
|
397
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
325
398
|
}
|
|
326
|
-
|
|
399
|
+
/** @oneof */
|
|
400
|
+
interface IdentificationDataIdOneOf {
|
|
327
401
|
/**
|
|
328
|
-
*
|
|
402
|
+
* ID of a site visitor that has not logged in to the site.
|
|
329
403
|
* @format GUID
|
|
330
404
|
*/
|
|
331
|
-
|
|
405
|
+
anonymousVisitorId?: string;
|
|
332
406
|
/**
|
|
333
|
-
*
|
|
334
|
-
* @
|
|
335
|
-
* @maxLength 256
|
|
407
|
+
* ID of a site visitor that has logged in to the site.
|
|
408
|
+
* @format GUID
|
|
336
409
|
*/
|
|
337
|
-
|
|
338
|
-
}
|
|
339
|
-
interface Pages {
|
|
410
|
+
memberId?: string;
|
|
340
411
|
/**
|
|
341
|
-
*
|
|
412
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
342
413
|
* @format GUID
|
|
343
414
|
*/
|
|
344
|
-
|
|
415
|
+
wixUserId?: string;
|
|
345
416
|
/**
|
|
346
|
-
*
|
|
347
|
-
* @
|
|
348
|
-
* @minLength 1
|
|
417
|
+
* ID of an app.
|
|
418
|
+
* @format GUID
|
|
349
419
|
*/
|
|
350
|
-
|
|
420
|
+
appId?: string;
|
|
351
421
|
}
|
|
352
|
-
|
|
422
|
+
declare enum WebhookIdentityType {
|
|
423
|
+
UNKNOWN = "UNKNOWN",
|
|
424
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
425
|
+
MEMBER = "MEMBER",
|
|
426
|
+
WIX_USER = "WIX_USER",
|
|
427
|
+
APP = "APP"
|
|
428
|
+
}
|
|
429
|
+
/** @enumType */
|
|
430
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
431
|
+
interface AccountInfo {
|
|
353
432
|
/**
|
|
354
|
-
*
|
|
433
|
+
* ID of the Wix account associated with the event.
|
|
355
434
|
* @format GUID
|
|
356
435
|
*/
|
|
357
|
-
|
|
436
|
+
accountId?: string | null;
|
|
358
437
|
/**
|
|
359
|
-
*
|
|
360
|
-
* @
|
|
361
|
-
* @minLength 1
|
|
438
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
439
|
+
* @format GUID
|
|
362
440
|
*/
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
441
|
+
parentAccountId?: string | null;
|
|
442
|
+
/**
|
|
443
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
444
|
+
* @format GUID
|
|
445
|
+
*/
|
|
446
|
+
siteId?: string | null;
|
|
368
447
|
}
|
|
369
|
-
interface
|
|
448
|
+
interface GetMenuSiteUrlRequest {
|
|
449
|
+
/**
|
|
450
|
+
* Menu ID.
|
|
451
|
+
* @format GUID
|
|
452
|
+
* @readonly
|
|
453
|
+
*/
|
|
454
|
+
id: string | null;
|
|
455
|
+
}
|
|
456
|
+
interface GetMenuSiteUrlResponse {
|
|
457
|
+
/** Retrieved menuInfo with path url. */
|
|
458
|
+
menuSiteUrl?: MenuSiteUrl;
|
|
459
|
+
}
|
|
460
|
+
interface MenuSiteUrl {
|
|
461
|
+
/**
|
|
462
|
+
* Path URL.
|
|
463
|
+
* @minLength 1
|
|
464
|
+
* @maxLength 1000
|
|
465
|
+
*/
|
|
466
|
+
path?: string;
|
|
467
|
+
}
|
|
468
|
+
interface QueryMenusSiteUrlRequest {
|
|
469
|
+
/** Query options */
|
|
470
|
+
query?: CursorQuery;
|
|
471
|
+
}
|
|
472
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
473
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
474
|
+
cursorPaging?: CursorPaging;
|
|
475
|
+
/**
|
|
476
|
+
* Filter object in the following format:
|
|
477
|
+
* `"filter" : {
|
|
478
|
+
* "fieldName1": "value1",
|
|
479
|
+
* "fieldName2":{"$operator":"value2"}
|
|
480
|
+
* }`
|
|
481
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
482
|
+
*/
|
|
483
|
+
filter?: Record<string, any> | null;
|
|
484
|
+
/**
|
|
485
|
+
* Sort object in the following format:
|
|
486
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
487
|
+
*/
|
|
488
|
+
sort?: Sorting[];
|
|
489
|
+
}
|
|
490
|
+
/** @oneof */
|
|
491
|
+
interface CursorQueryPagingMethodOneOf {
|
|
492
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
493
|
+
cursorPaging?: CursorPaging;
|
|
494
|
+
}
|
|
495
|
+
interface Sorting {
|
|
496
|
+
/**
|
|
497
|
+
* Name of the field to sort by.
|
|
498
|
+
* @maxLength 512
|
|
499
|
+
*/
|
|
500
|
+
fieldName?: string;
|
|
501
|
+
/** Sort order. */
|
|
502
|
+
order?: SortOrderWithLiterals;
|
|
503
|
+
/**
|
|
504
|
+
* Origin point for geo-distance sorting on a GEO field
|
|
505
|
+
* results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
|
|
506
|
+
*/
|
|
507
|
+
origin?: AddressLocation;
|
|
508
|
+
}
|
|
509
|
+
declare enum SortOrder {
|
|
510
|
+
ASC = "ASC",
|
|
511
|
+
DESC = "DESC"
|
|
512
|
+
}
|
|
513
|
+
/** @enumType */
|
|
514
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
515
|
+
interface AddressLocation {
|
|
516
|
+
/** Address latitude. */
|
|
517
|
+
latitude?: number | null;
|
|
518
|
+
/** Address longitude. */
|
|
519
|
+
longitude?: number | null;
|
|
520
|
+
}
|
|
521
|
+
interface CursorPaging {
|
|
522
|
+
/**
|
|
523
|
+
* Number of items to load.
|
|
524
|
+
* @max 500
|
|
525
|
+
*/
|
|
526
|
+
limit?: number | null;
|
|
527
|
+
/**
|
|
528
|
+
* Pointer to the next or previous page in the list of results.
|
|
529
|
+
*
|
|
530
|
+
* You can get the relevant cursor token
|
|
531
|
+
* from the `pagingMetadata` object in the previous call's response.
|
|
532
|
+
* Not relevant for the first request.
|
|
533
|
+
*/
|
|
534
|
+
cursor?: string | null;
|
|
535
|
+
}
|
|
536
|
+
interface QueryMenusSiteUrlResponse {
|
|
537
|
+
/** Retrieved menuInfos with path urls. */
|
|
538
|
+
menuSiteUrls?: MenuSiteUrl[];
|
|
539
|
+
/** The metadata of the paginated results. */
|
|
540
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
541
|
+
}
|
|
542
|
+
interface CursorPagingMetadata {
|
|
543
|
+
/** Number of items returned in the response. */
|
|
544
|
+
count?: number | null;
|
|
545
|
+
/** Offset that was requested. */
|
|
546
|
+
cursors?: Cursors;
|
|
547
|
+
/**
|
|
548
|
+
* Indicates if there are more results after the current page.
|
|
549
|
+
* If `true`, another page of results can be retrieved.
|
|
550
|
+
* If `false`, this is the last page.
|
|
551
|
+
*/
|
|
552
|
+
hasNext?: boolean | null;
|
|
553
|
+
}
|
|
554
|
+
interface Cursors {
|
|
555
|
+
/** Cursor pointing to next page in the list of results. */
|
|
556
|
+
next?: string | null;
|
|
557
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
558
|
+
prev?: string | null;
|
|
559
|
+
}
|
|
560
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
561
|
+
/**
|
|
562
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
563
|
+
* @format GUID
|
|
564
|
+
*/
|
|
565
|
+
metaSiteId?: string;
|
|
566
|
+
/**
|
|
567
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
568
|
+
* @format GUID
|
|
569
|
+
*/
|
|
570
|
+
siteId?: string;
|
|
571
|
+
/** Invalidate by App */
|
|
572
|
+
app?: App;
|
|
573
|
+
/** Invalidate by page id */
|
|
574
|
+
page?: Page;
|
|
575
|
+
/** Invalidate by URI path */
|
|
576
|
+
uri?: URI;
|
|
577
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
578
|
+
file?: File;
|
|
579
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
580
|
+
customTag?: CustomTag;
|
|
581
|
+
/** Invalidate by multiple page ids */
|
|
582
|
+
pages?: Pages;
|
|
583
|
+
/** Invalidate by multiple URI paths */
|
|
584
|
+
uris?: URIs;
|
|
585
|
+
/**
|
|
586
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
587
|
+
* @maxLength 256
|
|
588
|
+
*/
|
|
589
|
+
reason?: string | null;
|
|
590
|
+
/** Is local DS */
|
|
591
|
+
localDc?: boolean;
|
|
592
|
+
hardPurge?: boolean;
|
|
593
|
+
/**
|
|
594
|
+
* Optional caller-provided ID for tracking this invalidation through the system.
|
|
595
|
+
* When set, the corresponding CDN purge completion event will include this ID,
|
|
596
|
+
* allowing you to confirm when the invalidation has fully propagated.
|
|
597
|
+
* Example: generate a UUID, pass it here, and later match it in the CDN purge completion event.
|
|
598
|
+
* @maxLength 256
|
|
599
|
+
*/
|
|
600
|
+
correlationId?: string | null;
|
|
601
|
+
}
|
|
602
|
+
/** @oneof */
|
|
603
|
+
interface InvalidateCacheGetByOneOf {
|
|
604
|
+
/**
|
|
605
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
606
|
+
* @format GUID
|
|
607
|
+
*/
|
|
608
|
+
metaSiteId?: string;
|
|
609
|
+
/**
|
|
610
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
611
|
+
* @format GUID
|
|
612
|
+
*/
|
|
613
|
+
siteId?: string;
|
|
614
|
+
/** Invalidate by App */
|
|
615
|
+
app?: App;
|
|
616
|
+
/** Invalidate by page id */
|
|
617
|
+
page?: Page;
|
|
618
|
+
/** Invalidate by URI path */
|
|
619
|
+
uri?: URI;
|
|
620
|
+
/** Invalidate by file (for media files such as PDFs) */
|
|
621
|
+
file?: File;
|
|
622
|
+
/** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
|
|
623
|
+
customTag?: CustomTag;
|
|
624
|
+
/** Invalidate by multiple page ids */
|
|
625
|
+
pages?: Pages;
|
|
626
|
+
/** Invalidate by multiple URI paths */
|
|
627
|
+
uris?: URIs;
|
|
628
|
+
}
|
|
629
|
+
interface App {
|
|
630
|
+
/**
|
|
631
|
+
* The AppDefId
|
|
632
|
+
* @minLength 1
|
|
633
|
+
*/
|
|
634
|
+
appDefId?: string;
|
|
635
|
+
/**
|
|
636
|
+
* The instance Id
|
|
637
|
+
* @format GUID
|
|
638
|
+
*/
|
|
639
|
+
instanceId?: string;
|
|
640
|
+
}
|
|
641
|
+
interface Page {
|
|
642
|
+
/**
|
|
643
|
+
* the msid the page is on
|
|
644
|
+
* @format GUID
|
|
645
|
+
*/
|
|
646
|
+
metaSiteId?: string;
|
|
647
|
+
/**
|
|
648
|
+
* Invalidate by Page ID
|
|
649
|
+
* @minLength 1
|
|
650
|
+
*/
|
|
651
|
+
pageId?: string;
|
|
652
|
+
}
|
|
653
|
+
interface URI {
|
|
654
|
+
/**
|
|
655
|
+
* the msid the URI is on
|
|
656
|
+
* @format GUID
|
|
657
|
+
*/
|
|
658
|
+
metaSiteId?: string;
|
|
659
|
+
/**
|
|
660
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
661
|
+
* @minLength 1
|
|
662
|
+
*/
|
|
663
|
+
uriPath?: string;
|
|
664
|
+
}
|
|
665
|
+
interface File {
|
|
666
|
+
/**
|
|
667
|
+
* the msid the file is related to
|
|
668
|
+
* @format GUID
|
|
669
|
+
*/
|
|
670
|
+
metaSiteId?: string;
|
|
671
|
+
/**
|
|
672
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
673
|
+
* @minLength 1
|
|
674
|
+
* @maxLength 256
|
|
675
|
+
*/
|
|
676
|
+
fileName?: string;
|
|
677
|
+
}
|
|
678
|
+
interface CustomTag {
|
|
679
|
+
/**
|
|
680
|
+
* the msid the tag is related to
|
|
681
|
+
* @format GUID
|
|
682
|
+
*/
|
|
683
|
+
metaSiteId?: string;
|
|
684
|
+
/**
|
|
685
|
+
* Tag to invalidate by
|
|
686
|
+
* @minLength 1
|
|
687
|
+
* @maxLength 256
|
|
688
|
+
*/
|
|
689
|
+
tag?: string;
|
|
690
|
+
}
|
|
691
|
+
interface Pages {
|
|
692
|
+
/**
|
|
693
|
+
* the msid the pages are on
|
|
694
|
+
* @format GUID
|
|
695
|
+
*/
|
|
696
|
+
metaSiteId?: string;
|
|
697
|
+
/**
|
|
698
|
+
* Invalidate by multiple Page IDs in a single message
|
|
699
|
+
* @maxSize 100
|
|
700
|
+
* @minLength 1
|
|
701
|
+
*/
|
|
702
|
+
pageIds?: string[];
|
|
703
|
+
}
|
|
704
|
+
interface URIs {
|
|
705
|
+
/**
|
|
706
|
+
* the msid the URIs are on
|
|
707
|
+
* @format GUID
|
|
708
|
+
*/
|
|
709
|
+
metaSiteId?: string;
|
|
710
|
+
/**
|
|
711
|
+
* URI paths to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
712
|
+
* @maxSize 100
|
|
713
|
+
* @minLength 1
|
|
714
|
+
*/
|
|
715
|
+
uriPaths?: string[];
|
|
716
|
+
}
|
|
717
|
+
interface DeleteOrphanSections {
|
|
718
|
+
/** Menu id */
|
|
719
|
+
menuId?: string;
|
|
720
|
+
}
|
|
721
|
+
interface MenusDataCloningCompleted {
|
|
370
722
|
}
|
|
371
723
|
interface CreateMenuRequest {
|
|
372
724
|
/** Menu details. */
|
|
@@ -431,112 +783,30 @@ interface GetMenuRequest {
|
|
|
431
783
|
menuId: string;
|
|
432
784
|
}
|
|
433
785
|
interface GetMenuResponse {
|
|
434
|
-
/** Menu. */
|
|
435
|
-
menu?: Menu;
|
|
436
|
-
}
|
|
437
|
-
interface ListMenusRequest {
|
|
438
|
-
/**
|
|
439
|
-
* Menu IDs.
|
|
440
|
-
* @format GUID
|
|
441
|
-
* @maxSize 500
|
|
442
|
-
*/
|
|
443
|
-
menuIds?: string[];
|
|
444
|
-
/** The metadata of the paginated results. */
|
|
445
|
-
paging?: CursorPaging;
|
|
446
|
-
/** Whether to return only menus that are visible to site visitors. */
|
|
447
|
-
onlyVisible?: boolean | null;
|
|
448
|
-
}
|
|
449
|
-
interface CursorPaging {
|
|
450
|
-
/**
|
|
451
|
-
* Number of items to load.
|
|
452
|
-
* @max 500
|
|
453
|
-
*/
|
|
454
|
-
limit?: number | null;
|
|
455
|
-
/**
|
|
456
|
-
* Pointer to the next or previous page in the list of results.
|
|
457
|
-
*
|
|
458
|
-
* You can get the relevant cursor token
|
|
459
|
-
* from the `pagingMetadata` object in the previous call's response.
|
|
460
|
-
* Not relevant for the first request.
|
|
461
|
-
*/
|
|
462
|
-
cursor?: string | null;
|
|
463
|
-
}
|
|
464
|
-
interface ListMenusResponse {
|
|
465
|
-
/** Retrieved menus. */
|
|
466
|
-
menus?: Menu[];
|
|
467
|
-
/** The metadata of the paginated results. */
|
|
468
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
469
|
-
}
|
|
470
|
-
interface CursorPagingMetadata {
|
|
471
|
-
/** Number of items returned in the response. */
|
|
472
|
-
count?: number | null;
|
|
473
|
-
/** Offset that was requested. */
|
|
474
|
-
cursors?: Cursors;
|
|
475
|
-
/**
|
|
476
|
-
* Indicates if there are more results after the current page.
|
|
477
|
-
* If `true`, another page of results can be retrieved.
|
|
478
|
-
* If `false`, this is the last page.
|
|
479
|
-
*/
|
|
480
|
-
hasNext?: boolean | null;
|
|
481
|
-
}
|
|
482
|
-
interface Cursors {
|
|
483
|
-
/** Cursor pointing to next page in the list of results. */
|
|
484
|
-
next?: string | null;
|
|
485
|
-
/** Cursor pointing to previous page in the list of results. */
|
|
486
|
-
prev?: string | null;
|
|
487
|
-
}
|
|
488
|
-
interface QueryMenusRequest {
|
|
489
|
-
/** Query options. */
|
|
490
|
-
query?: CursorQuery;
|
|
491
|
-
}
|
|
492
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
493
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
494
|
-
cursorPaging?: CursorPaging;
|
|
495
|
-
/**
|
|
496
|
-
* Filter object in the following format:
|
|
497
|
-
* `"filter" : {
|
|
498
|
-
* "fieldName1": "value1",
|
|
499
|
-
* "fieldName2":{"$operator":"value2"}
|
|
500
|
-
* }`
|
|
501
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
502
|
-
*/
|
|
503
|
-
filter?: Record<string, any> | null;
|
|
504
|
-
/**
|
|
505
|
-
* Sort object in the following format:
|
|
506
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
507
|
-
*/
|
|
508
|
-
sort?: Sorting[];
|
|
509
|
-
}
|
|
510
|
-
/** @oneof */
|
|
511
|
-
interface CursorQueryPagingMethodOneOf {
|
|
512
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
513
|
-
cursorPaging?: CursorPaging;
|
|
514
|
-
}
|
|
515
|
-
interface Sorting {
|
|
516
|
-
/**
|
|
517
|
-
* Name of the field to sort by.
|
|
518
|
-
* @maxLength 512
|
|
519
|
-
*/
|
|
520
|
-
fieldName?: string;
|
|
521
|
-
/** Sort order. */
|
|
522
|
-
order?: SortOrderWithLiterals;
|
|
786
|
+
/** Menu. */
|
|
787
|
+
menu?: Menu;
|
|
788
|
+
}
|
|
789
|
+
interface ListMenusRequest {
|
|
523
790
|
/**
|
|
524
|
-
*
|
|
525
|
-
*
|
|
791
|
+
* Menu IDs.
|
|
792
|
+
* @format GUID
|
|
793
|
+
* @maxSize 500
|
|
526
794
|
*/
|
|
527
|
-
|
|
795
|
+
menuIds?: string[];
|
|
796
|
+
/** The metadata of the paginated results. */
|
|
797
|
+
paging?: CursorPaging;
|
|
798
|
+
/** Whether to return only menus that are visible to site visitors. */
|
|
799
|
+
onlyVisible?: boolean | null;
|
|
528
800
|
}
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
801
|
+
interface ListMenusResponse {
|
|
802
|
+
/** Retrieved menus. */
|
|
803
|
+
menus?: Menu[];
|
|
804
|
+
/** The metadata of the paginated results. */
|
|
805
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
532
806
|
}
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
/** Address latitude. */
|
|
537
|
-
latitude?: number | null;
|
|
538
|
-
/** Address longitude. */
|
|
539
|
-
longitude?: number | null;
|
|
807
|
+
interface QueryMenusRequest {
|
|
808
|
+
/** Query options. */
|
|
809
|
+
query?: CursorQuery;
|
|
540
810
|
}
|
|
541
811
|
interface QueryMenusResponse {
|
|
542
812
|
/** Retrieved menus. */
|
|
@@ -635,70 +905,6 @@ interface CloneMenusRequest {
|
|
|
635
905
|
}
|
|
636
906
|
interface CloneMenusResponse {
|
|
637
907
|
}
|
|
638
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
639
|
-
createdEvent?: EntityCreatedEvent;
|
|
640
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
641
|
-
deletedEvent?: EntityDeletedEvent;
|
|
642
|
-
actionEvent?: ActionEvent;
|
|
643
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
644
|
-
id?: string;
|
|
645
|
-
/**
|
|
646
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
647
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
648
|
-
*/
|
|
649
|
-
entityFqdn?: string;
|
|
650
|
-
/**
|
|
651
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
652
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
653
|
-
*/
|
|
654
|
-
slug?: string;
|
|
655
|
-
/** ID of the entity associated with the event. */
|
|
656
|
-
entityId?: string;
|
|
657
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
658
|
-
eventTime?: Date | null;
|
|
659
|
-
/**
|
|
660
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
661
|
-
* (for example, GDPR).
|
|
662
|
-
*/
|
|
663
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
664
|
-
/** If present, indicates the action that triggered the event. */
|
|
665
|
-
originatedFrom?: string | null;
|
|
666
|
-
/**
|
|
667
|
-
* 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.
|
|
668
|
-
* 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.
|
|
669
|
-
*/
|
|
670
|
-
entityEventSequence?: string | null;
|
|
671
|
-
}
|
|
672
|
-
/** @oneof */
|
|
673
|
-
interface DomainEventBodyOneOf {
|
|
674
|
-
createdEvent?: EntityCreatedEvent;
|
|
675
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
676
|
-
deletedEvent?: EntityDeletedEvent;
|
|
677
|
-
actionEvent?: ActionEvent;
|
|
678
|
-
}
|
|
679
|
-
interface EntityCreatedEvent {
|
|
680
|
-
entityAsJson?: string;
|
|
681
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
682
|
-
restoreInfo?: RestoreInfo;
|
|
683
|
-
}
|
|
684
|
-
interface RestoreInfo {
|
|
685
|
-
deletedDate?: Date | null;
|
|
686
|
-
}
|
|
687
|
-
interface EntityUpdatedEvent {
|
|
688
|
-
/**
|
|
689
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
690
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
691
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
692
|
-
*/
|
|
693
|
-
currentEntityAsJson?: string;
|
|
694
|
-
}
|
|
695
|
-
interface EntityDeletedEvent {
|
|
696
|
-
/** Entity that was deleted. */
|
|
697
|
-
deletedEntityAsJson?: string | null;
|
|
698
|
-
}
|
|
699
|
-
interface ActionEvent {
|
|
700
|
-
bodyAsJson?: string;
|
|
701
|
-
}
|
|
702
908
|
interface Empty {
|
|
703
909
|
}
|
|
704
910
|
interface SyncContentToMultilingualRequest {
|
|
@@ -710,151 +916,6 @@ interface SyncContentToMultilingualRequest {
|
|
|
710
916
|
}
|
|
711
917
|
interface SyncContentToMultilingualResponse {
|
|
712
918
|
}
|
|
713
|
-
interface MessageEnvelope {
|
|
714
|
-
/**
|
|
715
|
-
* App instance ID.
|
|
716
|
-
* @format GUID
|
|
717
|
-
*/
|
|
718
|
-
instanceId?: string | null;
|
|
719
|
-
/**
|
|
720
|
-
* Event type.
|
|
721
|
-
* @maxLength 150
|
|
722
|
-
*/
|
|
723
|
-
eventType?: string;
|
|
724
|
-
/** The identification type and identity data. */
|
|
725
|
-
identity?: IdentificationData;
|
|
726
|
-
/** Stringify payload. */
|
|
727
|
-
data?: string;
|
|
728
|
-
/** Details related to the account */
|
|
729
|
-
accountInfo?: AccountInfo;
|
|
730
|
-
}
|
|
731
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
732
|
-
/**
|
|
733
|
-
* ID of a site visitor that has not logged in to the site.
|
|
734
|
-
* @format GUID
|
|
735
|
-
*/
|
|
736
|
-
anonymousVisitorId?: string;
|
|
737
|
-
/**
|
|
738
|
-
* ID of a site visitor that has logged in to the site.
|
|
739
|
-
* @format GUID
|
|
740
|
-
*/
|
|
741
|
-
memberId?: string;
|
|
742
|
-
/**
|
|
743
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
744
|
-
* @format GUID
|
|
745
|
-
*/
|
|
746
|
-
wixUserId?: string;
|
|
747
|
-
/**
|
|
748
|
-
* ID of an app.
|
|
749
|
-
* @format GUID
|
|
750
|
-
*/
|
|
751
|
-
appId?: string;
|
|
752
|
-
/** @readonly */
|
|
753
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
754
|
-
}
|
|
755
|
-
/** @oneof */
|
|
756
|
-
interface IdentificationDataIdOneOf {
|
|
757
|
-
/**
|
|
758
|
-
* ID of a site visitor that has not logged in to the site.
|
|
759
|
-
* @format GUID
|
|
760
|
-
*/
|
|
761
|
-
anonymousVisitorId?: string;
|
|
762
|
-
/**
|
|
763
|
-
* ID of a site visitor that has logged in to the site.
|
|
764
|
-
* @format GUID
|
|
765
|
-
*/
|
|
766
|
-
memberId?: string;
|
|
767
|
-
/**
|
|
768
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
769
|
-
* @format GUID
|
|
770
|
-
*/
|
|
771
|
-
wixUserId?: string;
|
|
772
|
-
/**
|
|
773
|
-
* ID of an app.
|
|
774
|
-
* @format GUID
|
|
775
|
-
*/
|
|
776
|
-
appId?: string;
|
|
777
|
-
}
|
|
778
|
-
declare enum WebhookIdentityType {
|
|
779
|
-
UNKNOWN = "UNKNOWN",
|
|
780
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
781
|
-
MEMBER = "MEMBER",
|
|
782
|
-
WIX_USER = "WIX_USER",
|
|
783
|
-
APP = "APP"
|
|
784
|
-
}
|
|
785
|
-
/** @enumType */
|
|
786
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
787
|
-
interface AccountInfo {
|
|
788
|
-
/**
|
|
789
|
-
* ID of the Wix account associated with the event.
|
|
790
|
-
* @format GUID
|
|
791
|
-
*/
|
|
792
|
-
accountId?: string | null;
|
|
793
|
-
/**
|
|
794
|
-
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
795
|
-
* @format GUID
|
|
796
|
-
*/
|
|
797
|
-
parentAccountId?: string | null;
|
|
798
|
-
/**
|
|
799
|
-
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
800
|
-
* @format GUID
|
|
801
|
-
*/
|
|
802
|
-
siteId?: string | null;
|
|
803
|
-
}
|
|
804
|
-
interface DuplicateMenuRequest {
|
|
805
|
-
/**
|
|
806
|
-
* Menu id to be duplicated.
|
|
807
|
-
* @format GUID
|
|
808
|
-
*/
|
|
809
|
-
id: string;
|
|
810
|
-
/**
|
|
811
|
-
* Business location ids to duplicate the menu to.
|
|
812
|
-
* @format GUID
|
|
813
|
-
* @maxSize 100
|
|
814
|
-
*/
|
|
815
|
-
businessLocationIds?: string[] | null;
|
|
816
|
-
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
817
|
-
duplicateSubEntities?: boolean | null;
|
|
818
|
-
/**
|
|
819
|
-
* The new name of the duplicated menu.
|
|
820
|
-
* @maxLength 500
|
|
821
|
-
*/
|
|
822
|
-
menuName?: string | null;
|
|
823
|
-
}
|
|
824
|
-
interface DuplicateMenuResponse {
|
|
825
|
-
/** @format GUID */
|
|
826
|
-
menuIds?: string[];
|
|
827
|
-
}
|
|
828
|
-
interface GetMenuSiteUrlRequest {
|
|
829
|
-
/**
|
|
830
|
-
* Menu ID.
|
|
831
|
-
* @format GUID
|
|
832
|
-
* @readonly
|
|
833
|
-
*/
|
|
834
|
-
id: string | null;
|
|
835
|
-
}
|
|
836
|
-
interface GetMenuSiteUrlResponse {
|
|
837
|
-
/** Retrieved menuInfo with path url. */
|
|
838
|
-
menuSiteUrl?: MenuSiteUrl;
|
|
839
|
-
}
|
|
840
|
-
interface MenuSiteUrl {
|
|
841
|
-
/**
|
|
842
|
-
* Path URL.
|
|
843
|
-
* @minLength 1
|
|
844
|
-
* @maxLength 1000
|
|
845
|
-
*/
|
|
846
|
-
path?: string;
|
|
847
|
-
}
|
|
848
|
-
interface QueryMenusSiteUrlRequest {
|
|
849
|
-
/** Query options */
|
|
850
|
-
query?: CursorQuery;
|
|
851
|
-
}
|
|
852
|
-
interface QueryMenusSiteUrlResponse {
|
|
853
|
-
/** Retrieved menuInfos with path urls. */
|
|
854
|
-
menuSiteUrls?: MenuSiteUrl[];
|
|
855
|
-
/** The metadata of the paginated results. */
|
|
856
|
-
pagingMetadata?: CursorPagingMetadata;
|
|
857
|
-
}
|
|
858
919
|
|
|
859
920
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
860
921
|
getUrl: (context: any) => string;
|
|
@@ -866,6 +927,13 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
866
927
|
__responseType: Q;
|
|
867
928
|
__originalResponseType: R;
|
|
868
929
|
};
|
|
930
|
+
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
931
|
+
id: string;
|
|
932
|
+
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
933
|
+
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
934
|
+
id: string;
|
|
935
|
+
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
936
|
+
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
869
937
|
declare function createMenu(): __PublicMethodMetaInfo<'POST', {}, CreateMenuRequest$1, CreateMenuRequest, CreateMenuResponse$1, CreateMenuResponse>;
|
|
870
938
|
declare function bulkCreateMenus(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMenusRequest$1, BulkCreateMenusRequest, BulkCreateMenusResponse$1, BulkCreateMenusResponse>;
|
|
871
939
|
declare function getMenu(): __PublicMethodMetaInfo<'GET', {
|
|
@@ -883,12 +951,5 @@ declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', {
|
|
|
883
951
|
declare function deleteMenu(): __PublicMethodMetaInfo<'DELETE', {
|
|
884
952
|
menuId: string;
|
|
885
953
|
}, DeleteMenuRequest$1, DeleteMenuRequest, DeleteMenuResponse$1, DeleteMenuResponse>;
|
|
886
|
-
declare function duplicateMenu(): __PublicMethodMetaInfo<'POST', {
|
|
887
|
-
id: string;
|
|
888
|
-
}, DuplicateMenuRequest$1, DuplicateMenuRequest, DuplicateMenuResponse$1, DuplicateMenuResponse>;
|
|
889
|
-
declare function getMenuSiteUrl(): __PublicMethodMetaInfo<'GET', {
|
|
890
|
-
id: string;
|
|
891
|
-
}, GetMenuSiteUrlRequest$1, GetMenuSiteUrlRequest, GetMenuSiteUrlResponse$1, GetMenuSiteUrlResponse>;
|
|
892
|
-
declare function queryMenusSiteUrl(): __PublicMethodMetaInfo<'POST', {}, QueryMenusSiteUrlRequest$1, QueryMenusSiteUrlRequest, QueryMenusSiteUrlResponse$1, QueryMenusSiteUrlResponse>;
|
|
893
954
|
|
|
894
955
|
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 };
|