@wix/auto_sdk_stores_ribbons-v-3 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.
Files changed (21) hide show
  1. package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.d.ts +184 -41
  2. package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js.map +1 -1
  3. package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.d.ts +253 -47
  4. package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js +28 -0
  5. package/build/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js.map +1 -1
  6. package/build/es/src/stores-catalog-v3-ribbon-ribbons-v-3.types.d.ts +184 -41
  7. package/build/es/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js.map +1 -1
  8. package/build/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.d.ts +253 -47
  9. package/build/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js +28 -0
  10. package/build/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js.map +1 -1
  11. package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.d.ts +184 -41
  12. package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js.map +1 -1
  13. package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.d.ts +253 -47
  14. package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js +28 -0
  15. package/build/internal/cjs/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js.map +1 -1
  16. package/build/internal/es/src/stores-catalog-v3-ribbon-ribbons-v-3.types.d.ts +184 -41
  17. package/build/internal/es/src/stores-catalog-v3-ribbon-ribbons-v-3.types.js.map +1 -1
  18. package/build/internal/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.d.ts +253 -47
  19. package/build/internal/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js +28 -0
  20. package/build/internal/es/src/stores-catalog-v3-ribbon-ribbons-v-3.universal.js.map +1 -1
  21. package/package.json +4 -4
