@wix/auto_sdk_stores_customizations-v-3 1.0.2 → 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-customization-customizations-v-3.types.d.ts +274 -56
  2. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
  3. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
  4. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
  5. package/build/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
  6. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
  7. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
  8. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
  9. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
  10. package/build/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
  11. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
  12. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
  13. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
  14. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
  15. package/build/internal/cjs/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
  16. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.d.ts +274 -56
  17. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.types.js.map +1 -1
  18. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.d.ts +339 -60
  19. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js +30 -0
  20. package/build/internal/es/src/stores-catalog-v3-customization-customizations-v-3.universal.js.map +1 -1
  21. package/package.json +2 -2
@@ -7,6 +7,7 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
7
7
  * Free text input settings.
8
8
  *
9
9
  * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
10
+ * @immutable
10
11
  */
11
12
  freeTextInput?: FreeTextSettings;
12
13
  /**
@@ -17,6 +18,8 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
17
18
  choicesSettings?: ChoicesSettings;
18
19
  /**
19
20
  * Customization ID.
21
+ * @minLength 1
22
+ * @maxLength 36
20
23
  * @readonly
21
24
  */
22
25
  _id?: string | null;
@@ -39,14 +42,22 @@ export interface Customization extends CustomizationCustomizationSettingsOneOf {
39
42
  * @readonly
40
43
  */
41
44
  _updatedDate?: Date | null;
42
- /** Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`). */
45
+ /**
46
+ * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
47
+ * @minLength 1
48
+ * @maxLength 50
49
+ */
43
50
  name?: string;
44
- /** Customization type. */
51
+ /**
52
+ * Customization type.
53
+ * @immutable
54
+ */
45
55
  customizationType?: CustomizationType;
46
56
  /**
47
57
  * Customization render type.
48
58
  *
49
59
  * Defines how the customization will be displayed in the storefront.
60
+ * @immutable
50
61
  */
51
62
  customizationRenderType?: CustomizationRenderType;
52
63
  /**
@@ -62,6 +73,7 @@ export interface CustomizationCustomizationSettingsOneOf {
62
73
  * Free text input settings.
63
74
  *
64
75
  * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
76
+ * @immutable
65
77
  */
66
78
  freeTextInput?: FreeTextSettings;
67
79
  /**
@@ -85,22 +97,43 @@ export declare enum CustomizationRenderType {
85
97
  export interface FreeTextSettings {
86
98
  /** Minimum text character length. */
87
99
  minCharCount?: number;
88
- /** Maximum text character length. */
100
+ /**
101
+ * Maximum text character length.
102
+ * @max 500
103
+ */
89
104
  maxCharCount?: number;
90
- /** Default amount added to a product's price when this choice is assigned to a modifier. */
105
+ /**
106
+ * Default amount added to a product's price when this choice is assigned to a modifier.
107
+ * @decimalValue options - {gte:0,lte:999999999,maxScale:3}
108
+ */
91
109
  defaultAddedPrice?: string | null;
92
- /** Title to display to customer for their free-text input. */
110
+ /**
111
+ * Title to display to customer for their free-text input.
112
+ * @minLength 1
113
+ * @maxLength 100
114
+ */
93
115
  title?: string;
94
116
  }
95
117
  export interface ChoicesSettings {
96
- /** List of choices. */
118
+ /**
119
+ * List of choices.
120
+ * @minSize 1
121
+ * @maxSize 200
122
+ * @immutable
123
+ */
97
124
  choices?: Choice[];
98
125
  }
