@wix/auto_sdk_restaurants_sections 1.0.0 → 1.0.2

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.
Files changed (69) hide show
  1. package/build/cjs/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
  2. package/build/cjs/src/restaurants-menus-v1-section-sections.context.js +2 -1
  3. package/build/cjs/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
  4. package/build/cjs/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
  5. package/build/cjs/src/restaurants-menus-v1-section-sections.http.js +20 -2
  6. package/build/cjs/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
  7. package/build/cjs/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
  8. package/build/cjs/src/restaurants-menus-v1-section-sections.meta.js +20 -1
  9. package/build/cjs/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
  10. package/build/cjs/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
  11. package/build/cjs/src/restaurants-menus-v1-section-sections.public.js +7 -1
  12. package/build/cjs/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
  13. package/build/cjs/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
  14. package/build/cjs/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
  15. package/build/cjs/src/restaurants-menus-v1-section-sections.universal.d.ts +298 -69
  16. package/build/cjs/src/restaurants-menus-v1-section-sections.universal.js +59 -26
  17. package/build/cjs/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
  18. package/build/es/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
  19. package/build/es/src/restaurants-menus-v1-section-sections.context.js +2 -1
  20. package/build/es/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
  21. package/build/es/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
  22. package/build/es/src/restaurants-menus-v1-section-sections.http.js +18 -1
  23. package/build/es/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
  24. package/build/es/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
  25. package/build/es/src/restaurants-menus-v1-section-sections.meta.js +18 -0
  26. package/build/es/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
  27. package/build/es/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
  28. package/build/es/src/restaurants-menus-v1-section-sections.public.js +6 -1
  29. package/build/es/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
  30. package/build/es/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
  31. package/build/es/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
  32. package/build/es/src/restaurants-menus-v1-section-sections.universal.d.ts +298 -69
  33. package/build/es/src/restaurants-menus-v1-section-sections.universal.js +57 -25
  34. package/build/es/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
  35. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
  36. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.js +2 -1
  37. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
  38. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
  39. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.js +20 -2
  40. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
  41. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
  42. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.js +20 -1
  43. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
  44. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
  45. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.js +7 -1
  46. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
  47. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
  48. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
  49. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.d.ts +298 -69
  50. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.js +59 -26
  51. package/build/internal/cjs/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
  52. package/build/internal/es/src/restaurants-menus-v1-section-sections.context.d.ts +3 -2
  53. package/build/internal/es/src/restaurants-menus-v1-section-sections.context.js +2 -1
  54. package/build/internal/es/src/restaurants-menus-v1-section-sections.context.js.map +1 -1
  55. package/build/internal/es/src/restaurants-menus-v1-section-sections.http.d.ts +1 -1
  56. package/build/internal/es/src/restaurants-menus-v1-section-sections.http.js +18 -1
  57. package/build/internal/es/src/restaurants-menus-v1-section-sections.http.js.map +1 -1
  58. package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.d.ts +3 -0
  59. package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.js +18 -0
  60. package/build/internal/es/src/restaurants-menus-v1-section-sections.meta.js.map +1 -1
  61. package/build/internal/es/src/restaurants-menus-v1-section-sections.public.d.ts +7 -3
  62. package/build/internal/es/src/restaurants-menus-v1-section-sections.public.js +6 -1
  63. package/build/internal/es/src/restaurants-menus-v1-section-sections.public.js.map +1 -1
  64. package/build/internal/es/src/restaurants-menus-v1-section-sections.types.d.ts +203 -37
  65. package/build/internal/es/src/restaurants-menus-v1-section-sections.types.js.map +1 -1
  66. package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.d.ts +298 -69
  67. package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.js +57 -25
  68. package/build/internal/es/src/restaurants-menus-v1-section-sections.universal.js.map +1 -1
  69. 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
- /** Section name. */
23
+ /**
24
+ * Section name.
25
+ * @minLength 1
26
+ * @maxLength 500
27
+ */
23
28
  name?: string;
24
- /** Section description. */
29
+ /**
30
+ * Section description.
31
+ * @maxLength 1500
32
+ */
25
33
  description?: string | null;
26
34
  /** Main section image. */
27
35
  image?: string;
28
- /** Additional section images. */
36
+ /**
37
+ * Additional section images.
38
+ * @maxSize 100
39
+ */
29
40
  additionalImages?: string[];