@@ -2,6 +2,7 @@
2
2
  export interface Ribbon {
3
3
  /**
4
4
  * Ribbon ID.
5
+ * @format GUID
5
6
  * @readonly
6
7
  */
7
8
  _id?: string | null;
@@ -24,7 +25,11 @@ export interface Ribbon {
24
25
  * @readonly
25
26
  */
26
27
  _updatedDate?: Date | null;
27
- /** Ribbon name. */
28
+ /**
29
+ * Ribbon name.
30
+ * @minLength 1
31
+ * @maxLength 30
32
+ */
28
33
  name?: string;
29
34
  /**
30
35
  * Number of products this ribbon is assigned to.
@@ -34,9 +39,15 @@ export interface Ribbon {
34
39
  assignedProductCount?: number | null;
35
40
  }
36
41
  export interface InvalidateCache extends InvalidateCacheGetByOneOf {
37
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
42
+ /**
43
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
44
+ * @format GUID
45
+ */
38
46
  metaSiteId?: string;
39
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
47
+ /**
48
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
49
+ * @format GUID
50
+ */
40
51
  siteId?: string;
41
52
  /** Invalidate by App */
42
53
  app?: App;
@@ -46,7 +57,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
46
57
  uri?: URI;
47
58
  /** Invalidate by file (for media files such as PDFs) */
48
59
  file?: File;
49
- /** tell us why you're invalidating the cache. You don't need to add your app name */
60
+ /**
61
+ * tell us why you're invalidating the cache. You don't need to add your app name
62
+ * @maxLength 256
63
+ */
50
64
  reason?: string | null;
51
65
  /** Is local DS */
52
66
  localDc?: boolean;
@@ -54,9 +68,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
54
68
  }
55
69
  /** @oneof */
56
70
  export interface InvalidateCacheGetByOneOf {
57
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
71
+ /**
72
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
73
+ * @format GUID
74
+ */
58
75
  metaSiteId?: string;
59
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
76
+ /**
77
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
78
+ * @format GUID
79
+ */
60
80
  siteId?: string;
61
81
  /** Invalidate by App */
62
82
  app?: App;
@@ -68,27 +88,52 @@ export interface InvalidateCacheGetByOneOf {
68
88
  file?: File;
69
89
  }
70
90
  export interface App {
71
- /** The AppDefId */
91
+ /**
92
+ * The AppDefId
93
+ * @minLength 1
94
+ */
72
95
  appDefId?: string;
73
- /** The instance Id */
96
+ /**
97
+ * The instance Id
98
+ * @format GUID
99
+ */
74
100
  instanceId?: string;
75
101
  }
76
102
  export interface Page {
77
- /** the msid the page is on */
103
+ /**
104
+ * the msid the page is on
105
+ * @format GUID
106
+ */
78
107
  metaSiteId?: string;
79
- /** Invalidate by Page ID */
108
+ /**
109
+ * Invalidate by Page ID
110
+ * @minLength 1
111
+ */
80
112
  pageId?: string;
81
113
  }
82
114
  export interface URI {
83
- /** the msid the URI is on */
115
+ /**
116
+ * the msid the URI is on
117
+ * @format GUID
118
+ */
84
119
  metaSiteId?: string;
85
- /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
120
+ /**
121
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
122
+ * @minLength 1
123
+ */
86
124
  uriPath?: string;
87
125
  }
88
126
  export interface File {
89
- /** the msid the file is related to */
127
+ /**
128
+ * the msid the file is related to
129
+ * @format GUID
130
+ */
90
131
  metaSiteId?: string;
91
- /** Invalidate by filename (for media files such as PDFs) */
132
+ /**
133
+ * Invalidate by filename (for media files such as PDFs)
134
+ * @minLength 1
135
+ * @maxLength 256
136
+ */
92
137
  fileName?: string;
93
138
  }
94
139
  export interface CreateRibbonRequest {
@@ -100,12 +145,16 @@ export interface CreateRibbonResponse {
100
145
  ribbon?: Ribbon;
101
146
  }
102
147
  export interface GetRibbonRequest {
103
- /** Ribbon ID. */
148
+ /**
149
+ * Ribbon ID.
150
+ * @format GUID
151
+ */
104
152
  ribbonId: string;
105
153
  /**
106
154
  * Fields to include in the response.
107
155
  *
108
156
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
157
+ * @maxSize 100
109
158
  */
110
159
  fields?: RequestedFields[];
111
160
  }
@@ -124,6 +173,7 @@ export interface UpdateRibbonRequest {
124
173
  * Fields to include in the response.
125
174
  *
126
175
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
176
+ * @maxSize 100
127
177
  */
128
178
  fields?: RequestedFields[];
129
179
  }
@@ -132,7 +182,10 @@ export interface UpdateRibbonResponse {
132
182
  ribbon?: Ribbon;
133
183
  }
134
184
  export interface DeleteRibbonRequest {
135
- /** Ribbon ID. */
185
+ /**
186
+ * Ribbon ID.
187
+ * @format GUID
188
+ */
136
189
  ribbonId: string;
137
190
  }
138
191
  export interface DeleteRibbonResponse {
@@ -144,6 +197,7 @@ export interface QueryRibbonsRequest {
144
197
  * Fields to include in the response.
145
198
  *
146
199
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
200
+ * @maxSize 100
147
201
  */
148
202
  fields?: RequestedFields[];
149
203
  }
@@ -162,6 +216,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
162
216
  /**
163
217
  * Sort object in the following format:
164
218
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
219
+ * @maxSize 4
165
220
  */
166
221
  sort?: Sorting[];
167
222
  }
@@ -171,7 +226,10 @@ export interface CursorQueryPagingMethodOneOf {
171
226
  cursorPaging?: CursorPaging;
172
227
  }
173
228
  export interface Sorting {
174
- /** Name of the field to sort by. */
229
+ /**
230
+ * Name of the field to sort by.
231
+ * @maxLength 512
232
+ */
175
233
  fieldName?: string;
176
234
  /** Sort order. */
177
235
  order?: SortOrder;
@@ -183,18 +241,26 @@ export declare enum SortOrder {
183
241
  DESC = "DESC"
184
242
  }
185
243
  export interface CursorPaging {
186
- /** Maximum number of items to return in the results. */
244
+ /**
245
+ * Maximum number of items to return in the results.
246
+ * @max 100
247
+ */
187
248
  limit?: number | null;
188
249
  /**
189
250
  * Pointer to the next or previous page in the list of results.
190
251
  *
191
252
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
192
253
  * Not relevant for the first request.
254
+ * @maxLength 16000
193
255
  */
194
256
  cursor?: string | null;
195
257
  }
196
258
  export interface QueryRibbonsResponse {
197
- /** List of ribbons. */
259
+ /**
260
+ * List of ribbons.
261
+ * @minSize 1
262
+ * @maxSize 100
263
+ */
198
264
  ribbons?: Ribbon[];
199
265
  /** Details on the paged set of results returned. */
200
266
  pagingMetadata?: CursorPagingMetadata;
@@ -213,13 +279,23 @@ export interface CursorPagingMetadata {
213
279
  hasNext?: boolean | null;
214
280
  }
215
281
  export interface Cursors {
216
- /** Cursor string pointing to the next page in the list of results. */
282
+ /**
283
+ * Cursor string pointing to the next page in the list of results.
284
+ * @maxLength 16000
285
+ */
217
286
  next?: string | null;
218
- /** Cursor pointing to the previous page in the list of results. */
287
+ /**
288
+ * Cursor pointing to the previous page in the list of results.
289
+ * @maxLength 16000
290
+ */
219
291
  prev?: string | null;
220
292
  }
221
293
  export interface BulkCreateRibbonsRequest {
222
- /** Ribbons to create. */
294
+ /**
295
+ * Ribbons to create.
296
+ * @minSize 1
297
+ * @maxSize 100
298
+ */
223
299
  ribbons: Ribbon[];
224
300
  /**
225
301
  * Whether to return the full created ribbon entities in the response.
@@ -229,7 +305,10 @@ export interface BulkCreateRibbonsRequest {
229
305
  returnEntity?: boolean;
230
306
  }
231
307
  export interface BulkCreateRibbonsResponse {
232
- /** Ribbons created by bulk action. */
308
+ /**
309
+ * Ribbons created by bulk action.
310
+ * @maxSize 100
311
+ */
233
312
  results?: V3BulkRibbonResult[];
234
313
  /** Bulk action metadata. */
235
314
  bulkActionMetadata?: BulkActionMetadata;
@@ -245,7 +324,10 @@ export interface V3BulkRibbonResult {
245
324
  item?: Ribbon;
246
325
  }
247
326
  export interface ItemMetadata {
248
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
327
+ /**
328
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
329
+ * @format GUID
330
+ */
249
331
  _id?: string | null;
250
332
  /** Index of the item within the request array. Allows for correlation between request and response items. */
251
333
  originalIndex?: number;
@@ -271,7 +353,11 @@ export interface BulkActionMetadata {
271
353
  undetailedFailures?: number;
272
354
  }
273
355
  export interface BulkUpdateRibbonsRequest {
274
- /** List of ribbons to update. */
356
+ /**
357
+ * List of ribbons to update.
358
+ * @minSize 1
359
+ * @maxSize 100
360
+ */
275
361
  ribbons: MaskedRibbon[];
276
362
  /**
277
363
  * Whether to return the full updated ribbon entities in the response.
@@ -283,6 +369,7 @@ export interface BulkUpdateRibbonsRequest {
283
369
  * Fields to include in the response.
284
370
  *
285
371
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
372
+ * @maxSize 100
286
373
  */
287
374
  fields?: RequestedFields[];
288
375
  }
@@ -293,18 +380,26 @@ export interface MaskedRibbon {
293
380
  fieldMask?: string[];
294
381
  }
295
382
  export interface BulkUpdateRibbonsResponse {
296
- /** Ribbons updated by bulk action. */
383
+ /**
384
+ * Ribbons updated by bulk action.
385
+ * @maxSize 100
386
+ */
297
387
  results?: V3BulkRibbonResult[];
298
388
  /** Bulk action metadata. */
299
389
  bulkActionMetadata?: BulkActionMetadata;
300
390
  }
301
391
  export interface GetOrCreateRibbonRequest {
302
- /** Ribbon name to retrieve or create. */
392
+ /**
393
+ * Ribbon name to retrieve or create.
394
+ * @minLength 1
395
+ * @maxLength 30
396
+ */
303
397
  ribbonName: string;
304
398
  /**
305
399
  * Fields to include in the response.
306
400
  *
307
401
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
402
+ * @maxSize 100
308
403
  */
309
404
  fields?: RequestedFields[];
310
405
  }
@@ -313,27 +408,45 @@ export interface GetOrCreateRibbonResponse {
313
408
  ribbon?: Ribbon;
314
409
  }
315
410
  export interface BulkGetOrCreateRibbonsRequest {
316
- /** Ribbon names to retrieve or create. */
411
+ /**
412
+ * Ribbon names to retrieve or create.
413
+ * @minLength 1
414
+ * @maxLength 30
415
+ * @minSize 1
416
+ * @maxSize 100
417
+ */
317
418
  ribbonNames: string[];
318
419
  /**
319
420
  * Fields to include in the response.
320
421
  *
321
422
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
423
+ * @maxSize 100
322
424
  */
323
425
  fields?: RequestedFields[];
324
426
  }
325
427
  export interface BulkGetOrCreateRibbonsResponse {
326
- /** Ribbons retrieved or created by bulk action. */
428
+ /**
429
+ * Ribbons retrieved or created by bulk action.
430
+ * @maxSize 100
431
+ */
327
432
  results?: V3BulkRibbonResult[];
328
433
  /** Bulk action metadata. */
329
434
  bulkActionMetadata?: BulkActionMetadata;
330
435
  }
331
436
  export interface BulkDeleteRibbonsRequest {
332
- /** IDs of ribbons to delete. */
437
+ /**
438
+ * IDs of ribbons to delete.
439
+ * @format GUID
440
+ * @minSize 1
441
+ * @maxSize 100
442
+ */
333
443
  ribbonIds: string[];
334
444
  }
335
445
  export interface BulkDeleteRibbonsResponse {
336
- /** Ribbons deleted by bulk action. */
446
+ /**
447
+ * Ribbons deleted by bulk action.
448
+ * @maxSize 100
449
+ */
337
450
  results?: BulkRibbonResult[];
338
451
  /** Bulk action metadata. */
339
452
  bulkActionMetadata?: BulkActionMetadata;
@@ -415,9 +528,15 @@ export interface ActionEvent {
415
528
  export interface Empty {
416
529
  }
417
530
  export interface MessageEnvelope {
418
- /** App instance ID. */
531
+ /**
532
+ * App instance ID.
533
+ * @format GUID
534
+ */
419
535
  instanceId?: string | null;
420
- /** Event type. */
536
+ /**
537
+ * Event type.
538
+ * @maxLength 150
539
+ */
421
540
  eventType?: string;
422
541
  /** The identification type and identity data. */
423
542
  identity?: IdentificationData;
@@ -425,26 +544,50 @@ export interface MessageEnvelope {
425
544
  data?: string;
426
545
  }
427
546
  export interface IdentificationData extends IdentificationDataIdOneOf {
428
- /** ID of a site visitor that has not logged in to the site. */
547
+ /**
548
+ * ID of a site visitor that has not logged in to the site.
549
+ * @format GUID
550
+ */
429
551
  anonymousVisitorId?: string;
430
- /** ID of a site visitor that has logged in to the site. */
552
+ /**
553
+ * ID of a site visitor that has logged in to the site.
554
+ * @format GUID
555
+ */
431
556
  memberId?: string;
432
- /** ID of a Wix user (site owner, contributor, etc.). */
557
+ /**
558
+ * ID of a Wix user (site owner, contributor, etc.).
559
+ * @format GUID
560
+ */
433
561
  wixUserId?: string;
434
- /** ID of an app. */
562
+ /**
563
+ * ID of an app.
564
+ * @format GUID
565
+ */
435
566
  appId?: string;
436
567
  /** @readonly */
437
568
  identityType?: WebhookIdentityType;
438
569
  }
439
570
  /** @oneof */
440
571
  export interface IdentificationDataIdOneOf {
441
- /** ID of a site visitor that has not logged in to the site. */
572
+ /**
573
+ * ID of a site visitor that has not logged in to the site.
574
+ * @format GUID
575
+ */
442
576
  anonymousVisitorId?: string;
443
- /** ID of a site visitor that has logged in to the site. */
577
+ /**
578
+ * ID of a site visitor that has logged in to the site.
579
+ * @format GUID
580
+ */
444
581
  memberId?: string;
445
- /** ID of a Wix user (site owner, contributor, etc.). */
582
+ /**
583
+ * ID of a Wix user (site owner, contributor, etc.).
584
+ * @format GUID
585
+ */
446
586
  wixUserId?: string;
447
- /** ID of an app. */
587
+ /**
588
+ * ID of an app.
589
+ * @format GUID
590
+ */
448
591
  appId?: string;
449
592
  }
450
593
  export declare enum WebhookIdentityType {
@@ -510,9 +653,15 @@ export interface BulkDeleteRibbonsResponseNonNullableFields {
510
653
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
511
654
  }
512
655
  export interface BaseEventMetadata {
513
- /** App instance ID. */
656
+ /**
657
+ * App instance ID.
658
+ * @format GUID
659
+ */
514
660
  instanceId?: string | null;
515
- /** Event type. */
661
+ /**
662
+ * Event type.
663
+ * @maxLength 150
664
+ */
516
665
  eventType?: string;
517
666
  /** The identification type and identity data. */
518
667
  identity?: IdentificationData;
@@ -559,14 +708,20 @@ export interface RibbonCreatedEnvelope {
559
708
  entity: Ribbon;
560
709
  metadata: EventMetadata;
561
710
  }
562
- /** @permissionScope Read ribbons in v3 catalog
711
+ /** @permissionScope Manage Stores - all permissions
712
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
713
+ * @permissionScope Read ribbons in v3 catalog
563
714
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
564
715
  * @permissionScope Read v3 catalog
565
716
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
566
717
  * @permissionScope Manage Products
567
718
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
719
+ * @permissionScope Read Stores - all read permissions
720
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
568
721
  * @permissionScope Read Products
569
722
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
723
+ * @permissionScope Manage Restaurants - all permissions
724
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
570
725
  * @permissionScope Product write in v3 catalog
571
726
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
572
727
  * @permissionScope Manage v3 catalog
@@ -584,14 +739,20 @@ export interface RibbonDeletedEnvelope {
584
739
  entity: Ribbon;
585
740
  metadata: EventMetadata;
586
741
  }
587
- /** @permissionScope Read ribbons in v3 catalog
742
+ /** @permissionScope Manage Stores - all permissions
743
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
744
+ * @permissionScope Read ribbons in v3 catalog
588
745
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
589
746
  * @permissionScope Read v3 catalog
590
747
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
591
748
  * @permissionScope Manage Products
592
749
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
750
+ * @permissionScope Read Stores - all read permissions
751
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
593
752
  * @permissionScope Read Products
594
753
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
754
+ * @permissionScope Manage Restaurants - all permissions
755
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
595
756
  * @permissionScope Product write in v3 catalog
596
757
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
597
758
  * @permissionScope Manage v3 catalog
@@ -609,14 +770,20 @@ export interface RibbonUpdatedEnvelope {
609
770
  entity: Ribbon;
610
771
  metadata: EventMetadata;
611
772
  }
612
- /** @permissionScope Read ribbons in v3 catalog
773
+ /** @permissionScope Manage Stores - all permissions
774
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
775
+ * @permissionScope Read ribbons in v3 catalog
613
776
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
614
777
  * @permissionScope Read v3 catalog
615
778
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
616
779
  * @permissionScope Manage Products
617
780
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
781
+ * @permissionScope Read Stores - all read permissions
782
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
618
783
  * @permissionScope Read Products
619
784
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
785
+ * @permissionScope Manage Restaurants - all permissions
786
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
620
787
  * @permissionScope Product write in v3 catalog
621
788
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
622
789
  * @permissionScope Manage v3 catalog
@@ -640,6 +807,8 @@ export declare function onRibbonUpdated(handler: (event: RibbonUpdatedEnvelope)
640
807
  * @requiredField ribbon
641
808
  * @requiredField ribbon.name
642
809
  * @permissionId WIX_STORES.RIBBON_CREATE
810
+ * @permissionScope Manage Stores - all permissions
811
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
643
812
  * @permissionScope Manage Products
644
813
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
645
814
  * @permissionScope Ribbon write in v3 catalog
@@ -660,14 +829,20 @@ export declare function createRibbon(ribbon: Ribbon): Promise<Ribbon & RibbonNon
660
829
  * @documentationMaturity preview
661
830
  * @requiredField ribbonId
662
831
  * @permissionId WIX_STORES.RIBBON_READ
832
+ * @permissionScope Manage Stores - all permissions
833
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
663
834
  * @permissionScope Read ribbons in v3 catalog
664
835
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
665
836
  * @permissionScope Read v3 catalog
666
837
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
667
838
  * @permissionScope Manage Products
668
839
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
840
+ * @permissionScope Read Stores - all read permissions
841
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
669
842
  * @permissionScope Read Products
670
843
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
844
+ * @permissionScope Manage Restaurants - all permissions
845
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
671
846
  * @permissionScope Product write in v3 catalog
672
847
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
673
848
  * @permissionScope Manage v3 catalog
@@ -684,6 +859,7 @@ export interface GetRibbonOptions {
684
859
  * Fields to include in the response.
685
860
  *
686
861
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
862
+ * @maxSize 100
687
863
  */
688
864
  fields?: RequestedFields[];
689
865
  }
@@ -701,6 +877,8 @@ export interface GetRibbonOptions {
701
877
  * @requiredField ribbon
702
878
  * @requiredField ribbon.revision
703
879
  * @permissionId WIX_STORES.RIBBON_UPDATE
880
+ * @permissionScope Manage Stores - all permissions
881
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
704
882
  * @permissionScope Manage Products
705
883
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
706
884
  * @permissionScope Ribbon write in v3 catalog
@@ -717,6 +895,7 @@ export declare function updateRibbon(_id: string | null, ribbon: UpdateRibbon, o
717
895
  export interface UpdateRibbon {
718
896
  /**
719
897
  * Ribbon ID.
898
+ * @format GUID
720
899
  * @readonly
721
900
  */
722
901
  _id?: string | null;
@@ -739,7 +918,11 @@ export interface UpdateRibbon {
739
918
  * @readonly
740
919
  */
741
920
  _updatedDate?: Date | null;
742
- /** Ribbon name. */
921
+ /**
922
+ * Ribbon name.
923
+ * @minLength 1
924
+ * @maxLength 30
925
+ */
743
926
  name?: string;
744
927
  /**
745
928
  * Number of products this ribbon is assigned to.
@@ -753,6 +936,7 @@ export interface UpdateRibbonOptions {
753
936
  * Fields to include in the response.
754
937
  *
755
938
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
939
+ * @maxSize 100
756
940
  */
757
941
  fields?: RequestedFields[];
758
942
  }
@@ -766,6 +950,8 @@ export interface UpdateRibbonOptions {
766
950
  * @documentationMaturity preview
767
951
  * @requiredField ribbonId
768
952
  * @permissionId WIX_STORES.RIBBON_DELETE
953
+ * @permissionScope Manage Stores - all permissions
954
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
769
955
  * @permissionScope Manage Products
770
956
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
771
957
  * @permissionScope Ribbon write in v3 catalog
@@ -796,14 +982,20 @@ export declare function deleteRibbon(ribbonId: string): Promise<void>;
796
982
  * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
797
983
  * @public
798
984
  * @documentationMaturity preview
985
+ * @permissionScope Manage Stores - all permissions
986
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
799
987
  * @permissionScope Read ribbons in v3 catalog
800
988
  * @permissionScopeId SCOPE.STORES.RIBBON_READ
801
989
  * @permissionScope Read v3 catalog
802
990
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
803
991
  * @permissionScope Manage Products
804
992
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
993
+ * @permissionScope Read Stores - all read permissions
994
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
805
995
  * @permissionScope Read Products
806
996
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
997
+ * @permissionScope Manage Restaurants - all permissions
998
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
807
999
  * @permissionScope Product write in v3 catalog
808
1000
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
809
1001
  * @permissionScope Manage v3 catalog
@@ -820,6 +1012,7 @@ export interface QueryRibbonsOptions {
820
1012
  * Fields to include in the response.
821
1013
  *
822
1014
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1015
+ * @maxSize 100
823
1016
  */
824
1017
  fields?: RequestedFields[] | undefined;
825
1018
  }
@@ -908,6 +1101,8 @@ export interface RibbonsQueryBuilder {
908
1101
  * @requiredField ribbons
909
1102
  * @requiredField ribbons.name
910
1103
  * @permissionId WIX_STORES.RIBBON_CREATE
1104
+ * @permissionScope Manage Stores - all permissions
1105
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
911
1106
  * @permissionScope Manage Products
912
1107
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
913
1108
  * @permissionScope Ribbon write in v3 catalog
@@ -941,6 +1136,8 @@ export interface BulkCreateRibbonsOptions {
941
1136
  * @requiredField ribbons.ribbon._id
942
1137
  * @requiredField ribbons.ribbon.revision
943
1138
  * @permissionId WIX_STORES.RIBBON_UPDATE
1139
+ * @permissionScope Manage Stores - all permissions
1140
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
944
1141
  * @permissionScope Manage Products
945
1142
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
946
1143
  * @permissionScope Ribbon write in v3 catalog
@@ -964,6 +1161,7 @@ export interface BulkUpdateRibbonsOptions {
964
1161
  * Fields to include in the response.
965
1162
  *
966
1163
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1164
+ * @maxSize 100
967
1165
  */
968
1166
  fields?: RequestedFields[];
969
1167
  }
@@ -974,6 +1172,8 @@ export interface BulkUpdateRibbonsOptions {
974
1172
  * @documentationMaturity preview
975
1173
  * @requiredField ribbonName
976
1174
  * @permissionId WIX_STORES.RIBBON_GET_OR_CREATE
1175
+ * @permissionScope Manage Stores - all permissions
1176
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
977
1177
  * @permissionScope Manage Products
978
1178
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
979
1179
  * @permissionScope Ribbon write in v3 catalog
@@ -991,6 +1191,7 @@ export interface GetOrCreateRibbonOptions {
991
1191
  * Fields to include in the response.
992
1192
  *
993
1193
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1194
+ * @maxSize 100
994
1195
  */
995
1196
  fields?: RequestedFields[];
996
1197
  }
@@ -1001,6 +1202,8 @@ export interface GetOrCreateRibbonOptions {
1001
1202
  * @documentationMaturity preview
1002
1203
  * @requiredField ribbonNames
1003
1204
  * @permissionId WIX_STORES.RIBBON_GET_OR_CREATE
1205
+ * @permissionScope Manage Stores - all permissions
1206
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1004
1207
  * @permissionScope Manage Products
1005
1208
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1006
1209
  * @permissionScope Ribbon write in v3 catalog
@@ -1018,6 +1221,7 @@ export interface BulkGetOrCreateRibbonsOptions {
1018
1221
  * Fields to include in the response.
1019
1222
  *
1020
1223
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1224
+ * @maxSize 100
1021
1225
  */
1022
1226
  fields?: RequestedFields[];
1023
1227
  }
@@ -1028,6 +1232,8 @@ export interface BulkGetOrCreateRibbonsOptions {
1028
1232
  * @documentationMaturity preview
1029
1233
  * @requiredField ribbonIds
1030
1234
  * @permissionId WIX_STORES.RIBBON_DELETE
1235
+ * @permissionScope Manage Stores - all permissions
1236
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1031
1237
  * @permissionScope Manage Products
1032
1238
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1033
1239
  * @permissionScope Ribbon write in v3 catalog