99
126
  export interface Choice extends ChoiceValueOneOf {
100
- /** Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color). */
127
+ /**
128
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
129
+ * @minLength 3
130
+ * @maxLength 20
131
+ * @format COLOR_HEX
132
+ */
101
133
  colorCode?: string;
102
134
  /**
103
135
  * Choice ID.
136
+ * @format GUID
104
137
  * @readonly
105
138
  */
106
139
  _id?: string;
@@ -110,16 +143,26 @@ export interface Choice extends ChoiceValueOneOf {
110
143
  * > **Notes:**
111
144
  * > + For `customizationRenderType: SWATCH_CHOICES`, the supported `choiceType` values are: `ONE_COLOR`, `MULTIPLE_COLORS`, or `IMAGE`.
112
145
  * > + For a `customizationRenderType` of `TEXT_CHOICES` and `FREE_TEXT`, the supported `choiceType` value is: `CHOICE_TEXT`.
146
+ * @immutable
113
147
  */
114
148
  choiceType?: ChoiceType;
115
149
  /**
116
150
  * A read-only key generated based on choice name. Used for eCommerce integration.
117
151
  * @readonly
152
+ * @minLength 1
153
+ * @maxLength 50
118
154
  */
119
155
  key?: string | null;
120
- /** Choice name. */
156
+ /**
157
+ * Choice name.
158
+ * @minLength 1
159
+ * @maxLength 50
160
+ */
121
161
  name?: string;
122
- /** Default amount added to a product's price when this customization is assigned to a modifier. */
162
+ /**
163
+ * Default amount added to a product's price when this customization is assigned to a modifier.
164
+ * @decimalValue options - {gte:0,lte:999999999,maxScale:3}
165
+ */
123
166
  defaultAddedPrice?: string | null;
124
167
  /**
125
168
  * Number of products this choice is assigned to .
@@ -129,7 +172,12 @@ export interface Choice extends ChoiceValueOneOf {
129
172
  }
130
173
  /** @oneof */
131
174
  export interface ChoiceValueOneOf {
132
- /** Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color). */
175
+ /**
176
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
177
+ * @minLength 3
178
+ * @maxLength 20
179
+ * @format COLOR_HEX
180
+ */
133
181
  colorCode?: string;
134
182
  }
135
183
  export declare enum ChoiceType {
@@ -144,7 +192,13 @@ export declare enum ChoiceType {
144
192
  IMAGE = "IMAGE"
145
193
  }
146
194
  export interface MultipleColors {
147
- /** A list of color codes. */
195
+ /**
196
+ * A list of color codes.
197
+ * @minLength 3
198
+ * @maxLength 20
199
+ * @minSize 2
200
+ * @maxSize 2
201
+ */
148
202
  colorCodes?: string[];
149
203
  }
150
204
  export interface FocalPoint {
@@ -158,9 +212,15 @@ export interface FocalPoint {
158
212
  width?: number | null;
159
213
  }
160
214
  export interface InvalidateCache extends InvalidateCacheGetByOneOf {
161
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
215
+ /**
216
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
217
+ * @format GUID
218
+ */
162
219
  metaSiteId?: string;
163
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
220
+ /**
221
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
222
+ * @format GUID
223
+ */
164
224
  siteId?: string;
165
225
  /** Invalidate by App */
166
226
  app?: App;
@@ -170,7 +230,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
170
230
  uri?: URI;
171
231
  /** Invalidate by file (for media files such as PDFs) */
172
232
  file?: File;
173
- /** tell us why you're invalidating the cache. You don't need to add your app name */
233
+ /**
234
+ * tell us why you're invalidating the cache. You don't need to add your app name
235
+ * @maxLength 256
236
+ */
174
237
  reason?: string | null;
175
238
  /** Is local DS */
176
239
  localDc?: boolean;
@@ -178,9 +241,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
178
241
  }
179
242
  /** @oneof */
180
243
  export interface InvalidateCacheGetByOneOf {
181
- /** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
244
+ /**
245
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
246
+ * @format GUID
247
+ */
182
248
  metaSiteId?: string;
183
- /** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
249
+ /**
250
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
251
+ * @format GUID
252
+ */
184
253
  siteId?: string;
185
254
  /** Invalidate by App */
186
255
  app?: App;
@@ -192,27 +261,52 @@ export interface InvalidateCacheGetByOneOf {
192
261
  file?: File;
193
262
  }
194
263
  export interface App {
195
- /** The AppDefId */
264
+ /**
265
+ * The AppDefId
266
+ * @minLength 1
267
+ */
196
268
  appDefId?: string;
197
- /** The instance Id */
269
+ /**
270
+ * The instance Id
271
+ * @format GUID
272
+ */
198
273
  instanceId?: string;
199
274
  }
200
275
  export interface Page {
201
- /** the msid the page is on */
276
+ /**
277
+ * the msid the page is on
278
+ * @format GUID
279
+ */
202
280
  metaSiteId?: string;
203
- /** Invalidate by Page ID */
281
+ /**
282
+ * Invalidate by Page ID
283
+ * @minLength 1
284
+ */
204
285
  pageId?: string;
205
286
  }
206
287
  export interface URI {
207
- /** the msid the URI is on */
288
+ /**
289
+ * the msid the URI is on
290
+ * @format GUID
291
+ */
208
292
  metaSiteId?: string;
209
- /** URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes */
293
+ /**
294
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
295
+ * @minLength 1
296
+ */
210
297
  uriPath?: string;
211
298
  }
212
299
  export interface File {
213
- /** the msid the file is related to */
300
+ /**
301
+ * the msid the file is related to
302
+ * @format GUID
303
+ */
214
304
  metaSiteId?: string;
215
- /** Invalidate by filename (for media files such as PDFs) */
305
+ /**
306
+ * Invalidate by filename (for media files such as PDFs)
307
+ * @minLength 1
308
+ * @maxLength 256
309
+ */
216
310
  fileName?: string;
217
311
  }
218
312
  export interface CreateCustomizationRequest {
@@ -224,12 +318,16 @@ export interface CreateCustomizationResponse {
224
318
  customization?: Customization;
225
319
  }
226
320
  export interface GetCustomizationRequest {
227
- /** Customization ID. */
321
+ /**
322
+ * Customization ID.
323
+ * @format GUID
324
+ */
228
325
  customizationId: string;
229
326
  /**
230
327
  * Fields to include in the response.
231
328
  *
232
329
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
330
+ * @maxSize 100
233
331
  */
234
332
  fields?: RequestedFields[];
235
333
  }
@@ -250,6 +348,7 @@ export interface UpdateCustomizationRequest {
250
348
  * Fields to include in the response.
251
349
  *
252
350
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
351
+ * @maxSize 100
253
352
  */
254
353
  fields?: RequestedFields[];
255
354
  }
@@ -258,7 +357,10 @@ export interface UpdateCustomizationResponse {
258
357
  customization?: Customization;
259
358
  }
260
359
  export interface DeleteCustomizationRequest {
261
- /** Customization ID. */
360
+ /**
361
+ * Customization ID.
362
+ * @format GUID
363
+ */
262
364
  customizationId: string;
263
365
  }
264
366
  export interface DeleteCustomizationResponse {
@@ -270,6 +372,7 @@ export interface QueryCustomizationsRequest {
270
372
  * Fields to include in the response.
271
373
  *
272
374
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
375
+ * @maxSize 100
273
376
  */
274
377
  fields?: RequestedFields[];
275
378
  }
@@ -288,6 +391,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
288
391
  /**
289
392
  * Sort object in the following format:
290
393
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
394
+ * @maxSize 5
291
395
  */
292
396
  sort?: Sorting[];
293
397
  }
@@ -297,7 +401,10 @@ export interface CursorQueryPagingMethodOneOf {
297
401
  cursorPaging?: CursorPaging;
298
402
  }
299
403
  export interface Sorting {
300
- /** Name of the field to sort by. */
404
+ /**
405
+ * Name of the field to sort by.
406
+ * @maxLength 512
407
+ */
301
408
  fieldName?: string;
302
409
  /** Sort order. */
303
410
  order?: SortOrder;
@@ -309,18 +416,26 @@ export declare enum SortOrder {
309
416
  DESC = "DESC"
310
417
  }
311
418
  export interface CursorPaging {
312
- /** Maximum number of items to return in the results. */
419
+ /**
420
+ * Maximum number of items to return in the results.
421
+ * @max 100
422
+ */
313
423
  limit?: number | null;
314
424
  /**
315
425
  * Pointer to the next or previous page in the list of results.
316
426
  *
317
427
  * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
318
428
  * Not relevant for the first request.
429
+ * @maxLength 16000
319
430
  */
320
431
  cursor?: string | null;
321
432
  }
322
433
  export interface QueryCustomizationsResponse {
323
- /** List of customizations. */
434
+ /**
435
+ * List of customizations.
436
+ * @minSize 1
437
+ * @maxSize 200
438
+ */
324
439
  customizations?: Customization[];
325
440
  /** Details on the paged set of results returned. */
326
441
  pagingMetadata?: CursorPagingMetadata;
@@ -339,13 +454,23 @@ export interface CursorPagingMetadata {
339
454
  hasNext?: boolean | null;
340
455
  }
341
456
  export interface Cursors {
342
- /** Cursor string pointing to the next page in the list of results. */
457
+ /**
458
+ * Cursor string pointing to the next page in the list of results.
459
+ * @maxLength 16000
460
+ */
343
461
  next?: string | null;
344
- /** Cursor pointing to the previous page in the list of results. */
462
+ /**
463
+ * Cursor pointing to the previous page in the list of results.
464
+ * @maxLength 16000
465
+ */
345
466
  prev?: string | null;
346
467
  }
347
468
  export interface BulkCreateCustomizationsRequest {
348
- /** Customizations to create. */
469
+ /**
470
+ * Customizations to create.
471
+ * @minSize 1
472
+ * @maxSize 100
473
+ */
349
474
  customizations: Customization[];
350
475
  /**
351
476
  * Whether to return the full customization entities in the response.
@@ -355,7 +480,11 @@ export interface BulkCreateCustomizationsRequest {
355
480
  returnEntity?: boolean;
356
481
  }
357
482
  export interface BulkCreateCustomizationsResponse {
358
- /** Customizations created by bulk action. */
483
+ /**
484
+ * Customizations created by bulk action.
485
+ * @minSize 1
486
+ * @maxSize 100
487
+ */
359
488
  results?: BulkCustomizationResult[];
360
489
  /** Bulk action metadata. */
361
490
  bulkActionMetadata?: BulkActionMetadata;
@@ -371,7 +500,11 @@ export interface BulkCustomizationResult {
371
500
  customization?: Customization;
372
501
  }
373
502
  export interface ItemMetadata {
374
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
503
+ /**
504
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
505
+ * @minLength 1
506
+ * @maxLength 36
507
+ */
375
508
  _id?: string | null;
376
509
  /** Index of the item within the request array. Allows for correlation between request and response items. */
377
510
  originalIndex?: number;
@@ -400,18 +533,30 @@ export interface CustomizationIdsWrapper {
400
533
  /**
401
534
  * list of all the customization ids that are invalid
402
535
  * e.g list of failed choices ids
536
+ * @minSize 1
537
+ * @maxSize 100
538
+ * @minLength 1
539
+ * @maxLength 36
403
540
  */
404
541
  customizationIds?: string[];
405
542
  }
406
543
  export interface AddCustomizationChoicesRequest {
407
- /** Customization ID. */
544
+ /**
545
+ * Customization ID.
546
+ * @format GUID
547
+ */
408
548
  customizationId: string;
409
- /** Choices to add. */
549
+ /**
550
+ * Choices to add.
551
+ * @minSize 1
552
+ * @maxSize 100
553
+ */
410
554
  choices: Choice[];
411
555
  /**
412
556
  * Fields to include in the response.
413
557
  *
414
558
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
559
+ * @maxSize 100
415
560
  */
416
561
  fields?: RequestedFields[];
417
562
  }
@@ -420,14 +565,22 @@ export interface AddCustomizationChoicesResponse {
420
565
  customization?: Customization;
421
566
  }
422
567
  export interface SetCustomizationChoicesRequest {
423
- /** Customization ID. */
568
+ /**
569
+ * Customization ID.
570
+ * @format GUID
571
+ */
424
572
  customizationId: string;
425
- /** Choices to set. */
573
+ /**
574
+ * Choices to set.
575
+ * @minSize 1
576
+ * @maxSize 100
577
+ */
426
578
  choices: Choice[];
427
579
  /**
428
580
  * Fields to include in the response.
429
581
  *
430
582
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
583
+ * @maxSize 100
431
584
  */
432
585
  fields?: RequestedFields[];
433
586
  }
@@ -436,9 +589,17 @@ export interface SetCustomizationChoicesResponse {
436
589
  customization?: Customization;
437
590
  }
438
591
  export interface RemoveCustomizationChoicesRequest {
439
- /** Customization ID. */
592
+ /**
593
+ * Customization ID.
594
+ * @format GUID
595
+ */
440
596
  customizationId: string;
441
- /** IDs of choices to remove. */
597
+ /**
598
+ * IDs of choices to remove.
599
+ * @format GUID
600
+ * @minSize 1
601
+ * @maxSize 100
602
+ */
442
603
  choiceIds: string[];
443
604
  /** Customization revision. */
444
605
  revision?: string;
@@ -446,6 +607,7 @@ export interface RemoveCustomizationChoicesRequest {
446
607
  * Fields to include in the response.
447
608
  *
448
609
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
610
+ * @maxSize 100
449
611
  */
450
612
  fields?: RequestedFields[];
451
613
  }
@@ -454,7 +616,11 @@ export interface RemoveCustomizationChoicesResponse {
454
616
  customization?: Customization;
455
617
  }
456
618
  export interface BulkAddCustomizationChoicesRequest {
457
- /** List of customization IDs and choices. */
619
+ /**
620
+ * List of customization IDs and choices.
621
+ * @minSize 1
622
+ * @maxSize 100
623
+ */
458
624
  customizationsChoices: CustomizationChoices[];
459
625
  /**
460
626
  * Whether to return the full customization entities in the response.
@@ -466,23 +632,40 @@ export interface BulkAddCustomizationChoicesRequest {
466
632
  * Fields to include in the response.
467
633
  *
468
634
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
635
+ * @maxSize 100
469
636
  */
470
637
  fields?: RequestedFields[];
471
638
  }
472
639
  export interface CustomizationChoices {
473
- /** Customization ID. */
640
+ /**
641
+ * Customization ID.
642
+ * @minLength 1
643
+ * @maxLength 36
644
+ */
474
645
  customizationId?: string;
475
- /** Choices to add. */
646
+ /**
647
+ * Choices to add.
648
+ * @minSize 1
649
+ * @maxSize 100
650
+ */
476
651
  choices?: Choice[];
477
652
  }
478
653
  export interface BulkAddCustomizationChoicesResponse {
479
- /** Customizations updated by bulk action. */
654
+ /**
655
+ * Customizations updated by bulk action.
656
+ * @minSize 1
657
+ * @maxSize 100
658
+ */
480
659
  results?: BulkCustomizationResult[];
481
660
  /** Bulk action metadata. */
482
661
  bulkActionMetadata?: BulkActionMetadata;
483
662
  }
484
663
  export interface BulkUpdateCustomizationsRequest {
485
- /** List of customizations to update. */
664
+ /**
665
+ * List of customizations to update.
666
+ * @minSize 1
667
+ * @maxSize 100
668
+ */
486
669
  customizations: MaskedCustomization[];
487
670
  /**
488
671
  * Whether to return the full customization entities in the response.
@@ -494,6 +677,7 @@ export interface BulkUpdateCustomizationsRequest {
494
677
  * Fields to include in the response.
495
678
  *
496
679
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
680
+ * @maxSize 100
497
681
  */
498
682
  fields?: RequestedFields[];
499
683
  }
@@ -502,7 +686,11 @@ export interface MaskedCustomization {
502
686
  customization?: Customization;
503
687
  }
504
688
  export interface BulkUpdateCustomizationsResponse {
505
- /** Customizations updated by bulk action. */
689
+ /**
690
+ * Customizations updated by bulk action.
691
+ * @minSize 1
692
+ * @maxSize 100
693
+ */
506
694
  results?: BulkCustomizationResult[];
507
695
  /** Bulk action metadata. */
508
696
  bulkActionMetadata?: BulkActionMetadata;
@@ -580,9 +768,15 @@ export interface ActionEvent {
580
768
  export interface Empty {
581
769
  }
582
770
  export interface MessageEnvelope {
583
- /** App instance ID. */
771
+ /**
772
+ * App instance ID.
773
+ * @format GUID
774
+ */
584
775
  instanceId?: string | null;
585
- /** Event type. */
776
+ /**
777
+ * Event type.
778
+ * @maxLength 150
779
+ */
586
780
  eventType?: string;
587
781
  /** The identification type and identity data. */
588
782
  identity?: IdentificationData;
@@ -590,26 +784,50 @@ export interface MessageEnvelope {
590
784
  data?: string;
591
785
  }
592
786
  export interface IdentificationData extends IdentificationDataIdOneOf {
593
- /** ID of a site visitor that has not logged in to the site. */
787
+ /**
788
+ * ID of a site visitor that has not logged in to the site.
789
+ * @format GUID
790
+ */
594
791
  anonymousVisitorId?: string;
595
- /** ID of a site visitor that has logged in to the site. */
792
+ /**
793
+ * ID of a site visitor that has logged in to the site.
794
+ * @format GUID
795
+ */
596
796
  memberId?: string;
597
- /** ID of a Wix user (site owner, contributor, etc.). */
797
+ /**
798
+ * ID of a Wix user (site owner, contributor, etc.).
799
+ * @format GUID
800
+ */
598
801
  wixUserId?: string;
599
- /** ID of an app. */
802
+ /**
803
+ * ID of an app.
804
+ * @format GUID
805
+ */
600
806
  appId?: string;
601
807
  /** @readonly */
602
808
  identityType?: WebhookIdentityType;
603
809
  }
604
810
  /** @oneof */
605
811
  export interface IdentificationDataIdOneOf {
606
- /** ID of a site visitor that has not logged in to the site. */
812
+ /**
813
+ * ID of a site visitor that has not logged in to the site.
814
+ * @format GUID
815
+ */
607
816
  anonymousVisitorId?: string;
608
- /** ID of a site visitor that has logged in to the site. */
817
+ /**
818
+ * ID of a site visitor that has logged in to the site.
819
+ * @format GUID
820
+ */
609
821
  memberId?: string;
610
- /** ID of a Wix user (site owner, contributor, etc.). */
822
+ /**
823
+ * ID of a Wix user (site owner, contributor, etc.).
824
+ * @format GUID
825
+ */
611
826
  wixUserId?: string;
612
- /** ID of an app. */
827
+ /**
828
+ * ID of an app.
829
+ * @format GUID
830
+ */
613
831
  appId?: string;
614
832
  }
615
833
  export declare enum WebhookIdentityType {
@@ -698,9 +916,15 @@ export interface BulkUpdateCustomizationsResponseNonNullableFields {
698
916
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
699
917
  }
700
918
  export interface BaseEventMetadata {
701
- /** App instance ID. */
919
+ /**
920
+ * App instance ID.
921
+ * @format GUID
922
+ */
702
923
  instanceId?: string | null;
703
- /** Event type. */
924
+ /**
925
+ * Event type.
926
+ * @maxLength 150
927
+ */
704
928
  eventType?: string;
705
929
  /** The identification type and identity data. */
706
930
  identity?: IdentificationData;
@@ -749,12 +973,18 @@ export interface CustomizationCreatedEnvelope {
749
973
  }
750
974
  /**
751
975
  * Triggered when a customization is created.
976
+ * @permissionScope Manage Stores - all permissions
977
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
752
978
  * @permissionScope Read v3 catalog
753
979
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
754
980
  * @permissionScope Manage Products
755
981
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
982
+ * @permissionScope Read Stores - all read permissions
983
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
756
984
  * @permissionScope Read Products
757
985
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
986
+ * @permissionScope Manage Restaurants - all permissions
987
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
758
988
  * @permissionScope Product write in v3 catalog
759
989
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
760
990
  * @permissionScope Read customizations in v3 catalog
@@ -809,6 +1039,8 @@ export declare function onCustomizationUpdated(handler: (event: CustomizationUpd
809
1039
  * @requiredField customization.freeTextInput.title
810
1040
  * @requiredField customization.name
811
1041
  * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
1042
+ * @permissionScope Manage Stores - all permissions
1043
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
812
1044
  * @permissionScope Customization write in v3 catalog
813
1045
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
814
1046
  * @permissionScope Manage Products
@@ -829,12 +1061,18 @@ export declare function createCustomization(customization: Customization): Promi
829
1061
  * @documentationMaturity preview
830
1062
  * @requiredField customizationId
831
1063
  * @permissionId WIX_STORES.CUSTOMIZATION_READ
1064
+ * @permissionScope Manage Stores - all permissions
1065
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
832
1066
  * @permissionScope Read v3 catalog
833
1067
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
834
1068
  * @permissionScope Manage Products
835
1069
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1070
+ * @permissionScope Read Stores - all read permissions
1071
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
836
1072
  * @permissionScope Read Products
837
1073
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
1074
+ * @permissionScope Manage Restaurants - all permissions
1075
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
838
1076
  * @permissionScope Product write in v3 catalog
839
1077
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
840
1078
  * @permissionScope Read customizations in v3 catalog
@@ -854,6 +1092,7 @@ export interface GetCustomizationOptions {
854
1092
  * Fields to include in the response.
855
1093
  *
856
1094
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1095
+ * @maxSize 100
857
1096
  */
858
1097
  fields?: RequestedFields[];
859
1098
  }
@@ -870,6 +1109,8 @@ export interface GetCustomizationOptions {
870
1109
  * @requiredField customization
871
1110
  * @requiredField customization.revision
872
1111
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1112
+ * @permissionScope Manage Stores - all permissions
1113
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
873
1114
  * @permissionScope Customization write in v3 catalog
874
1115
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
875
1116
  * @permissionScope Manage Products
@@ -888,6 +1129,7 @@ export interface UpdateCustomization {
888
1129
  * Free text input settings.
889
1130
  *
890
1131
  * > **Note:** To be passed along with `customizationRenderType: FREE_TEXT`.
1132
+ * @immutable
891
1133
  */
892
1134
  freeTextInput?: FreeTextSettings;
893
1135
  /**
@@ -898,6 +1140,8 @@ export interface UpdateCustomization {
898
1140
  choicesSettings?: ChoicesSettings;
899
1141
  /**
900
1142
  * Customization ID.
1143
+ * @minLength 1
1144
+ * @maxLength 36
901
1145
  * @readonly
902
1146
  */
903
1147
  _id?: string | null;
@@ -920,14 +1164,22 @@ export interface UpdateCustomization {
920
1164
  * @readonly
921
1165
  */
922
1166
  _updatedDate?: Date | null;
923
- /** Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`). */
1167
+ /**
1168
+ * Customization name for options (for example, `"color"`, `"size"`) and modifiers (for example, `"greeting card"`).
1169
+ * @minLength 1
1170
+ * @maxLength 50
1171
+ */
924
1172
  name?: string;
925
- /** Customization type. */
1173
+ /**
1174
+ * Customization type.
1175
+ * @immutable
1176
+ */
926
1177
  customizationType?: CustomizationType;
927
1178
  /**
928
1179
  * Customization render type.
929
1180
  *
930
1181
  * Defines how the customization will be displayed in the storefront.
1182
+ * @immutable
931
1183
  */
932
1184
  customizationRenderType?: CustomizationRenderType;
933
1185
  /**
@@ -942,6 +1194,7 @@ export interface UpdateCustomizationOptions {
942
1194
  * Fields to include in the response.
943
1195
  *
944
1196
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1197
+ * @maxSize 100
945
1198
  */
946
1199
  fields?: RequestedFields[];
947
1200
  }
@@ -954,6 +1207,8 @@ export interface UpdateCustomizationOptions {
954
1207
  * @documentationMaturity preview
955
1208
  * @requiredField customizationId
956
1209
  * @permissionId WIX_STORES.CUSTOMIZATION_DELETE
1210
+ * @permissionScope Manage Stores - all permissions
1211
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
957
1212
  * @permissionScope Customization write in v3 catalog
958
1213
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
959
1214
  * @permissionScope Manage Products
@@ -984,12 +1239,18 @@ export declare function deleteCustomization(customizationId: string): Promise<vo
984
1239
  * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
985
1240
  * @public
986
1241
  * @documentationMaturity preview
1242
+ * @permissionScope Manage Stores - all permissions
1243
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
987
1244
  * @permissionScope Read v3 catalog
988
1245
  * @permissionScopeId SCOPE.STORES.CATALOG_READ
989
1246
  * @permissionScope Manage Products
990
1247
  * @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
1248
+ * @permissionScope Read Stores - all read permissions
1249
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
991
1250
  * @permissionScope Read Products
992
1251
  * @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
1252
+ * @permissionScope Manage Restaurants - all permissions
1253
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
993
1254
  * @permissionScope Product write in v3 catalog
994
1255
  * @permissionScopeId SCOPE.STORES.PRODUCT_WRITE
995
1256
  * @permissionScope Read customizations in v3 catalog
@@ -1009,6 +1270,7 @@ export interface QueryCustomizationsOptions {
1009
1270
  * Fields to include in the response.
1010
1271
  *
1011
1272
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1273
+ * @maxSize 100
1012
1274
  */
1013
1275
  fields?: RequestedFields[] | undefined;
1014
1276
  }
@@ -1096,6 +1358,8 @@ export interface CustomizationsQueryBuilder {
1096
1358
  * @documentationMaturity preview
1097
1359
  * @requiredField customizations
1098
1360
  * @permissionId WIX_STORES.CUSTOMIZATION_CREATE
1361
+ * @permissionScope Manage Stores - all permissions
1362
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1099
1363
  * @permissionScope Customization write in v3 catalog
1100
1364
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1101
1365
  * @permissionScope Manage Products
@@ -1125,6 +1389,8 @@ export interface BulkCreateCustomizationsOptions {
1125
1389
  * @requiredField choices
1126
1390
  * @requiredField customizationId
1127
1391
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1392
+ * @permissionScope Manage Stores - all permissions
1393
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1128
1394
  * @permissionScope Customization write in v3 catalog
1129
1395
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1130
1396
  * @permissionScope Manage Products
@@ -1142,6 +1408,7 @@ export interface AddCustomizationChoicesOptions {
1142
1408
  * Fields to include in the response.
1143
1409
  *
1144
1410
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1411
+ * @maxSize 100
1145
1412
  */
1146
1413
  fields?: RequestedFields[];
1147
1414
  }
@@ -1156,6 +1423,8 @@ export interface AddCustomizationChoicesOptions {
1156
1423
  * @requiredField choices
1157
1424
  * @requiredField customizationId
1158
1425
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1426
+ * @permissionScope Manage Stores - all permissions
1427
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1159
1428
  * @permissionScope Customization write in v3 catalog
1160
1429
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1161
1430
  * @permissionScope Manage Products
@@ -1173,6 +1442,7 @@ export interface SetCustomizationChoicesOptions {
1173
1442
  * Fields to include in the response.
1174
1443
  *
1175
1444
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1445
+ * @maxSize 100
1176
1446
  */
1177
1447
  fields?: RequestedFields[];
1178
1448
  }
@@ -1187,6 +1457,8 @@ export interface SetCustomizationChoicesOptions {
1187
1457
  * @requiredField choiceIds
1188
1458
  * @requiredField customizationId
1189
1459
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1460
+ * @permissionScope Manage Stores - all permissions
1461
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1190
1462
  * @permissionScope Customization write in v3 catalog
1191
1463
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1192
1464
  * @permissionScope Manage Products
@@ -1206,6 +1478,7 @@ export interface RemoveCustomizationChoicesOptions {
1206
1478
  * Fields to include in the response.
1207
1479
  *
1208
1480
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1481
+ * @maxSize 100
1209
1482
  */
1210
1483
  fields?: RequestedFields[];
1211
1484
  }
@@ -1218,6 +1491,8 @@ export interface RemoveCustomizationChoicesOptions {
1218
1491
  * @requiredField customizationsChoices.choices
1219
1492
  * @requiredField customizationsChoices.customizationId
1220
1493
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1494
+ * @permissionScope Manage Stores - all permissions
1495
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1221
1496
  * @permissionScope Customization write in v3 catalog
1222
1497
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1223
1498
  * @permissionScope Manage Products
@@ -1241,6 +1516,7 @@ export interface BulkAddCustomizationChoicesOptions {
1241
1516
  * Fields to include in the response.
1242
1517
  *
1243
1518
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1519
+ * @maxSize 100
1244
1520
  */
1245
1521
  fields?: RequestedFields[];
1246
1522
  }
@@ -1258,6 +1534,8 @@ export interface BulkAddCustomizationChoicesOptions {
1258
1534
  * @requiredField customizations.customization.name
1259
1535
  * @requiredField customizations.customization.revision
1260
1536
  * @permissionId WIX_STORES.CUSTOMIZATION_UPDATE
1537
+ * @permissionScope Manage Stores - all permissions
1538
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
1261
1539
  * @permissionScope Customization write in v3 catalog
1262
1540
  * @permissionScopeId SCOPE.STORES.CUSTOMIZATION_WRITE
1263
1541
  * @permissionScope Manage Products
@@ -1281,6 +1559,7 @@ export interface BulkUpdateCustomizationsOptions {
1281
1559
  * Fields to include in the response.
1282
1560
  *
1283
1561
  * Supported values: `ASSIGNED_PRODUCTS_COUNT`
1562
+ * @maxSize 100
1284
1563
  */
1285
1564
  fields?: RequestedFields[];
1286
1565
  }