30
- /** Item IDs. */
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
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
83
+ /**
84
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
85
+ * @format GUID
86
+ */
50
87
  metaSiteId?: string;
51
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
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
- /** tell us why you're invalidating the cache. You don't need to add your app name */
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
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
112
+ /**
113
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
114
+ * @format GUID
115
+ */
70
116
  metaSiteId?: string;
71
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
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
- /** The AppDefId */
132
+ /**
133
+ * The AppDefId
134
+ * @minLength 1
135
+ */
84
136
  appDefId?: string;
85
- /** The instance Id */
137
+ /**
138
+ * The instance Id
139
+ * @format GUID
140
+ */
86
141
  instanceId?: string;
87
142
  }
88
143
  export interface Page {
89
- /** the msid the page is on */
144
+ /**
145
+ * the msid the page is on
146
+ * @format GUID
147
+ */
90
148
  metaSiteId?: string;
91
- /** Invalidate by Page ID */
149
+ /**
150
+ * Invalidate by Page ID
151
+ * @minLength 1
152
+ */
92
153
  pageId?: string;
93
154
  }
94
155
  export interface URI {
95
- /** the msid the URI is on */
156
+ /**
157
+ * the msid the URI is on
158
+ * @format GUID
159
+ */
96
160
  metaSiteId?: string;
97
- /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
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
- /** the msid the file is related to */
168
+ /**
169
+ * the msid the file is related to
170
+ * @format GUID
171
+ */
102
172
  metaSiteId?: string;
103
- /** Invalidate by filename (for media files such as PDFs) */
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
- /** Sections details. */
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
- /** Section ID. */
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
- /** Section IDs. */
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
- /** Number of items to load. */
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
- /** Name of the field to sort by. */
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
- /** Sections to update. */
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
- /** Information about the updated sections. */
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
- /** Section ID. */
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
- /** Section IDs. */
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
- /** The MetaSiteId to clone from. */
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
- /** App instance ID. */
517
+ /**
518
+ * App instance ID.
519
+ * @format GUID
520
+ */
385
521
  instanceId?: string | null;
386
- /** Event type. */
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
- /** ID of a site visitor that has not logged in to the site. */
533
+ /**
534
+ * ID of a site visitor that has not logged in to the site.
535
+ * @format GUID
536
+ */
395
537
  anonymousVisitorId?: string;
396
- /** ID of a site visitor that has logged in to the site. */
538
+ /**
539
+ * ID of a site visitor that has logged in to the site.
540
+ * @format GUID
541
+ */
397
542
  memberId?: string;
398
- /** ID of a Wix user (site owner, contributor, etc.). */
543
+ /**
544
+ * ID of a Wix user (site owner, contributor, etc.).
545
+ * @format GUID
546
+ */
399
547
  wixUserId?: string;
400
- /** ID of an app. */
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
- /** ID of a site visitor that has not logged in to the site. */
558
+ /**
559
+ * ID of a site visitor that has not logged in to the site.
560
+ * @format GUID
561
+ */
408
562
  anonymousVisitorId?: string;
409
- /** ID of a site visitor that has logged in to the site. */
563
+ /**
564
+ * ID of a site visitor that has logged in to the site.
565
+ * @format GUID
566
+ */
410
567
  memberId?: string;
411
- /** ID of a Wix user (site owner, contributor, etc.). */
568
+ /**
569
+ * ID of a Wix user (site owner, contributor, etc.).
570
+ * @format GUID
571
+ */
412
572
  wixUserId?: string;
413
- /** ID of an app. */
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
- /** App instance ID. */
648
+ /**
649
+ * App instance ID.
650
+ * @format GUID
651
+ */
483
652
  instanceId?: string | null;
484
- /** Event type. */
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,13 +702,21 @@ 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
718
+ * @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
719
+ * @slug created
540
720
  * @documentationMaturity preview
541
721
  */
542
722
  export declare function onSectionCreated(handler: (event: SectionCreatedEnvelope) => void | Promise<void>): void;
@@ -545,13 +725,21 @@ export interface SectionDeletedEnvelope {
545
725
  }
546
726
  /** @permissionScope Manage Bookings Services and Settings
547
727
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
728
+ * @permissionScope Manage Events
729
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
548
730
  * @permissionScope Manage Portfolio
549
731
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
732
+ * @permissionScope Access Verticals by Automations
733
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
550
734
  * @permissionScope Manage Restaurants - all permissions
551
735
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
736
+ * @permissionScope Set Up Automations
737
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
552
738
  * @permissionId RESTAURANTS.SECTION_READ
553
739
  * @webhook
554
740
  * @eventType wix.restaurants.menus.v1.section_deleted
741
+ * @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
742
+ * @slug deleted
555
743
  * @documentationMaturity preview
556
744
  */
557
745
  export declare function onSectionDeleted(handler: (event: SectionDeletedEnvelope) => void | Promise<void>): void;
@@ -563,16 +751,45 @@ export interface SectionUpdatedEnvelope {
563
751
  * Triggered when a section is updated.
564
752
  * @permissionScope Manage Bookings Services and Settings
565
753
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
754
+ * @permissionScope Manage Events
755
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
566
756
  * @permissionScope Manage Portfolio
567
757
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
758
+ * @permissionScope Access Verticals by Automations
759
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
568
760
  * @permissionScope Manage Restaurants - all permissions
569
761
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
762
+ * @permissionScope Set Up Automations
763
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
570
764
  * @permissionId RESTAURANTS.SECTION_READ
571
765
  * @webhook
572
766
  * @eventType wix.restaurants.menus.v1.section_updated
767
+ * @serviceIdentifier com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection
768
+ * @slug updated
573
769
  * @documentationMaturity preview
574
770
  */
575
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
+ }
576
793
  /**
577
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).
578
795
  *
@@ -584,10 +801,6 @@ export declare function onSectionUpdated(handler: (event: SectionUpdatedEnvelope
584
801
  * @documentationMaturity preview
585
802
  * @requiredField section
586
803
  * @permissionId RESTAURANTS.SECTION_CREATE
587
- * @permissionScope Manage Bookings Services and Settings
588
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
589
- * @permissionScope Manage Portfolio
590
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
591
804
  * @permissionScope Manage Restaurants - all permissions
592
805
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
593
806
  * @applicableIdentity APP
@@ -604,10 +817,6 @@ export declare function createSection(section: Section): Promise<Section & Secti
604
817
  * @documentationMaturity preview
605
818
  * @requiredField sections
606
819
  * @permissionId RESTAURANTS.SECTION_CREATE
607
- * @permissionScope Manage Bookings Services and Settings
608
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
609
- * @permissionScope Manage Portfolio
610
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
611
820
  * @permissionScope Manage Restaurants - all permissions
612
821
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
613
822
  * @applicableIdentity APP
@@ -629,10 +838,16 @@ export interface BulkCreateSectionsOptions {
629
838
  * @permissionId RESTAURANTS.SECTION_READ
630
839
  * @permissionScope Manage Bookings Services and Settings
631
840
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
841
+ * @permissionScope Manage Events
842
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
632
843
  * @permissionScope Manage Portfolio
633
844
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
845
+ * @permissionScope Access Verticals by Automations
846
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
634
847
  * @permissionScope Manage Restaurants - all permissions
635
848
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
849
+ * @permissionScope Set Up Automations
850
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
636
851
  * @applicableIdentity APP
637
852
  * @applicableIdentity VISITOR
638
853
  * @returns Section.
@@ -648,17 +863,27 @@ export declare function getSection(sectionId: string): Promise<Section & Section
648
863
  * @permissionId RESTAURANTS.SECTION_READ
649
864
  * @permissionScope Manage Bookings Services and Settings
650
865
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
866
+ * @permissionScope Manage Events
867
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
651
868
  * @permissionScope Manage Portfolio
652
869
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
870
+ * @permissionScope Access Verticals by Automations
871
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
653
872
  * @permissionScope Manage Restaurants - all permissions
654
873
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
874
+ * @permissionScope Set Up Automations
875
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
655
876
  * @applicableIdentity APP
656
877
  * @applicableIdentity VISITOR
657
878
  * @fqn com.wixpress.restaurants.menus_section.v1.RestaurantsMenusSection.ListSections
658
879
  */
659
880
  export declare function listSections(options?: ListSectionsOptions): Promise<ListSectionsResponse & ListSectionsResponseNonNullableFields>;
660
881
  export interface ListSectionsOptions {
661
- /** Section IDs. */
882
+ /**
883
+ * Section IDs.
884
+ * @format GUID
885
+ * @maxSize 500
886
+ */
662
887
  sectionIds?: string[];
663
888
  /** The metadata of the paginated results. */
664
889
  paging?: CursorPaging;
@@ -677,17 +902,22 @@ export interface ListSectionsOptions {
677
902
  * `querySections()` runs with the following `SectionsQueryBuilder` defaults, which you can override:
678
903
  *
679
904
  * * [`limit(100)`](/sections/sections-query-builder/limit)
680
- * * [`ascending('entityId')`](/sections/sections-query-builder/ascending)
681
905
  *
682
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`.
683
907
  * @public
684
908
  * @documentationMaturity preview
685
909
  * @permissionScope Manage Bookings Services and Settings
686
910
  * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
911
+ * @permissionScope Manage Events
912
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
687
913
  * @permissionScope Manage Portfolio
688
914
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
915
+ * @permissionScope Access Verticals by Automations
916
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
689
917
  * @permissionScope Manage Restaurants - all permissions
690
918
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
919
+ * @permissionScope Set Up Automations
920
+ * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
691
921
  * @permissionId RESTAURANTS.SECTION_READ
692
922
  * @applicableIdentity APP
693
923
  * @applicableIdentity VISITOR
@@ -771,10 +1001,6 @@ export interface SectionsQueryBuilder {
771
1001
  * @requiredField section
772
1002
  * @requiredField section.revision
773
1003
  * @permissionId RESTAURANTS.SECTION_UPDATE
774
- * @permissionScope Manage Bookings Services and Settings
775
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
776
- * @permissionScope Manage Portfolio
777
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
778
1004
  * @permissionScope Manage Restaurants - all permissions
779
1005
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
780
1006
  * @applicableIdentity APP
@@ -785,6 +1011,7 @@ export declare function updateSection(_id: string | null, section: UpdateSection
785
1011
  export interface UpdateSection {
786
1012
  /**
787
1013
  * Section ID.
1014
+ * @format GUID
788
1015
  * @readonly
789
1016
  */
790
1017
  _id?: string | null;
@@ -803,15 +1030,29 @@ export interface UpdateSection {
803
1030
  * @readonly
804
1031
  */
805
1032
  _updatedDate?: Date | null;
806
- /** Section name. */
1033
+ /**
1034
+ * Section name.
1035
+ * @minLength 1
1036
+ * @maxLength 500
1037
+ */
807
1038
  name?: string;
808
- /** Section description. */
1039
+ /**
1040
+ * Section description.
1041
+ * @maxLength 1500
1042
+ */
809
1043
  description?: string | null;
810
1044
  /** Main section image. */
811
1045
  image?: string;
812
- /** Additional section images. */
1046
+ /**
1047
+ * Additional section images.
1048
+ * @maxSize 100
1049
+ */
813
1050
  additionalImages?: string[];
814
- /** Item IDs. */
1051
+ /**
1052
+ * Item IDs.
1053
+ * @format GUID
1054
+ * @maxSize 1000
1055
+ */
815
1056
  itemIds?: string[];
816
1057
  /** Extended fields. */
817
1058
  extendedFields?: ExtendedFields;
@@ -831,10 +1072,6 @@ export interface UpdateSection {
831
1072
  * @requiredField sections.section._id
832
1073
  * @requiredField sections.section.revision
833
1074
  * @permissionId RESTAURANTS.SECTION_UPDATE
834
- * @permissionScope Manage Bookings Services and Settings
835
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
836
- * @permissionScope Manage Portfolio
837
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
838
1075
  * @permissionScope Manage Restaurants - all permissions
839
1076
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
840
1077
  * @applicableIdentity APP
@@ -854,10 +1091,6 @@ export interface BulkUpdateSectionOptions {
854
1091
  * @documentationMaturity preview
855
1092
  * @requiredField sectionId
856
1093
  * @permissionId RESTAURANTS.SECTION_DELETE
857
- * @permissionScope Manage Bookings Services and Settings
858
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
859
- * @permissionScope Manage Portfolio
860
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
861
1094
  * @permissionScope Manage Restaurants - all permissions
862
1095
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
863
1096
  * @applicableIdentity APP
@@ -873,10 +1106,6 @@ export declare function deleteSection(sectionId: string): Promise<void>;
873
1106
  * @documentationMaturity preview
874
1107
  * @requiredField ids
875
1108
  * @permissionId RESTAURANTS.SECTION_DELETE
876
- * @permissionScope Manage Bookings Services and Settings
877
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
878
- * @permissionScope Manage Portfolio
879
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
880
1109
  * @permissionScope Manage Restaurants - all permissions
881
1110
  * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
882
1111
  * @applicableIdentity APP