@wix/auto_sdk_restaurants_sections 1.0.13 → 1.0.14
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.public.d.ts → index.d.mts} +36 -19
- package/build/{internal/cjs/src/restaurants-menus-v1-section-sections.public.d.ts → index.d.ts} +36 -19
- package/build/index.js +1118 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +1080 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/restaurants-menus-v1-section-sections.public.d.ts → index.d.mts} +36 -19
- package/build/{es/src/restaurants-menus-v1-section-sections.public.d.ts → internal/index.d.ts} +36 -19
- package/build/internal/index.js +1118 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +1080 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +357 -0
- package/build/internal/meta.d.ts +357 -0
- package/build/internal/meta.js +706 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +670 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/internal/{cjs/src/restaurants-menus-v1-section-sections.universal.d.ts → restaurants-menus-v1-section-sections.universal-BZUvATJu.d.mts} +79 -307
- package/build/internal/{es/src/restaurants-menus-v1-section-sections.universal.d.ts → restaurants-menus-v1-section-sections.universal-BZUvATJu.d.ts} +79 -307
- package/build/meta.d.mts +357 -0
- package/build/meta.d.ts +357 -0
- package/build/meta.js +706 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +670 -0
- package/build/meta.mjs.map +1 -0
- package/build/{cjs/src/restaurants-menus-v1-section-sections.universal.d.ts → restaurants-menus-v1-section-sections.universal-BZUvATJu.d.mts} +79 -307
- package/build/{es/src/restaurants-menus-v1-section-sections.universal.d.ts → restaurants-menus-v1-section-sections.universal-BZUvATJu.d.ts} +79 -307
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.context.d.ts +0 -26
- package/build/cjs/src/restaurants-menus-v1-section-sections.context.js +0 -31
- package/build/cjs/src/restaurants-menus-v1-section-sections.context.js.map +0 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.http.d.ts +0 -72
- package/build/cjs/src/restaurants-menus-v1-section-sections.http.js +0 -529
- package/build/cjs/src/restaurants-menus-v1-section-sections.http.js.map +0 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.meta.d.ts +0 -30
- package/build/cjs/src/restaurants-menus-v1-section-sections.meta.js +0 -218
- package/build/cjs/src/restaurants-menus-v1-section-sections.meta.js.map +0 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.public.js +0 -125
- package/build/cjs/src/restaurants-menus-v1-section-sections.public.js.map +0 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.types.d.ts +0 -610
- package/build/cjs/src/restaurants-menus-v1-section-sections.types.js +0 -17
- package/build/cjs/src/restaurants-menus-v1-section-sections.types.js.map +0 -1
- package/build/cjs/src/restaurants-menus-v1-section-sections.universal.js +0 -587
- package/build/cjs/src/restaurants-menus-v1-section-sections.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/restaurants-menus-v1-section-sections.context.d.ts +0 -26
- package/build/es/src/restaurants-menus-v1-section-sections.context.js +0 -26
- package/build/es/src/restaurants-menus-v1-section-sections.context.js.map +0 -1
- package/build/es/src/restaurants-menus-v1-section-sections.http.d.ts +0 -72
- package/build/es/src/restaurants-menus-v1-section-sections.http.js +0 -516
- package/build/es/src/restaurants-menus-v1-section-sections.http.js.map +0 -1
- package/build/es/src/restaurants-menus-v1-section-sections.meta.d.ts +0 -30
- package/build/es/src/restaurants-menus-v1-section-sections.meta.js +0 -182
- package/build/es/src/restaurants-menus-v1-section-sections.meta.js.map +0 -1
- package/build/es/src/restaurants-menus-v1-section-sections.public.js +0 -110
- package/build/es/src/restaurants-menus-v1-section-sections.public.js.map +0 -1
- package/build/es/src/restaurants-menus-v1-section-sections.types.d.ts +0 -610
- package/build/es/src/restaurants-menus-v1-section-sections.types.js +0 -14
- package/build/es/src/restaurants-menus-v1-section-sections.types.js.map +0 -1
- package/build/es/src/restaurants-menus-v1-section-sections.universal.js +0 -551
- package/build/es/src/restaurants-menus-v1-section-sections.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.d.ts +0 -26
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.js +0 -31
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.js.map +0 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.d.ts +0 -72
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.js +0 -529
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.js.map +0 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.d.ts +0 -30
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.js +0 -218
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.js.map +0 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.js +0 -125
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.js.map +0 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.d.ts +0 -610
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.js +0 -17
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.js.map +0 -1
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.js +0 -587
- package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.context.d.ts +0 -26
- package/build/internal/es/src/restaurants-menus-v1-section-sections.context.js +0 -26
- package/build/internal/es/src/restaurants-menus-v1-section-sections.context.js.map +0 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.http.d.ts +0 -72
- package/build/internal/es/src/restaurants-menus-v1-section-sections.http.js +0 -516
- package/build/internal/es/src/restaurants-menus-v1-section-sections.http.js.map +0 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.d.ts +0 -30
- package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.js +0 -182
- package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.js.map +0 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.public.js +0 -110
- package/build/internal/es/src/restaurants-menus-v1-section-sections.public.js.map +0 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.types.d.ts +0 -610
- package/build/internal/es/src/restaurants-menus-v1-section-sections.types.js +0 -14
- package/build/internal/es/src/restaurants-menus-v1-section-sections.types.js.map +0 -1
- package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.js +0 -551
- package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.js.map +0 -1
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export interface Section {
|
|
1
|
+
interface Section {
|
|
3
2
|
/**
|
|
4
3
|
* Section ID.
|
|
5
4
|
* @format GUID
|
|
@@ -50,7 +49,7 @@ export interface Section {
|
|
|
50
49
|
/** Whether the section is visible in the menu for site visitors. */
|
|
51
50
|
visible?: boolean | null;
|
|
52
51
|
}
|
|
53
|
-
|
|
52
|
+
interface ExtendedFields {
|
|
54
53
|
/**
|
|
55
54
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
56
55
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -61,7 +60,7 @@ export interface ExtendedFields {
|
|
|
61
60
|
*/
|
|
62
61
|
namespaces?: Record<string, Record<string, any>>;
|
|
63
62
|
}
|
|
64
|
-
|
|
63
|
+
interface DuplicateSectionRequest {
|
|
65
64
|
/**
|
|
66
65
|
* Section id to be duplicated.
|
|
67
66
|
* @format GUID
|
|
@@ -76,11 +75,11 @@ export interface DuplicateSectionRequest {
|
|
|
76
75
|
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
77
76
|
duplicateSubEntities?: boolean | null;
|
|
78
77
|
}
|
|
79
|
-
|
|
78
|
+
interface DuplicateSectionResponse {
|
|
80
79
|
/** @format GUID */
|
|
81
80
|
sectionId?: string[];
|
|
82
81
|
}
|
|
83
|
-
|
|
82
|
+
interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
84
83
|
/**
|
|
85
84
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
86
85
|
* @format GUID
|
|
@@ -109,7 +108,7 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
109
108
|
hardPurge?: boolean;
|
|
110
109
|
}
|
|
111
110
|
/** @oneof */
|
|
112
|
-
|
|
111
|
+
interface InvalidateCacheGetByOneOf {
|
|
113
112
|
/**
|
|
114
113
|
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
115
114
|
* @format GUID
|
|
@@ -129,7 +128,7 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
129
128
|
/** Invalidate by file (for media files such as PDFs) */
|
|
130
129
|
file?: File;
|
|
131
130
|
}
|
|
132
|
-
|
|
131
|
+
interface App {
|
|
133
132
|
/**
|
|
134
133
|
* The AppDefId
|
|
135
134
|
* @minLength 1
|
|
@@ -141,7 +140,7 @@ export interface App {
|
|
|
141
140
|
*/
|
|
142
141
|
instanceId?: string;
|
|
143
142
|
}
|
|
144
|
-
|
|
143
|
+
interface Page {
|
|
145
144
|
/**
|
|
146
145
|
* the msid the page is on
|
|
147
146
|
* @format GUID
|
|
@@ -153,7 +152,7 @@ export interface Page {
|
|
|
153
152
|
*/
|
|
154
153
|
pageId?: string;
|
|
155
154
|
}
|
|
156
|
-
|
|
155
|
+
interface URI {
|
|
157
156
|
/**
|
|
158
157
|
* the msid the URI is on
|
|
159
158
|
* @format GUID
|
|
@@ -165,7 +164,7 @@ export interface URI {
|
|
|
165
164
|
*/
|
|
166
165
|
uriPath?: string;
|
|
167
166
|
}
|
|
168
|
-
|
|
167
|
+
interface File {
|
|
169
168
|
/**
|
|
170
169
|
* the msid the file is related to
|
|
171
170
|
* @format GUID
|
|
@@ -178,7 +177,7 @@ export interface File {
|
|
|
178
177
|
*/
|
|
179
178
|
fileName?: string;
|
|
180
179
|
}
|
|
181
|
-
|
|
180
|
+
interface DeleteLocationIdFromItems {
|
|
182
181
|
/** @format GUID */
|
|
183
182
|
businessLocationId?: string;
|
|
184
183
|
/**
|
|
@@ -187,15 +186,15 @@ export interface DeleteLocationIdFromItems {
|
|
|
187
186
|
*/
|
|
188
187
|
itemIds?: string[];
|
|
189
188
|
}
|
|
190
|
-
|
|
189
|
+
interface CreateSectionRequest {
|
|
191
190
|
/** Section details. */
|
|
192
191
|
section: Section;
|
|
193
192
|
}
|
|
194
|
-
|
|
193
|
+
interface CreateSectionResponse {
|
|
195
194
|
/** Section. */
|
|
196
195
|
section?: Section;
|
|
197
196
|
}
|
|
198
|
-
|
|
197
|
+
interface BulkCreateSectionsRequest {
|
|
199
198
|
/**
|
|
200
199
|
* Sections details.
|
|
201
200
|
* @maxSize 100
|
|
@@ -204,19 +203,19 @@ export interface BulkCreateSectionsRequest {
|
|
|
204
203
|
/** Whether to receive the created sections in the response. */
|
|
205
204
|
returnEntity?: boolean;
|
|
206
205
|
}
|
|
207
|
-
|
|
206
|
+
interface BulkCreateSectionsResponse {
|
|
208
207
|
/** Information about the created sections. */
|
|
209
208
|
results?: BulkCreateSectionResult[];
|
|
210
209
|
/** Metadata for the API call. */
|
|
211
210
|
bulkActionMetadata?: BulkActionMetadata;
|
|
212
211
|
}
|
|
213
|
-
|
|
212
|
+
interface BulkCreateSectionResult {
|
|
214
213
|
/** Metadata for created sections. */
|
|
215
214
|
itemMetadata?: ItemMetadata;
|
|
216
215
|
/** Created section. Only returned if `returnEntity` is set to `true`. */
|
|
217
216
|
item?: Section;
|
|
218
217
|
}
|
|
219
|
-
|
|
218
|
+
interface ItemMetadata {
|
|
220
219
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
221
220
|
_id?: string | null;
|
|
222
221
|
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
@@ -226,7 +225,7 @@ export interface ItemMetadata {
|
|
|
226
225
|
/** Details about the error in case of failure. */
|
|
227
226
|
error?: ApplicationError;
|
|
228
227
|
}
|
|
229
|
-
|
|
228
|
+
interface ApplicationError {
|
|
230
229
|
/** Error code. */
|
|
231
230
|
code?: string;
|
|
232
231
|
/** Description of the error. */
|
|
@@ -234,7 +233,7 @@ export interface ApplicationError {
|
|
|
234
233
|
/** Data related to the error. */
|
|
235
234
|
data?: Record<string, any> | null;
|
|
236
235
|
}
|
|
237
|
-
|
|
236
|
+
interface BulkActionMetadata {
|
|
238
237
|
/** Number of items that were successfully processed. */
|
|
239
238
|
totalSuccesses?: number;
|
|
240
239
|
/** Number of items that couldn't be processed. */
|
|
@@ -242,18 +241,18 @@ export interface BulkActionMetadata {
|
|
|
242
241
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
243
242
|
undetailedFailures?: number;
|
|
244
243
|
}
|
|
245
|
-
|
|
244
|
+
interface GetSectionRequest {
|
|
246
245
|
/**
|
|
247
246
|
* Section ID.
|
|
248
247
|
* @format GUID
|
|
249
248
|
*/
|
|
250
249
|
sectionId: string;
|
|
251
250
|
}
|
|
252
|
-
|
|
251
|
+
interface GetSectionResponse {
|
|
253
252
|
/** Section. */
|
|
254
253
|
section?: Section;
|
|
255
254
|
}
|
|
256
|
-
|
|
255
|
+
interface ListSectionsRequest {
|
|
257
256
|
/**
|
|
258
257
|
* Section IDs.
|
|
259
258
|
* @format GUID
|
|
@@ -265,7 +264,7 @@ export interface ListSectionsRequest {
|
|
|
265
264
|
/** Whether to return only sections that are visible to site visitors. */
|
|
266
265
|
onlyVisible?: boolean | null;
|
|
267
266
|
}
|
|
268
|
-
|
|
267
|
+
interface CursorPaging {
|
|
269
268
|
/**
|
|
270
269
|
* Number of items to load.
|
|
271
270
|
* @max 500
|
|
@@ -280,13 +279,13 @@ export interface CursorPaging {
|
|
|
280
279
|
*/
|
|
281
280
|
cursor?: string | null;
|
|
282
281
|
}
|
|
283
|
-
|
|
282
|
+
interface ListSectionsResponse {
|
|
284
283
|
/** Retrieved sections. */
|
|
285
284
|
sections?: Section[];
|
|
286
285
|
/** The metadata of the paginated results. */
|
|
287
286
|
pagingMetadata?: CursorPagingMetadata;
|
|
288
287
|
}
|
|
289
|
-
|
|
288
|
+
interface CursorPagingMetadata {
|
|
290
289
|
/** Number of items returned in the response. */
|
|
291
290
|
count?: number | null;
|
|
292
291
|
/** Offset that was requested. */
|
|
@@ -298,17 +297,17 @@ export interface CursorPagingMetadata {
|
|
|
298
297
|
*/
|
|
299
298
|
hasNext?: boolean | null;
|
|
300
299
|
}
|
|
301
|
-
|
|
300
|
+
interface Cursors {
|
|
302
301
|
/** Cursor pointing to next page in the list of results. */
|
|
303
302
|
next?: string | null;
|
|
304
303
|
/** Cursor pointing to previous page in the list of results. */
|
|
305
304
|
prev?: string | null;
|
|
306
305
|
}
|
|
307
|
-
|
|
306
|
+
interface QuerySectionsRequest {
|
|
308
307
|
/** Query options. */
|
|
309
308
|
query?: CursorQuery;
|
|
310
309
|
}
|
|
311
|
-
|
|
310
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
312
311
|
/** 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`. */
|
|
313
312
|
cursorPaging?: CursorPaging;
|
|
314
313
|
/**
|
|
@@ -327,11 +326,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
327
326
|
sort?: Sorting[];
|
|
328
327
|
}
|
|
329
328
|
/** @oneof */
|
|
330
|
-
|
|
329
|
+
interface CursorQueryPagingMethodOneOf {
|
|
331
330
|
/** 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`. */
|
|
332
331
|
cursorPaging?: CursorPaging;
|
|
333
332
|
}
|
|
334
|
-
|
|
333
|
+
interface Sorting {
|
|
335
334
|
/**
|
|
336
335
|
* Name of the field to sort by.
|
|
337
336
|
* @maxLength 512
|
|
@@ -340,25 +339,25 @@ export interface Sorting {
|
|
|
340
339
|
/** Sort order. */
|
|
341
340
|
order?: SortOrder;
|
|
342
341
|
}
|
|
343
|
-
|
|
342
|
+
declare enum SortOrder {
|
|
344
343
|
ASC = "ASC",
|
|
345
344
|
DESC = "DESC"
|
|
346
345
|
}
|
|
347
|
-
|
|
346
|
+
interface QuerySectionsResponse {
|
|
348
347
|
/** Retrieved sections. */
|
|
349
348
|
sections?: Section[];
|
|
350
349
|
/** The metadata of the paginated results. */
|
|
351
350
|
pagingMetadata?: CursorPagingMetadata;
|
|
352
351
|
}
|
|
353
|
-
|
|
352
|
+
interface UpdateSectionRequest {
|
|
354
353
|
/** Section update. */
|
|
355
354
|
section: Section;
|
|
356
355
|
}
|
|
357
|
-
|
|
356
|
+
interface UpdateSectionResponse {
|
|
358
357
|
/** Updated section. */
|
|
359
358
|
section?: Section;
|
|
360
359
|
}
|
|
361
|
-
|
|
360
|
+
interface BulkUpdateSectionRequest {
|
|
362
361
|
/**
|
|
363
362
|
* Sections to update.
|
|
364
363
|
* @minSize 1
|
|
@@ -368,13 +367,13 @@ export interface BulkUpdateSectionRequest {
|
|
|
368
367
|
/** Whether to receive the updated sections in the response. */
|
|
369
368
|
returnEntity?: boolean;
|
|
370
369
|
}
|
|
371
|
-
|
|
370
|
+
interface MaskedSection {
|
|
372
371
|
/** Section update. */
|
|
373
372
|
section?: Section;
|
|
374
373
|
/** Explicit list of fields to update. */
|
|
375
374
|
mask?: string[];
|
|
376
375
|
}
|
|
377
|
-
|
|
376
|
+
interface BulkUpdateSectionResponse {
|
|
378
377
|
/**
|
|
379
378
|
* Information about the updated sections.
|
|
380
379
|
* @minSize 1
|
|
@@ -384,48 +383,48 @@ export interface BulkUpdateSectionResponse {
|
|
|
384
383
|
/** Metadata for the API call. */
|
|
385
384
|
bulkActionMetadata?: BulkActionMetadata;
|
|
386
385
|
}
|
|
387
|
-
|
|
386
|
+
interface BulkSectionResult {
|
|
388
387
|
/** Whether to receive the updated sections in the response. */
|
|
389
388
|
sectionMetadata?: ItemMetadata;
|
|
390
389
|
/** Updated section. Only returned if `returnEntity` is set to `true`. */
|
|
391
390
|
section?: Section;
|
|
392
391
|
}
|
|
393
|
-
|
|
392
|
+
interface DeleteSectionRequest {
|
|
394
393
|
/**
|
|
395
394
|
* Section ID.
|
|
396
395
|
* @format GUID
|
|
397
396
|
*/
|
|
398
397
|
sectionId: string;
|
|
399
398
|
}
|
|
400
|
-
|
|
399
|
+
interface DeleteSectionResponse {
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
interface BulkDeleteSectionsRequest {
|
|
403
402
|
/**
|
|
404
403
|
* Section IDs.
|
|
405
404
|
* @format GUID
|
|
406
405
|
*/
|
|
407
406
|
ids: string[];
|
|
408
407
|
}
|
|
409
|
-
|
|
408
|
+
interface BulkDeleteSectionsResponse {
|
|
410
409
|
/** Information about the deleted sections. */
|
|
411
410
|
results?: BulkDeleteSectionResult[];
|
|
412
411
|
/** Metadata for the API call. */
|
|
413
412
|
bulkActionMetadata?: BulkActionMetadata;
|
|
414
413
|
}
|
|
415
|
-
|
|
414
|
+
interface BulkDeleteSectionResult {
|
|
416
415
|
/** Metadata for deleted sections. */
|
|
417
416
|
itemMetadata?: ItemMetadata;
|
|
418
417
|
}
|
|
419
|
-
|
|
418
|
+
interface CloneSectionsRequest {
|
|
420
419
|
/**
|
|
421
420
|
* The MetaSiteId to clone from.
|
|
422
421
|
* @format GUID
|
|
423
422
|
*/
|
|
424
423
|
metaSiteId?: string;
|
|
425
424
|
}
|
|
426
|
-
|
|
425
|
+
interface CloneSectionsResponse {
|
|
427
426
|
}
|
|
428
|
-
|
|
427
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
429
428
|
createdEvent?: EntityCreatedEvent;
|
|
430
429
|
updatedEvent?: EntityUpdatedEvent;
|
|
431
430
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -468,19 +467,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
468
467
|
entityEventSequence?: string | null;
|
|
469
468
|
}
|
|
470
469
|
/** @oneof */
|
|
471
|
-
|
|
470
|
+
interface DomainEventBodyOneOf {
|
|
472
471
|
createdEvent?: EntityCreatedEvent;
|
|
473
472
|
updatedEvent?: EntityUpdatedEvent;
|
|
474
473
|
deletedEvent?: EntityDeletedEvent;
|
|
475
474
|
actionEvent?: ActionEvent;
|
|
476
475
|
}
|
|
477
|
-
|
|
476
|
+
interface EntityCreatedEvent {
|
|
478
477
|
entity?: string;
|
|
479
478
|
}
|
|
480
|
-
|
|
479
|
+
interface RestoreInfo {
|
|
481
480
|
deletedDate?: Date | null;
|
|
482
481
|
}
|
|
483
|
-
|
|
482
|
+
interface EntityUpdatedEvent {
|
|
484
483
|
/**
|
|
485
484
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
486
485
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -488,16 +487,16 @@ export interface EntityUpdatedEvent {
|
|
|
488
487
|
*/
|
|
489
488
|
currentEntity?: string;
|
|
490
489
|
}
|
|
491
|
-
|
|
490
|
+
interface EntityDeletedEvent {
|
|
492
491
|
/** Entity that was deleted */
|
|
493
492
|
deletedEntity?: string | null;
|
|
494
493
|
}
|
|
495
|
-
|
|
494
|
+
interface ActionEvent {
|
|
496
495
|
body?: string;
|
|
497
496
|
}
|
|
498
|
-
|
|
497
|
+
interface Empty {
|
|
499
498
|
}
|
|
500
|
-
|
|
499
|
+
interface BulkUpdateBusinessLocationIdRequest {
|
|
501
500
|
/**
|
|
502
501
|
* section ids
|
|
503
502
|
* @format GUID
|
|
@@ -511,7 +510,7 @@ export interface BulkUpdateBusinessLocationIdRequest {
|
|
|
511
510
|
*/
|
|
512
511
|
businessLocationId?: string;
|
|
513
512
|
}
|
|
514
|
-
|
|
513
|
+
interface BulkUpdateBusinessLocationIdResponse {
|
|
515
514
|
/**
|
|
516
515
|
* Information about the updated sections.
|
|
517
516
|
* @minSize 1
|
|
@@ -519,11 +518,11 @@ export interface BulkUpdateBusinessLocationIdResponse {
|
|
|
519
518
|
*/
|
|
520
519
|
results?: BulkItemResult[];
|
|
521
520
|
}
|
|
522
|
-
|
|
521
|
+
interface BulkItemResult {
|
|
523
522
|
/** Metadata for item update. */
|
|
524
523
|
itemMetadata?: ItemMetadata;
|
|
525
524
|
}
|
|
526
|
-
|
|
525
|
+
interface MessageEnvelope {
|
|
527
526
|
/**
|
|
528
527
|
* App instance ID.
|
|
529
528
|
* @format GUID
|
|
@@ -539,7 +538,7 @@ export interface MessageEnvelope {
|
|
|
539
538
|
/** Stringify payload. */
|
|
540
539
|
data?: string;
|
|
541
540
|
}
|
|
542
|
-
|
|
541
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
543
542
|
/**
|
|
544
543
|
* ID of a site visitor that has not logged in to the site.
|
|
545
544
|
* @format GUID
|
|
@@ -564,7 +563,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
564
563
|
identityType?: WebhookIdentityType;
|
|
565
564
|
}
|
|
566
565
|
/** @oneof */
|
|
567
|
-
|
|
566
|
+
interface IdentificationDataIdOneOf {
|
|
568
567
|
/**
|
|
569
568
|
* ID of a site visitor that has not logged in to the site.
|
|
570
569
|
* @format GUID
|
|
@@ -586,14 +585,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
586
585
|
*/
|
|
587
586
|
appId?: string;
|
|
588
587
|
}
|
|
589
|
-
|
|
588
|
+
declare enum WebhookIdentityType {
|
|
590
589
|
UNKNOWN = "UNKNOWN",
|
|
591
590
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
592
591
|
MEMBER = "MEMBER",
|
|
593
592
|
WIX_USER = "WIX_USER",
|
|
594
593
|
APP = "APP"
|
|
595
594
|
}
|
|
596
|
-
|
|
595
|
+
interface BaseEventMetadata {
|
|
597
596
|
/**
|
|
598
597
|
* App instance ID.
|
|
599
598
|
* @format GUID
|
|
@@ -607,7 +606,7 @@ export interface BaseEventMetadata {
|
|
|
607
606
|
/** The identification type and identity data. */
|
|
608
607
|
identity?: IdentificationData;
|
|
609
608
|
}
|
|
610
|
-
|
|
609
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
611
610
|
/**
|
|
612
611
|
* Unique event ID.
|
|
613
612
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -645,70 +644,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
645
644
|
*/
|
|
646
645
|
entityEventSequence?: string | null;
|
|
647
646
|
}
|
|
648
|
-
|
|
647
|
+
interface SectionCreatedEnvelope {
|
|
649
648
|
entity: Section;
|
|
650
649
|
metadata: EventMetadata;
|
|
651
650
|
}
|
|
652
|
-
|
|
653
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
654
|
-
* @permissionScope Picasso private app mega scope
|
|
655
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
656
|
-
* @permissionId RESTAURANTS.SECTION_READ
|
|
657
|
-
* @webhook
|
|
658
|
-
* @eventType wix.restaurants.menus.v1.section_created
|
|
659
|
-
* @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
|
|
660
|
-
* @slug created
|
|
661
|
-
* @documentationMaturity preview
|
|
662
|
-
*/
|
|
663
|
-
export declare function onSectionCreated(handler: (event: SectionCreatedEnvelope) => void | Promise<void>): void;
|
|
664
|
-
export interface SectionDeletedEnvelope {
|
|
651
|
+
interface SectionDeletedEnvelope {
|
|
665
652
|
metadata: EventMetadata;
|
|
666
653
|
}
|
|
667
|
-
|
|
668
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
669
|
-
* @permissionScope Picasso private app mega scope
|
|
670
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
671
|
-
* @permissionId RESTAURANTS.SECTION_READ
|
|
672
|
-
* @webhook
|
|
673
|
-
* @eventType wix.restaurants.menus.v1.section_deleted
|
|
674
|
-
* @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
|
|
675
|
-
* @slug deleted
|
|
676
|
-
* @documentationMaturity preview
|
|
677
|
-
*/
|
|
678
|
-
export declare function onSectionDeleted(handler: (event: SectionDeletedEnvelope) => void | Promise<void>): void;
|
|
679
|
-
export interface SectionUpdatedEnvelope {
|
|
654
|
+
interface SectionUpdatedEnvelope {
|
|
680
655
|
entity: Section;
|
|
681
656
|
metadata: EventMetadata;
|
|
682
657
|
}
|
|
683
|
-
|
|
684
|
-
* Triggered when a section is updated.
|
|
685
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
686
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
687
|
-
* @permissionScope Picasso private app mega scope
|
|
688
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
689
|
-
* @permissionId RESTAURANTS.SECTION_READ
|
|
690
|
-
* @webhook
|
|
691
|
-
* @eventType wix.restaurants.menus.v1.section_updated
|
|
692
|
-
* @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
|
|
693
|
-
* @slug updated
|
|
694
|
-
* @documentationMaturity preview
|
|
695
|
-
*/
|
|
696
|
-
export declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope) => void | Promise<void>): void;
|
|
697
|
-
type SectionNonNullablePaths = `name` | `additionalImages` | `itemIds`;
|
|
698
|
-
/** @param _id - Section id to be duplicated.
|
|
699
|
-
* @public
|
|
700
|
-
* @documentationMaturity preview
|
|
701
|
-
* @requiredField _id
|
|
702
|
-
* @permissionId RESTAURANTS.SECTION_CREATE
|
|
703
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
704
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
705
|
-
* @permissionScope Picasso private app mega scope
|
|
706
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
707
|
-
* @applicableIdentity APP
|
|
708
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.restaurants_duplicate_section.RestaurantsDuplicateSection.DuplicateSection
|
|
709
|
-
*/
|
|
710
|
-
export declare function duplicateSection(_id: string, options?: DuplicateSectionOptions): Promise<NonNullablePaths<DuplicateSectionResponse, `sectionId`>>;
|
|
711
|
-
export interface DuplicateSectionOptions {
|
|
658
|
+
interface DuplicateSectionOptions {
|
|
712
659
|
/**
|
|
713
660
|
* Business location ids to duplicate the section to.
|
|
714
661
|
* @format GUID
|
|
@@ -718,87 +665,11 @@ export interface DuplicateSectionOptions {
|
|
|
718
665
|
/** Indicates whether sub-entities (such as items) should be duplicated as well. */
|
|
719
666
|
duplicateSubEntities?: boolean | null;
|
|
720
667
|
}
|
|
721
|
-
|
|
722
|
-
* > **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).
|
|
723
|
-
*
|
|
724
|
-
* Creates a section.
|
|
725
|
-
*
|
|
726
|
-
* To create multiple sections at once, use [Bulk Create Sections](/sections/bulk-create-sections).
|
|
727
|
-
* @param section - Section details.
|
|
728
|
-
* @public
|
|
729
|
-
* @documentationMaturity preview
|
|
730
|
-
* @requiredField section
|
|
731
|
-
* @permissionId RESTAURANTS.SECTION_CREATE
|
|
732
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
733
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
734
|
-
* @permissionScope Picasso private app mega scope
|
|
735
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
736
|
-
* @applicableIdentity APP
|
|
737
|
-
* @returns Section.
|
|
738
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.CreateSection
|
|
739
|
-
*/
|
|
740
|
-
export declare function createSection(section: Section): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
|
|
741
|
-
/**
|
|
742
|
-
* > **Note:** The Section 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).
|
|
743
|
-
*
|
|
744
|
-
* Creates multiple sections at once.
|
|
745
|
-
* @param sections - Sections details.
|
|
746
|
-
* @public
|
|
747
|
-
* @documentationMaturity preview
|
|
748
|
-
* @requiredField sections
|
|
749
|
-
* @permissionId RESTAURANTS.SECTION_CREATE
|
|
750
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
751
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
752
|
-
* @permissionScope Picasso private app mega scope
|
|
753
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
754
|
-
* @applicableIdentity APP
|
|
755
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.BulkCreateSections
|
|
756
|
-
*/
|
|
757
|
-
export declare function bulkCreateSections(sections: Section[], options?: BulkCreateSectionsOptions): Promise<NonNullablePaths<BulkCreateSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
758
|
-
[P in SectionNonNullablePaths]: `results.${number}.item.${P}`;
|
|
759
|
-
}[SectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
760
|
-
export interface BulkCreateSectionsOptions {
|
|
668
|
+
interface BulkCreateSectionsOptions {
|
|
761
669
|
/** Whether to receive the created sections in the response. */
|
|
762
670
|
returnEntity?: boolean;
|
|
763
671
|
}
|
|
764
|
-
|
|
765
|
-
* > **Note:** The Section 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).
|
|
766
|
-
*
|
|
767
|
-
* Retrieves a section by ID.
|
|
768
|
-
* @param sectionId - Section ID.
|
|
769
|
-
* @public
|
|
770
|
-
* @documentationMaturity preview
|
|
771
|
-
* @requiredField sectionId
|
|
772
|
-
* @permissionId RESTAURANTS.SECTION_READ
|
|
773
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
774
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
775
|
-
* @permissionScope Picasso private app mega scope
|
|
776
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
777
|
-
* @applicableIdentity APP
|
|
778
|
-
* @applicableIdentity VISITOR
|
|
779
|
-
* @returns Section.
|
|
780
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.GetSection
|
|
781
|
-
*/
|
|
782
|
-
export declare function getSection(sectionId: string): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
|
|
783
|
-
/**
|
|
784
|
-
* > **Note:** The Section 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).
|
|
785
|
-
*
|
|
786
|
-
* Retrieves a list of up to 500 sections.
|
|
787
|
-
* @public
|
|
788
|
-
* @documentationMaturity preview
|
|
789
|
-
* @permissionId RESTAURANTS.SECTION_READ
|
|
790
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
791
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
792
|
-
* @permissionScope Picasso private app mega scope
|
|
793
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
794
|
-
* @applicableIdentity APP
|
|
795
|
-
* @applicableIdentity VISITOR
|
|
796
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.ListSections
|
|
797
|
-
*/
|
|
798
|
-
export declare function listSections(options?: ListSectionsOptions): Promise<NonNullablePaths<ListSectionsResponse, {
|
|
799
|
-
[P in SectionNonNullablePaths]: `sections.${number}.${P}`;
|
|
800
|
-
}[SectionNonNullablePaths]>>;
|
|
801
|
-
export interface ListSectionsOptions {
|
|
672
|
+
interface ListSectionsOptions {
|
|
802
673
|
/**
|
|
803
674
|
* Section IDs.
|
|
804
675
|
* @format GUID
|
|
@@ -810,32 +681,6 @@ export interface ListSectionsOptions {
|
|
|
810
681
|
/** Whether to return only sections that are visible to site visitors. */
|
|
811
682
|
onlyVisible?: boolean | null;
|
|
812
683
|
}
|
|
813
|
-
/**
|
|
814
|
-
* Creates a query to retrieve a list of sections.
|
|
815
|
-
*
|
|
816
|
-
* The `querySections()` function builds a query to retrieve a list of sections and returns a `SectionsQueryBuilder` object.
|
|
817
|
-
*
|
|
818
|
-
* The returned object contains the query definition, which is used to run the query using the [`find()`](/sections/sections-query-builder/find) function.
|
|
819
|
-
*
|
|
820
|
-
* You can refine the query by chaining `SectionsQueryBuilder` functions onto the query. `SectionsQueryBuilder` functions enable you to filter, sort, and control the results that `querySections()` returns.
|
|
821
|
-
*
|
|
822
|
-
* `querySections()` runs with the following `SectionsQueryBuilder` defaults, which you can override:
|
|
823
|
-
*
|
|
824
|
-
* * [`limit(100)`](/sections/sections-query-builder/limit)
|
|
825
|
-
*
|
|
826
|
-
* 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`.
|
|
827
|
-
* @public
|
|
828
|
-
* @documentationMaturity preview
|
|
829
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
830
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
831
|
-
* @permissionScope Picasso private app mega scope
|
|
832
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
833
|
-
* @permissionId RESTAURANTS.SECTION_READ
|
|
834
|
-
* @applicableIdentity APP
|
|
835
|
-
* @applicableIdentity VISITOR
|
|
836
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.QuerySections
|
|
837
|
-
*/
|
|
838
|
-
export declare function querySections(): SectionsQueryBuilder;
|
|
839
684
|
interface QueryCursorResult {
|
|
840
685
|
cursors: Cursors;
|
|
841
686
|
hasNext: () => boolean;
|
|
@@ -843,13 +688,13 @@ interface QueryCursorResult {
|
|
|
843
688
|
length: number;
|
|
844
689
|
pageSize: number;
|
|
845
690
|
}
|
|
846
|
-
|
|
691
|
+
interface SectionsQueryResult extends QueryCursorResult {
|
|
847
692
|
items: Section[];
|
|
848
693
|
query: SectionsQueryBuilder;
|
|
849
694
|
next: () => Promise<SectionsQueryResult>;
|
|
850
695
|
prev: () => Promise<SectionsQueryResult>;
|
|
851
696
|
}
|
|
852
|
-
|
|
697
|
+
interface SectionsQueryBuilder {
|
|
853
698
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
854
699
|
* @param value - Value to compare against.
|
|
855
700
|
* @documentationMaturity preview
|
|
@@ -885,6 +730,11 @@ export interface SectionsQueryBuilder {
|
|
|
885
730
|
* @documentationMaturity preview
|
|
886
731
|
*/
|
|
887
732
|
startsWith: (propertyName: 'name' | 'description', value: string) => SectionsQueryBuilder;
|
|
733
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
734
|
+
* @param values - List of values to compare against.
|
|
735
|
+
* @documentationMaturity preview
|
|
736
|
+
*/
|
|
737
|
+
hasSome: (propertyName: 'itemIds', value: any[]) => SectionsQueryBuilder;
|
|
888
738
|
/** @documentationMaturity preview */
|
|
889
739
|
in: (propertyName: '_id' | 'name' | 'description', value: any) => SectionsQueryBuilder;
|
|
890
740
|
/** @documentationMaturity preview */
|
|
@@ -900,29 +750,7 @@ export interface SectionsQueryBuilder {
|
|
|
900
750
|
/** @documentationMaturity preview */
|
|
901
751
|
find: () => Promise<SectionsQueryResult>;
|
|
902
752
|
}
|
|
903
|
-
|
|
904
|
-
* > **Note:** The Section 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).
|
|
905
|
-
*
|
|
906
|
-
* Updates a section.
|
|
907
|
-
*
|
|
908
|
-
* Each time a section is updated, its revision increments by 1. The existing revision must be included when updating a section. This ensures you're working with the latest section information, and it prevents unintended overwrites.
|
|
909
|
-
* @param _id - Section ID.
|
|
910
|
-
* @public
|
|
911
|
-
* @documentationMaturity preview
|
|
912
|
-
* @requiredField _id
|
|
913
|
-
* @requiredField section
|
|
914
|
-
* @requiredField section.revision
|
|
915
|
-
* @permissionId RESTAURANTS.SECTION_UPDATE
|
|
916
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
917
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
918
|
-
* @permissionScope Picasso private app mega scope
|
|
919
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
920
|
-
* @applicableIdentity APP
|
|
921
|
-
* @returns Updated section.
|
|
922
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.UpdateSection
|
|
923
|
-
*/
|
|
924
|
-
export declare function updateSection(_id: string, section: NonNullablePaths<UpdateSection, `revision`>): Promise<NonNullablePaths<Section, SectionNonNullablePaths>>;
|
|
925
|
-
export interface UpdateSection {
|
|
753
|
+
interface UpdateSection {
|
|
926
754
|
/**
|
|
927
755
|
* Section ID.
|
|
928
756
|
* @format GUID
|
|
@@ -973,65 +801,9 @@ export interface UpdateSection {
|
|
|
973
801
|
/** Whether the section is visible in the menu for site visitors. */
|
|
974
802
|
visible?: boolean | null;
|
|
975
803
|
}
|
|
976
|
-
|
|
977
|
-
* > **Note:** The Section 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).
|
|
978
|
-
*
|
|
979
|
-
* Updates multiple sections at once.
|
|
980
|
-
*
|
|
981
|
-
* Each time a section is updated, its revision increments by 1. The existing revision must be included when updating a section. This ensures you're working with the latest section information, and it prevents unintended overwrites.
|
|
982
|
-
* @param sections - Sections to update.
|
|
983
|
-
* @public
|
|
984
|
-
* @documentationMaturity preview
|
|
985
|
-
* @requiredField sections
|
|
986
|
-
* @requiredField sections.section._id
|
|
987
|
-
* @requiredField sections.section.revision
|
|
988
|
-
* @permissionId RESTAURANTS.SECTION_UPDATE
|
|
989
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
990
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
991
|
-
* @permissionScope Picasso private app mega scope
|
|
992
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
993
|
-
* @applicableIdentity APP
|
|
994
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.BulkUpdateSection
|
|
995
|
-
*/
|
|
996
|
-
export declare function bulkUpdateSection(sections: NonNullablePaths<MaskedSection, `section._id` | `section.revision`>[], options?: BulkUpdateSectionOptions): Promise<NonNullablePaths<BulkUpdateSectionResponse, `results` | `results.${number}.sectionMetadata.originalIndex` | `results.${number}.sectionMetadata.success` | `results.${number}.sectionMetadata.error.code` | `results.${number}.sectionMetadata.error.description` | {
|
|
997
|
-
[P in SectionNonNullablePaths]: `results.${number}.section.${P}`;
|
|
998
|
-
}[SectionNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
999
|
-
export interface BulkUpdateSectionOptions {
|
|
804
|
+
interface BulkUpdateSectionOptions {
|
|
1000
805
|
/** Whether to receive the updated sections in the response. */
|
|
1001
806
|
returnEntity?: boolean;
|
|
1002
807
|
}
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
*
|
|
1006
|
-
* Deletes a section.
|
|
1007
|
-
* @param sectionId - Section ID.
|
|
1008
|
-
* @public
|
|
1009
|
-
* @documentationMaturity preview
|
|
1010
|
-
* @requiredField sectionId
|
|
1011
|
-
* @permissionId RESTAURANTS.SECTION_DELETE
|
|
1012
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1013
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1014
|
-
* @permissionScope Picasso private app mega scope
|
|
1015
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1016
|
-
* @applicableIdentity APP
|
|
1017
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.DeleteSection
|
|
1018
|
-
*/
|
|
1019
|
-
export declare function deleteSection(sectionId: string): Promise<void>;
|
|
1020
|
-
/**
|
|
1021
|
-
* > **Note:** The Section 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).
|
|
1022
|
-
*
|
|
1023
|
-
* Deletes multiple sections at once.
|
|
1024
|
-
* @param ids - Section IDs.
|
|
1025
|
-
* @public
|
|
1026
|
-
* @documentationMaturity preview
|
|
1027
|
-
* @requiredField ids
|
|
1028
|
-
* @permissionId RESTAURANTS.SECTION_DELETE
|
|
1029
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
1030
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
1031
|
-
* @permissionScope Picasso private app mega scope
|
|
1032
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1033
|
-
* @applicableIdentity APP
|
|
1034
|
-
* @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.BulkDeleteSections
|
|
1035
|
-
*/
|
|
1036
|
-
export declare function bulkDeleteSections(ids: string[]): Promise<NonNullablePaths<BulkDeleteSectionsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
1037
|
-
export {};
|
|
808
|
+
|
|
809
|
+
export { type DomainEventBodyOneOf as $, type App as A, type BulkCreateSectionsOptions as B, type CreateSectionRequest as C, type DuplicateSectionOptions as D, type ExtendedFields as E, type File as F, type GetSectionRequest as G, type QuerySectionsResponse as H, type InvalidateCache as I, type UpdateSectionRequest as J, type UpdateSectionResponse as K, type ListSectionsOptions as L, type MaskedSection as M, type BulkUpdateSectionRequest as N, type BulkSectionResult as O, type Page as P, type QuerySectionsRequest as Q, type DeleteSectionRequest as R, type Section as S, type DeleteSectionResponse as T, type UpdateSection as U, type BulkDeleteSectionsRequest as V, WebhookIdentityType as W, type BulkDeleteSectionResult as X, type CloneSectionsRequest as Y, type CloneSectionsResponse as Z, type DomainEvent as _, type DuplicateSectionResponse as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type Empty as a5, type BulkUpdateBusinessLocationIdRequest as a6, type BulkUpdateBusinessLocationIdResponse as a7, type BulkItemResult as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type SectionCreatedEnvelope as ae, type SectionDeletedEnvelope as af, type SectionUpdatedEnvelope as ag, type SectionsQueryResult as ah, type BulkCreateSectionsResponse as b, type ListSectionsResponse as c, type SectionsQueryBuilder as d, type BulkUpdateSectionOptions as e, type BulkUpdateSectionResponse as f, type BulkDeleteSectionsResponse as g, SortOrder as h, type DuplicateSectionRequest as i, type InvalidateCacheGetByOneOf as j, type URI as k, type DeleteLocationIdFromItems as l, type CreateSectionResponse as m, type BulkCreateSectionsRequest as n, type BulkCreateSectionResult as o, type ItemMetadata as p, type ApplicationError as q, type BulkActionMetadata as r, type GetSectionResponse as s, type ListSectionsRequest as t, type CursorPaging as u, type CursorPagingMetadata as v, type Cursors as w, type CursorQuery as x, type CursorQueryPagingMethodOneOf as y, type Sorting as z };
|