@wix/auto_sdk_restaurants_sections 1.0.1 → 1.0.3
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/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
- package/build/cjs/src/restaurants-menus-v1-section-sections.context.js +2 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.http.js +81 -2
- package/build/cjs/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
- package/build/cjs/src/restaurants-menus-v1-section-sections.meta.js +20 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
- package/build/cjs/src/restaurants-menus-v1-section-sections.public.js +7 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
- package/build/cjs/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.universal.d.ts +292 -69
- package/build/cjs/src/restaurants-menus-v1-section-sections.universal.js +59 -26
- package/build/cjs/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
- package/build/es/src/restaurants-menus-v1-section-sections.context.js +2 -1
- package/build/es/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.http.js +79 -1
- package/build/es/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
- package/build/es/src/restaurants-menus-v1-section-sections.meta.js +18 -0
- package/build/es/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
- package/build/es/src/restaurants-menus-v1-section-sections.public.js +6 -1
- package/build/es/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
- package/build/es/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
- package/build/es/src/restaurants-menus-v1-section-sections.universal.d.ts +292 -69
- package/build/es/src/restaurants-menus-v1-section-sections.universal.js +57 -25
- package/build/es/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.js +2 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.js +81 -2
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.js +20 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.js +7 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.d.ts +292 -69
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.js +59 -26
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
- package/build/internal/es/src/restaurants-menus-v1-section-sections.context.js +2 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.http.js +79 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
- package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.js +18 -0
- package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
- package/build/internal/es/src/restaurants-menus-v1-section-sections.public.js +6 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
- package/build/internal/es/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.d.ts +292 -69
- package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.js +57 -25
- package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export interface Section {
|
|
2
2
|
/**
|
|
3
3
|
* Section ID.
|
|
4
|
+
* @format GUID
|
|
4
5
|
* @readonly
|
|
5
6
|
*/
|
|
6
7
|
_id?: string | null;
|
|
@@ -19,15 +20,29 @@ export interface Section {
|
|
|
19
20
|
* @readonly
|
|
20
21
|
*/
|
|
21
22
|
_updatedDate?: Date | null;
|
|
22
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Section name.
|
|
25
|
+
* @minLength 1
|
|
26
|
+
* @maxLength 500
|
|
27
|
+
*/
|
|
23
28
|
name?: string;
|
|
24
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* Section description.
|
|
31
|
+
* @maxLength 1500
|
|
32
|
+
*/
|
|
25
33
|
description?: string | null;
|
|
26
34
|
/** Main section image. */
|
|
27
35
|
image?: string;
|
|
28
|
-
/**
|
|
36
|
+
/**
|
|
37
|
+
* Additional section images.
|
|
38
|
+
* @maxSize 100
|
|
39
|
+
*/
|
|
29
40
|
additionalImages?: string[];
|
|
30
|
-
/**
|
|
41
|
+
/**
|
|
42
|
+
* Item IDs.
|
|
43
|
+
* @format GUID
|
|
44
|
+
* @maxSize 1000
|
|
45
|
+
*/
|
|
31
46
|
itemIds?: string[];
|
|
32
47
|
/** Extended fields. */
|
|
33
48
|
extendedFields?: ExtendedFields;
|
|
@@ -45,10 +60,35 @@ export interface ExtendedFields {
|
|
|
45
60
|
*/
|
|
46
61
|
namespaces?: Record<string, Record<string, any>>;
|
|
47
62
|
}
|
|
63
|
+
export interface DuplicateSectionRequest {
|
|
64
|
+
/**
|
|
65
|
+
* Section id to be duplicated.
|
|
66
|
+
* @format GUID
|
|
67
|
+
*/
|
|
68
|
+
_id: string;
|
|
69
|
+
/**
|
|
70
|
+
* Business location ids to duplicate the section to.
|
|
71
|
+
* @format GUID
|
|
72
|
+
* @maxSize 100
|
|
73
|
+
*/
|
|
74
|
+
businessLocationIds?: string[] | null;
|
|
75
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
76
|
+
duplicateSubEntities?: boolean | null;
|
|
77
|
+
}
|
|
78
|
+
export interface DuplicateSectionResponse {
|
|
79
|
+
/** @format GUID */
|
|
80
|
+
sectionId?: string[];
|
|
81
|
+
}
|
|
48
82
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
49
|
-
/**
|
|
83
|
+
/**
|
|
84
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
85
|
+
* @format GUID
|
|
86
|
+
*/
|
|
50
87
|
metaSiteId?: string;
|
|
51
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
90
|
+
* @format GUID
|
|
91
|
+
*/
|
|
52
92
|
siteId?: string;
|
|
53
93
|
/** Invalidate by App */
|
|
54
94
|
app?: App;
|
|
@@ -58,7 +98,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
58
98
|
uri?: URI;
|
|
59
99
|
/** Invalidate by file (for media files such as PDFs) */
|
|
60
100
|
file?: File;
|
|
61
|
-
/**
|
|
101
|
+
/**
|
|
102
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
103
|
+
* @maxLength 256
|
|
104
|
+
*/
|
|
62
105
|
reason?: string | null;
|
|
63
106
|
/** Is local DS */
|
|
64
107
|
localDc?: boolean;
|
|
@@ -66,9 +109,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
66
109
|
}
|
|
67
110
|
/** @oneof */
|
|
68
111
|
export interface InvalidateCacheGetByOneOf {
|
|
69
|
-
/**
|
|
112
|
+
/**
|
|
113
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
114
|
+
* @format GUID
|
|
115
|
+
*/
|
|
70
116
|
metaSiteId?: string;
|
|
71
|
-
/**
|
|
117
|
+
/**
|
|
118
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
119
|
+
* @format GUID
|
|
120
|
+
*/
|
|
72
121
|
siteId?: string;
|
|
73
122
|
/** Invalidate by App */
|
|
74
123
|
app?: App;
|
|
@@ -80,27 +129,52 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
80
129
|
file?: File;
|
|
81
130
|
}
|
|
82
131
|
export interface App {
|
|
83
|
-
/**
|
|
132
|
+
/**
|
|
133
|
+
* The AppDefId
|
|
134
|
+
* @minLength 1
|
|
135
|
+
*/
|
|
84
136
|
appDefId?: string;
|
|
85
|
-
/**
|
|
137
|
+
/**
|
|
138
|
+
* The instance Id
|
|
139
|
+
* @format GUID
|
|
140
|
+
*/
|
|
86
141
|
instanceId?: string;
|
|
87
142
|
}
|
|
88
143
|
export interface Page {
|
|
89
|
-
/**
|
|
144
|
+
/**
|
|
145
|
+
* the msid the page is on
|
|
146
|
+
* @format GUID
|
|
147
|
+
*/
|
|
90
148
|
metaSiteId?: string;
|
|
91
|
-
/**
|
|
149
|
+
/**
|
|
150
|
+
* Invalidate by Page ID
|
|
151
|
+
* @minLength 1
|
|
152
|
+
*/
|
|
92
153
|
pageId?: string;
|
|
93
154
|
}
|
|
94
155
|
export interface URI {
|
|
95
|
-
/**
|
|
156
|
+
/**
|
|
157
|
+
* the msid the URI is on
|
|
158
|
+
* @format GUID
|
|
159
|
+
*/
|
|
96
160
|
metaSiteId?: string;
|
|
97
|
-
/**
|
|
161
|
+
/**
|
|
162
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
163
|
+
* @minLength 1
|
|
164
|
+
*/
|
|
98
165
|
uriPath?: string;
|
|
99
166
|
}
|
|
100
167
|
export interface File {
|
|
101
|
-
/**
|
|
168
|
+
/**
|
|
169
|
+
* the msid the file is related to
|
|
170
|
+
* @format GUID
|
|
171
|
+
*/
|
|
102
172
|
metaSiteId?: string;
|
|
103
|
-
/**
|
|
173
|
+
/**
|
|
174
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
175
|
+
* @minLength 1
|
|
176
|
+
* @maxLength 256
|
|
177
|
+
*/
|
|
104
178
|
fileName?: string;
|
|
105
179
|
}
|
|
106
180
|
export interface CreateSectionRequest {
|
|
@@ -112,7 +186,10 @@ export interface CreateSectionResponse {
|
|
|
112
186
|
section?: Section;
|
|
113
187
|
}
|
|
114
188
|
export interface BulkCreateSectionsRequest {
|
|
115
|
-
/**
|
|
189
|
+
/**
|
|
190
|
+
* Sections details.
|
|
191
|
+
* @maxSize 100
|
|
192
|
+
*/
|
|
116
193
|
sections: Section[];
|
|
117
194
|
/** Whether to receive the created sections in the response. */
|
|
118
195
|
returnEntity?: boolean;
|
|
@@ -156,7 +233,10 @@ export interface BulkActionMetadata {
|
|
|
156
233
|
undetailedFailures?: number;
|
|
157
234
|
}
|
|
158
235
|
export interface GetSectionRequest {
|
|
159
|
-
/**
|
|
236
|
+
/**
|
|
237
|
+
* Section ID.
|
|
238
|
+
* @format GUID
|
|
239
|
+
*/
|
|
160
240
|
sectionId: string;
|
|
161
241
|
}
|
|
162
242
|
export interface GetSectionResponse {
|
|
@@ -164,7 +244,11 @@ export interface GetSectionResponse {
|
|
|
164
244
|
section?: Section;
|
|
165
245
|
}
|
|
166
246
|
export interface ListSectionsRequest {
|
|
167
|
-
/**
|
|
247
|
+
/**
|
|
248
|
+
* Section IDs.
|
|
249
|
+
* @format GUID
|
|
250
|
+
* @maxSize 500
|
|
251
|
+
*/
|
|
168
252
|
sectionIds?: string[];
|
|
169
253
|
/** The metadata of the paginated results. */
|
|
170
254
|
paging?: CursorPaging;
|
|
@@ -172,7 +256,10 @@ export interface ListSectionsRequest {
|
|
|
172
256
|
onlyVisible?: boolean | null;
|
|
173
257
|
}
|
|
174
258
|
export interface CursorPaging {
|
|
175
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* Number of items to load.
|
|
261
|
+
* @max 500
|
|
262
|
+
*/
|
|
176
263
|
limit?: number | null;
|
|
177
264
|
/**
|
|
178
265
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -235,7 +322,10 @@ export interface CursorQueryPagingMethodOneOf {
|
|
|
235
322
|
cursorPaging?: CursorPaging;
|
|
236
323
|
}
|
|
237
324
|
export interface Sorting {
|
|
238
|
-
/**
|
|
325
|
+
/**
|
|
326
|
+
* Name of the field to sort by.
|
|
327
|
+
* @maxLength 512
|
|
328
|
+
*/
|
|
239
329
|
fieldName?: string;
|
|
240
330
|
/** Sort order. */
|
|
241
331
|
order?: SortOrder;
|
|
@@ -259,7 +349,11 @@ export interface UpdateSectionResponse {
|
|
|
259
349
|
section?: Section;
|
|
260
350
|
}
|
|
261
351
|
export interface BulkUpdateSectionRequest {
|
|
262
|
-
/**
|
|
352
|
+
/**
|
|
353
|
+
* Sections to update.
|
|
354
|
+
* @minSize 1
|
|
355
|
+
* @maxSize 100
|
|
356
|
+
*/
|
|
263
357
|
sections: MaskedSection[];
|
|
264
358
|
/** Whether to receive the updated sections in the response. */
|
|
265
359
|
returnEntity?: boolean;
|
|
@@ -271,7 +365,11 @@ export interface MaskedSection {
|
|
|
271
365
|
mask?: string[];
|
|
272
366
|
}
|
|
273
367
|
export interface BulkUpdateSectionResponse {
|
|
274
|
-
/**
|
|
368
|
+
/**
|
|
369
|
+
* Information about the updated sections.
|
|
370
|
+
* @minSize 1
|
|
371
|
+
* @maxSize 100
|
|
372
|
+
*/
|
|
275
373
|
results?: BulkSectionResult[];
|
|
276
374
|
/** Metadata for the API call. */
|
|
277
375
|
bulkActionMetadata?: BulkActionMetadata;
|
|
@@ -283,13 +381,19 @@ export interface BulkSectionResult {
|
|
|
283
381
|
section?: Section;
|
|
284
382
|
}
|
|
285
383
|
export interface DeleteSectionRequest {
|
|
286
|
-
/**
|
|
384
|
+
/**
|
|
385
|
+
* Section ID.
|
|
386
|
+
* @format GUID
|
|
387
|
+
*/
|
|
287
388
|
sectionId: string;
|
|
288
389
|
}
|
|
289
390
|
export interface DeleteSectionResponse {
|
|
290
391
|
}
|
|
291
392
|
export interface BulkDeleteSectionsRequest {
|
|
292
|
-
/**
|
|
393
|
+
/**
|
|
394
|
+
* Section IDs.
|
|
395
|
+
* @format GUID
|
|
396
|
+
*/
|
|
293
397
|
ids: string[];
|
|
294
398
|
}
|
|
295
399
|
export interface BulkDeleteSectionsResponse {
|
|
@@ -303,7 +407,10 @@ export interface BulkDeleteSectionResult {
|
|
|
303
407
|
itemMetadata?: ItemMetadata;
|
|
304
408
|
}
|
|
305
409
|
export interface CloneSectionsRequest {
|
|
306
|
-
/**
|
|
410
|
+
/**
|
|
411
|
+
* The MetaSiteId to clone from.
|
|
412
|
+
* @format GUID
|
|
413
|
+
*/
|
|
307
414
|
metaSiteId?: string;
|
|
308
415
|
}
|
|
309
416
|
export interface CloneSectionsResponse {
|
|
@@ -380,10 +487,42 @@ export interface ActionEvent {
|
|
|
380
487
|
}
|
|
381
488
|
export interface Empty {
|
|
382
489
|
}
|
|
490
|
+
export interface BulkUpdateBusinessLocationIdRequest {
|
|
491
|
+
/**
|
|
492
|
+
* section ids
|
|
493
|
+
* @format GUID
|
|
494
|
+
* @minSize 1
|
|
495
|
+
* @maxSize 100
|
|
496
|
+
*/
|
|
497
|
+
sectionIds?: string[];
|
|
498
|
+
/**
|
|
499
|
+
* Business Location Id.
|
|
500
|
+
* @format GUID
|
|
501
|
+
*/
|
|
502
|
+
businessLocationId?: string;
|
|
503
|
+
}
|
|
504
|
+
export interface BulkUpdateBusinessLocationIdResponse {
|
|
505
|
+
/**
|
|
506
|
+
* Information about the updated sections.
|
|
507
|
+
* @minSize 1
|
|
508
|
+
* @maxSize 100
|
|
509
|
+
*/
|
|
510
|
+
results?: BulkItemResult[];
|
|
511
|
+
}
|
|
512
|
+
export interface BulkItemResult {
|
|
513
|
+
/** Metadata for item update. */
|
|
514
|
+
itemMetadata?: ItemMetadata;
|
|
515
|
+
}
|
|
383
516
|
export interface MessageEnvelope {
|
|
384
|
-
/**
|
|
517
|
+
/**
|
|
518
|
+
* App instance ID.
|
|
519
|
+
* @format GUID
|
|
520
|
+
*/
|
|
385
521
|
instanceId?: string | null;
|
|
386
|
-
/**
|
|
522
|
+
/**
|
|
523
|
+
* Event type.
|
|
524
|
+
* @maxLength 150
|
|
525
|
+
*/
|
|
387
526
|
eventType?: string;
|
|
388
527
|
/** The identification type and identity data. */
|
|
389
528
|
identity?: IdentificationData;
|
|
@@ -391,26 +530,50 @@ export interface MessageEnvelope {
|
|
|
391
530
|
data?: string;
|
|
392
531
|
}
|
|
393
532
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
394
|
-
/**
|
|
533
|
+
/**
|
|
534
|
+
* ID of a site visitor that has not logged in to the site.
|
|
535
|
+
* @format GUID
|
|
536
|
+
*/
|
|
395
537
|
anonymousVisitorId?: string;
|
|
396
|
-
/**
|
|
538
|
+
/**
|
|
539
|
+
* ID of a site visitor that has logged in to the site.
|
|
540
|
+
* @format GUID
|
|
541
|
+
*/
|
|
397
542
|
memberId?: string;
|
|
398
|
-
/**
|
|
543
|
+
/**
|
|
544
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
545
|
+
* @format GUID
|
|
546
|
+
*/
|
|
399
547
|
wixUserId?: string;
|
|
400
|
-
/**
|
|
548
|
+
/**
|
|
549
|
+
* ID of an app.
|
|
550
|
+
* @format GUID
|
|
551
|
+
*/
|
|
401
552
|
appId?: string;
|
|
402
553
|
/** @readonly */
|
|
403
554
|
identityType?: WebhookIdentityType;
|
|
404
555
|
}
|
|
405
556
|
/** @oneof */
|
|
406
557
|
export interface IdentificationDataIdOneOf {
|
|
407
|
-
/**
|
|
558
|
+
/**
|
|
559
|
+
* ID of a site visitor that has not logged in to the site.
|
|
560
|
+
* @format GUID
|
|
561
|
+
*/
|
|
408
562
|
anonymousVisitorId?: string;
|
|
409
|
-
/**
|
|
563
|
+
/**
|
|
564
|
+
* ID of a site visitor that has logged in to the site.
|
|
565
|
+
* @format GUID
|
|
566
|
+
*/
|
|
410
567
|
memberId?: string;
|
|
411
|
-
/**
|
|
568
|
+
/**
|
|
569
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
570
|
+
* @format GUID
|
|
571
|
+
*/
|
|
412
572
|
wixUserId?: string;
|
|
413
|
-
/**
|
|
573
|
+
/**
|
|
574
|
+
* ID of an app.
|
|
575
|
+
* @format GUID
|
|
576
|
+
*/
|
|
414
577
|
appId?: string;
|
|
415
578
|
}
|
|
416
579
|
export declare enum WebhookIdentityType {
|
|
@@ -420,6 +583,9 @@ export declare enum WebhookIdentityType {
|
|
|
420
583
|
WIX_USER = "WIX_USER",
|
|
421
584
|
APP = "APP"
|
|
422
585
|
}
|
|
586
|
+
export interface DuplicateSectionResponseNonNullableFields {
|
|
587
|
+
sectionId: string[];
|
|
588
|
+
}
|
|
423
589
|
export interface SectionNonNullableFields {
|
|
424
590
|
name: string;
|
|
425
591
|
image: string;
|
|
@@ -479,9 +645,15 @@ export interface BulkDeleteSectionsResponseNonNullableFields {
|
|
|
479
645
|
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
480
646
|
}
|
|
481
647
|
export interface BaseEventMetadata {
|
|
482
|
-
/**
|
|
648
|
+
/**
|
|
649
|
+
* App instance ID.
|
|
650
|
+
* @format GUID
|
|
651
|
+
*/
|
|
483
652
|
instanceId?: string | null;
|
|
484
|
-
/**
|
|
653
|
+
/**
|
|
654
|
+
* Event type.
|
|
655
|
+
* @maxLength 150
|
|
656
|
+
*/
|
|
485
657
|
eventType?: string;
|
|
486
658
|
/** The identification type and identity data. */
|
|
487
659
|
identity?: IdentificationData;
|
|
@@ -530,10 +702,16 @@ export interface SectionCreatedEnvelope {
|
|
|
530
702
|
}
|
|
531
703
|
/** @permissionScope Manage Bookings Services and Settings
|
|
532
704
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
705
|
+
* @permissionScope Manage Events
|
|
706
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
533
707
|
* @permissionScope Manage Portfolio
|
|
534
708
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
709
|
+
* @permissionScope Access Verticals by Automations
|
|
710
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
535
711
|
* @permissionScope Manage Restaurants - all permissions
|
|
536
712
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
713
|
+
* @permissionScope Set Up Automations
|
|
714
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
537
715
|
* @permissionId RESTAURANTS.SECTION_READ
|
|
538
716
|
* @webhook
|
|
539
717
|
* @eventType wix.restaurants.menus.v1.section_created
|
|
@@ -547,10 +725,16 @@ export interface SectionDeletedEnvelope {
|
|
|
547
725
|
}
|
|
548
726
|
/** @permissionScope Manage Bookings Services and Settings
|
|
549
727
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
728
|
+
* @permissionScope Manage Events
|
|
729
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
550
730
|
* @permissionScope Manage Portfolio
|
|
551
731
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
732
|
+
* @permissionScope Access Verticals by Automations
|
|
733
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
552
734
|
* @permissionScope Manage Restaurants - all permissions
|
|
553
735
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
736
|
+
* @permissionScope Set Up Automations
|
|
737
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
554
738
|
* @permissionId RESTAURANTS.SECTION_READ
|
|
555
739
|
* @webhook
|
|
556
740
|
* @eventType wix.restaurants.menus.v1.section_deleted
|
|
@@ -567,10 +751,16 @@ export interface SectionUpdatedEnvelope {
|
|
|
567
751
|
* Triggered when a section is updated.
|
|
568
752
|
* @permissionScope Manage Bookings Services and Settings
|
|
569
753
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
754
|
+
* @permissionScope Manage Events
|
|
755
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
570
756
|
* @permissionScope Manage Portfolio
|
|
571
757
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
758
|
+
* @permissionScope Access Verticals by Automations
|
|
759
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
572
760
|
* @permissionScope Manage Restaurants - all permissions
|
|
573
761
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
762
|
+
* @permissionScope Set Up Automations
|
|
763
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
574
764
|
* @permissionId RESTAURANTS.SECTION_READ
|
|
575
765
|
* @webhook
|
|
576
766
|
* @eventType wix.restaurants.menus.v1.section_updated
|
|
@@ -579,6 +769,27 @@ export interface SectionUpdatedEnvelope {
|
|
|
579
769
|
* @documentationMaturity preview
|
|
580
770
|
*/
|
|
581
771
|
export declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope) => void | Promise<void>): void;
|
|
772
|
+
/** @param _id - Section id to be duplicated.
|
|
773
|
+
* @public
|
|
774
|
+
* @documentationMaturity preview
|
|
775
|
+
* @requiredField _id
|
|
776
|
+
* @permissionId RESTAURANTS.SECTION_CREATE
|
|
777
|
+
* @permissionScope Manage Restaurants - all permissions
|
|
778
|
+
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
779
|
+
* @applicableIdentity APP
|
|
780
|
+
* @fqn com.wixpress.restaurants.menus_section.v1.restaurants_duplicate_section.RestaurantsDuplicateSection.DuplicateSection
|
|
781
|
+
*/
|
|
782
|
+
export declare function duplicateSection(_id: string, options?: DuplicateSectionOptions): Promise<DuplicateSectionResponse & DuplicateSectionResponseNonNullableFields>;
|
|
783
|
+
export interface DuplicateSectionOptions {
|
|
784
|
+
/**
|
|
785
|
+
* Business location ids to duplicate the section to.
|
|
786
|
+
* @format GUID
|
|
787
|
+
* @maxSize 100
|
|
788
|
+
*/
|
|
789
|
+
businessLocationIds?: string[] | null;
|
|
790
|
+
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
791
|
+
duplicateSubEntities?: boolean | null;
|
|
792
|
+
}
|
|
582
793
|
/**
|
|
583
794
|
* > **Note:** The Sections API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).
|
|
584
795
|
*
|
|
@@ -590,10 +801,6 @@ export declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope
|
|
|
590
801
|
* @documentationMaturity preview
|
|
591
802
|
* @requiredField section
|
|
592
803
|
* @permissionId RESTAURANTS.SECTION_CREATE
|
|
593
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
594
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
595
|
-
* @permissionScope Manage Portfolio
|
|
596
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
597
804
|
* @permissionScope Manage Restaurants - all permissions
|
|
598
805
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
599
806
|
* @applicableIdentity APP
|
|
@@ -610,10 +817,6 @@ export declare function createSection(section: Section): Promise<Section & Secti
|
|
|
610
817
|
* @documentationMaturity preview
|
|
611
818
|
* @requiredField sections
|
|
612
819
|
* @permissionId RESTAURANTS.SECTION_CREATE
|
|
613
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
614
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
615
|
-
* @permissionScope Manage Portfolio
|
|
616
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
617
820
|
* @permissionScope Manage Restaurants - all permissions
|
|
618
821
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
619
822
|
* @applicableIdentity APP
|
|
@@ -635,10 +838,16 @@ export interface BulkCreateSectionsOptions {
|
|
|
635
838
|
* @permissionId RESTAURANTS.SECTION_READ
|
|
636
839
|
* @permissionScope Manage Bookings Services and Settings
|
|
637
840
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
841
|
+
* @permissionScope Manage Events
|
|
842
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
638
843
|
* @permissionScope Manage Portfolio
|
|
639
844
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
845
|
+
* @permissionScope Access Verticals by Automations
|
|
846
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
640
847
|
* @permissionScope Manage Restaurants - all permissions
|
|
641
848
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
849
|
+
* @permissionScope Set Up Automations
|
|
850
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
642
851
|
* @applicableIdentity APP
|
|
643
852
|
* @applicableIdentity VISITOR
|
|
644
853
|
* @returns Section.
|
|
@@ -654,17 +863,27 @@ export declare function getSection(sectionId: string): Promise<Section & Section
|
|
|
654
863
|
* @permissionId RESTAURANTS.SECTION_READ
|
|
655
864
|
* @permissionScope Manage Bookings Services and Settings
|
|
656
865
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
866
|
+
* @permissionScope Manage Events
|
|
867
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
657
868
|
* @permissionScope Manage Portfolio
|
|
658
869
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
870
|
+
* @permissionScope Access Verticals by Automations
|
|
871
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
659
872
|
* @permissionScope Manage Restaurants - all permissions
|
|
660
873
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
874
|
+
* @permissionScope Set Up Automations
|
|
875
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
661
876
|
* @applicableIdentity APP
|
|
662
877
|
* @applicableIdentity VISITOR
|
|
663
878
|
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.ListSections
|
|
664
879
|
*/
|
|
665
880
|
export declare function listSections(options?: ListSectionsOptions): Promise<ListSectionsResponse & ListSectionsResponseNonNullableFields>;
|
|
666
881
|
export interface ListSectionsOptions {
|
|
667
|
-
/**
|
|
882
|
+
/**
|
|
883
|
+
* Section IDs.
|
|
884
|
+
* @format GUID
|
|
885
|
+
* @maxSize 500
|
|
886
|
+
*/
|
|
668
887
|
sectionIds?: string[];
|
|
669
888
|
/** The metadata of the paginated results. */
|
|
670
889
|
paging?: CursorPaging;
|
|
@@ -683,17 +902,22 @@ export interface ListSectionsOptions {
|
|
|
683
902
|
* `querySections()` runs with the following `SectionsQueryBuilder` defaults, which you can override:
|
|
684
903
|
*
|
|
685
904
|
* * [`limit(100)`](/sections/sections-query-builder/limit)
|
|
686
|
-
* * [`ascending('entityId')`](/sections/sections-query-builder/ascending)
|
|
687
905
|
*
|
|
688
906
|
* The following `SectionsQueryBuilder` functions are supported for `querySections()`. For a full description of the section object, see the object returned for the [`items`](/sections/sections-query-result/items) property in `SectionsQueryResult`.
|
|
689
907
|
* @public
|
|
690
908
|
* @documentationMaturity preview
|
|
691
909
|
* @permissionScope Manage Bookings Services and Settings
|
|
692
910
|
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
911
|
+
* @permissionScope Manage Events
|
|
912
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
693
913
|
* @permissionScope Manage Portfolio
|
|
694
914
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
915
|
+
* @permissionScope Access Verticals by Automations
|
|
916
|
+
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
695
917
|
* @permissionScope Manage Restaurants - all permissions
|
|
696
918
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
919
|
+
* @permissionScope Set Up Automations
|
|
920
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
697
921
|
* @permissionId RESTAURANTS.SECTION_READ
|
|
698
922
|
* @applicableIdentity APP
|
|
699
923
|
* @applicableIdentity VISITOR
|
|
@@ -777,10 +1001,6 @@ export interface SectionsQueryBuilder {
|
|
|
777
1001
|
* @requiredField section
|
|
778
1002
|
* @requiredField section.revision
|
|
779
1003
|
* @permissionId RESTAURANTS.SECTION_UPDATE
|
|
780
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
781
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
782
|
-
* @permissionScope Manage Portfolio
|
|
783
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
784
1004
|
* @permissionScope Manage Restaurants - all permissions
|
|
785
1005
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
786
1006
|
* @applicableIdentity APP
|
|
@@ -791,6 +1011,7 @@ export declare function updateSection(_id: string | null, section: UpdateSection
|
|
|
791
1011
|
export interface UpdateSection {
|
|
792
1012
|
/**
|
|
793
1013
|
* Section ID.
|
|
1014
|
+
* @format GUID
|
|
794
1015
|
* @readonly
|
|
795
1016
|
*/
|
|
796
1017
|
_id?: string | null;
|
|
@@ -809,15 +1030,29 @@ export interface UpdateSection {
|
|
|
809
1030
|
* @readonly
|
|
810
1031
|
*/
|
|
811
1032
|
_updatedDate?: Date | null;
|
|
812
|
-
/**
|
|
1033
|
+
/**
|
|
1034
|
+
* Section name.
|
|
1035
|
+
* @minLength 1
|
|
1036
|
+
* @maxLength 500
|
|
1037
|
+
*/
|
|
813
1038
|
name?: string;
|
|
814
|
-
/**
|
|
1039
|
+
/**
|
|
1040
|
+
* Section description.
|
|
1041
|
+
* @maxLength 1500
|
|
1042
|
+
*/
|
|
815
1043
|
description?: string | null;
|
|
816
1044
|
/** Main section image. */
|
|
817
1045
|
image?: string;
|
|
818
|
-
/**
|
|
1046
|
+
/**
|
|
1047
|
+
* Additional section images.
|
|
1048
|
+
* @maxSize 100
|
|
1049
|
+
*/
|
|
819
1050
|
additionalImages?: string[];
|
|
820
|
-
/**
|
|
1051
|
+
/**
|
|
1052
|
+
* Item IDs.
|
|
1053
|
+
* @format GUID
|
|
1054
|
+
* @maxSize 1000
|
|
1055
|
+
*/
|
|
821
1056
|
itemIds?: string[];
|
|
822
1057
|
/** Extended fields. */
|
|
823
1058
|
extendedFields?: ExtendedFields;
|
|
@@ -837,10 +1072,6 @@ export interface UpdateSection {
|
|
|
837
1072
|
* @requiredField sections.section._id
|
|
838
1073
|
* @requiredField sections.section.revision
|
|
839
1074
|
* @permissionId RESTAURANTS.SECTION_UPDATE
|
|
840
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
841
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
842
|
-
* @permissionScope Manage Portfolio
|
|
843
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
844
1075
|
* @permissionScope Manage Restaurants - all permissions
|
|
845
1076
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
846
1077
|
* @applicableIdentity APP
|
|
@@ -860,10 +1091,6 @@ export interface BulkUpdateSectionOptions {
|
|
|
860
1091
|
* @documentationMaturity preview
|
|
861
1092
|
* @requiredField sectionId
|
|
862
1093
|
* @permissionId RESTAURANTS.SECTION_DELETE
|
|
863
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
864
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
865
|
-
* @permissionScope Manage Portfolio
|
|
866
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
867
1094
|
* @permissionScope Manage Restaurants - all permissions
|
|
868
1095
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
869
1096
|
* @applicableIdentity APP
|
|
@@ -879,10 +1106,6 @@ export declare function deleteSection(sectionId: string): Promise<void>;
|
|
|
879
1106
|
* @documentationMaturity preview
|
|
880
1107
|
* @requiredField ids
|
|
881
1108
|
* @permissionId RESTAURANTS.SECTION_DELETE
|
|
882
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
883
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
884
|
-
* @permissionScope Manage Portfolio
|
|
885
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
886
1109
|
* @permissionScope Manage Restaurants - all permissions
|
|
887
1110
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
888
1111
|
* @applicableIdentity APP
|